Index (error-prone annotations 2.46.0 API)

A C D E F G I K L M N O P R S T U V
All Classes and Interfaces|All Packages

A

ABSTRACT - Enum constant in enum class com.google.errorprone.annotations.Modifier
allowedOnPath() - Element in annotation interface com.google.errorprone.annotations.RestrictedApi: Allow the restricted API on paths matching this regular expression.
allowlistAnnotations() - Element in annotation interface com.google.errorprone.annotations.RestrictedApi: Allow calls to the restricted API in methods or classes with this annotation.
allowlistWithWarningAnnotations() - Element in annotation interface com.google.errorprone.annotations.RestrictedApi: Emit warnings, not errors, on calls to the restricted API for callers with this annotation.

C

CanIgnoreReturnValue - Annotation Interface in com.google.errorprone.annotations: Indicates that the return value of the annotated API is ignorable.
CheckReturnValue - Annotation Interface in com.google.errorprone.annotations: Indicates that the return value of the annotated method must be used.
com.google.errorprone.annotations - package com.google.errorprone.annotations
com.google.errorprone.annotations.concurrent - package com.google.errorprone.annotations.concurrent
CompatibleWith - Annotation Interface in com.google.errorprone.annotations: Declares that a parameter to a method must be "compatible with" one of the type parameters in the method's enclosing class, or on the method itself.
CompileTimeConstant - Annotation Interface in com.google.errorprone.annotations: Annotation for method parameter and class field declarations, which denotes that corresponding actual values must be compile-time constant expressions.
containerOf() - Element in annotation interface com.google.errorprone.annotations.Immutable: When annotating a generic type as immutable, containerOf specifies which type parameters must be instantiated with immutable types for the container to be deeply immutable.

D

@DoNotCall and deprecation - Section in annotation interface com.google.errorprone.annotations.DoNotCall
DEFAULT - Enum constant in enum class com.google.errorprone.annotations.Modifier
DoNotCall - Annotation Interface in com.google.errorprone.annotations: Indicates that the annotated method should not be called under any normal circumstances, yet is either impossible to remove, or should not ever be removed.
DoNotMock - Annotation Interface in com.google.errorprone.annotations: Annotation representing a type that should not be mocked.

E

explanation() - Element in annotation interface com.google.errorprone.annotations.RestrictedApi: Explanation why the API is restricted, to be inserted into the compiler output.

F

FINAL - Enum constant in enum class com.google.errorprone.annotations.Modifier
FormatMethod - Annotation Interface in com.google.errorprone.annotations: Annotation for a method that takes a printf-style format string as an argument followed by arguments for that format string.
FormatString - Annotation Interface in com.google.errorprone.annotations: Annotation for method parameter declarations which denotes that actual parameters will be used as a format string in printf-style formatting.
ForOverride - Annotation Interface in com.google.errorprone.annotations: Indicates that the annotated method is provided only to be overridden: it should not be invoked from outside its declaring source file (as if it is private), and overriding methods should not be directly invoked at all.

G

GuardedBy - Annotation Interface in com.google.errorprone.annotations.concurrent: Indicates that the annotated element should be used only while holding the specified lock.

I

Immutable - Annotation Interface in com.google.errorprone.annotations: The class to which this annotation is applied is immutable.
ImmutableTypeParameter - Annotation Interface in com.google.errorprone.annotations: The type parameter to which this annotation is applied should only be instantiated with immutable types.
imports() - Element in annotation interface com.google.errorprone.annotations.InlineMe: The new imports to (optionally) add to the caller.
IncompatibleModifiers - Annotation Interface in com.google.errorprone.annotations: Annotation declaring that the target annotation is incompatible with any one of the provided modifiers.
InlineMe - Annotation Interface in com.google.errorprone.annotations: Indicates that callers of this API should be inlined.
InlineMeValidationDisabled - Annotation Interface in com.google.errorprone.annotations: An annotation that disables validation of the InlineMe annotation's correctness (i.e.: that it accurately represents an inlining of the annotated method).

K

Keep - Annotation Interface in com.google.errorprone.annotations: Indicates that the annotated element should not be removed, and that its visibility, modifiers, type, and name should not be modified.

L

LazyInit - Annotation Interface in com.google.errorprone.annotations.concurrent: Use this annotation on any static or field that will be initialized lazily, where races yield no semantic difference in the code (as, for example, is the case with String.hashCode()).
link() - Element in annotation interface com.google.errorprone.annotations.RestrictedApi: Optional link explaining why the API is restricted.
LockMethod - Annotation Interface in com.google.errorprone.annotations.concurrent: Deprecated.
the correctness of this annotation is not enforced; it will soon be removed.

M

modifier() - Element in annotation interface com.google.errorprone.annotations.IncompatibleModifiers: The incompatible modifiers.
modifier() - Element in annotation interface com.google.errorprone.annotations.RequiredModifiers: The required modifiers.
Modifier - Enum Class in com.google.errorprone.annotations: Modifiers in the Java language, as specified in: https://docs.oracle.com/javase/specs/jls/se11/html/jls-8.html#jls-8.1.1 https://docs.oracle.com/javase/specs/jls/se11/html/jls-8.html#jls-8.3.1 https://docs.oracle.com/javase/specs/jls/se11/html/jls-8.html#jls-8.4.3 https://docs.oracle.com/javase/specs/jls/se11/html/jls-9.html#jls-9.4
MustBeClosed - Annotation Interface in com.google.errorprone.annotations: Annotation for constructors of AutoCloseables or methods that return an AutoCloseable and require that the resource is closed.

N

NATIVE - Enum constant in enum class com.google.errorprone.annotations.Modifier
NoAllocation - Annotation Interface in com.google.errorprone.annotations: Annotation for method declarations, which denotes that this method will not cause allocations that are visible from source code.

O

OverridingMethodsMustInvokeSuper - Annotation Interface in com.google.errorprone.annotations: Indicates that any concrete method that overrides the annotated method, directly or indirectly, must invoke super.theAnnotatedMethod(...) at some point.

P

PRIVATE - Enum constant in enum class com.google.errorprone.annotations.Modifier
PROTECTED - Enum constant in enum class com.google.errorprone.annotations.Modifier
PUBLIC - Enum constant in enum class com.google.errorprone.annotations.Modifier

R

replacement() - Element in annotation interface com.google.errorprone.annotations.InlineMe: What the caller should be replaced with.
RequiredModifiers - Annotation Interface in com.google.errorprone.annotations: Annotation declaring that the target annotation requires all the specified modifiers.
RestrictedApi - Annotation Interface in com.google.errorprone.annotations: Restrict access to this API element to callers with an allowlist annotation or a specific path.

S

STATIC - Enum constant in enum class com.google.errorprone.annotations.Modifier
staticImports() - Element in annotation interface com.google.errorprone.annotations.InlineMe: The new static imports to (optionally) add to the caller.
STRICTFP - Enum constant in enum class com.google.errorprone.annotations.Modifier
SuppressPackageLocation - Annotation Interface in com.google.errorprone.annotations: Indicates that the PackageLocation warning should be suppressed for this package.
SYNCHRONIZED - Enum constant in enum class com.google.errorprone.annotations.Modifier

T

ThreadSafe - Annotation Interface in com.google.errorprone.annotations: This annotation indicates that the class/interface it is applied to is thread safe
ThreadSafeTypeParameter - Annotation Interface in com.google.errorprone.annotations: When a ThreadSafe class has type parameters, annotating a parameter with ThreadSafeTypeParameter enforces that declarations of this class must, for that type parameter, use a type that is itself thread-safe.
Tool support - Section in annotation interface com.google.errorprone.annotations.DoNotCall
TRANSIENT - Enum constant in enum class com.google.errorprone.annotations.Modifier

U

UnlockMethod - Annotation Interface in com.google.errorprone.annotations.concurrent: Deprecated.
the correctness of this annotation is not enforced; it will soon be removed.

V

value() - Element in annotation interface com.google.errorprone.annotations.CompatibleWith
value() - Element in annotation interface com.google.errorprone.annotations.concurrent.GuardedBy: The lock that should be held, specified in the format given in the documentation for the corresponding Error Prone check.
value() - Element in annotation interface com.google.errorprone.annotations.concurrent.LockMethod: Deprecated.
value() - Element in annotation interface com.google.errorprone.annotations.concurrent.UnlockMethod: Deprecated.
value() - Element in annotation interface com.google.errorprone.annotations.DoNotCall: An optional explanation of why the method should not be called.
value() - Element in annotation interface com.google.errorprone.annotations.DoNotMock: The reason why the annotated type should not be mocked.
value() - Element in annotation interface com.google.errorprone.annotations.InlineMeValidationDisabled: An explanation as to why the validation is disabled (e.g.: moving from a constructor to a static factory method that delegates to this constructor, which is behavior-perserving, but isn't strictly an inlining).
valueOf(String) - Static method in enum class com.google.errorprone.annotations.Modifier: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.google.errorprone.annotations.Modifier: Returns an array containing the constants of this enum class, in the order they are declared.
Var - Annotation Interface in com.google.errorprone.annotations: The parameter or local variable to which this annotation is applied is non-final.
VOLATILE - Enum constant in enum class com.google.errorprone.annotations.Modifier

A C D E F G I K L M N O P R S T U V
All Classes and Interfaces|All Packages