Annotation - Android SDK

Developer Console

Annotations
- Documented
- Inherited
- Retention
- Target
Interfaces
- Annotation
Enums
- ElementType
- RetentionPolicy
Exceptions
- AnnotationTypeMismatchException
- IncompleteAnnotationException
Errors
- AnnotationFormatError

fullscreen Use Tree Navigation

Summary: Methods | [Expand All]

Added in API level 1

public interface

Annotation

java.lang.annotation.Annotation

Known Indirect Subclasses

AnimRes, AnimatorRes, AnyRes, ArrayRes, AttrRes, and 60 others.

AnimRes	Denotes that an integer parameter, field or method return value is expected to be an anim resource reference (e.g.
AnimatorRes	Denotes that an integer parameter, field or method return value is expected to be an animator resource reference (e.g.
AnyRes	Denotes that an integer parameter, field or method return value is expected to be a resource reference of any type.
ArrayRes	Denotes that an integer parameter, field or method return value is expected to be an array resource reference (e.g.
AttrRes	Denotes that an integer parameter, field or method return value is expected to be an attribute reference (e.g.
Bindable	The Bindable annotation should be applied to any getter accessor method of an `Observable` class.
BinderThread	Denotes that the annotated method should only be called on the binder thread.
BindingAdapter	BindingAdapter is applied to methods that are used to manipulate how values with expressions are set to views.
BindingConversion	Annotate methods that are used to automatically convert from the expression type to the value used in the setter.
BindingMethod	Used within an `BindingMethods` annotation to describe a renaming of an attribute to the setter used to set that attribute.
BindingMethods	Used to enumerate attribute-to-setter renaming.
BoolRes	Denotes that an integer parameter, field or method return value is expected to be a boolean resource reference.
CallSuper	Denotes that any overriding methods should invoke this method as well.
CheckResult	Denotes that the annotated method returns a result that it typically is an error to ignore.
ColorInt	Denotes that the annotated element represents a packed color int, `AARRGGBB`.
ColorRes	Denotes that an integer parameter, field or method return value is expected to be a color resource reference (e.g.
ContentRecommendation.ContentMaturity
ContentRecommendation.ContentPricing
ContentRecommendation.ContentStatus
ContentRecommendation.ContentType
ContentRecommendation.IntentType
CoordinatorLayout.DefaultBehavior	Defines the default `CoordinatorLayout.Behavior` of a `View` class.
Deprecated	Annotation type used to mark program elements that should no longer be used by programmers.
DimenRes	Denotes that an integer parameter, field or method return value is expected to be a dimension resource reference (e.g.
Documented	Defines a meta-annotation for indicating that an annotation is documented and considered part of the public API.
DrawableRes	Denotes that an integer parameter, field or method return value is expected to be a drawable resource reference (e.g.
FlakyTest	This annotation can be used on an `InstrumentationTestCase`'s test methods.
FloatRange	Denotes that the annotated element should be a float or double in the given range Example: `@FloatRange(from=0.0,to=1.0) public float getAlpha() { ...` }
FractionRes	Denotes that an integer parameter, field or method return value is expected to be a fraction resource reference.
IdRes	Denotes that an integer parameter, field or method return value is expected to be an id resource reference (e.g.
Inherited	Defines a meta-annotation for indicating that an annotation is automatically inherited.
IntDef	Denotes that the annotated element of integer type, represents a logical type and that its value should be one of the explicitly named constants.
IntRange	Denotes that the annotated element should be an int or long in the given range Example: `@IntRange(from=0,to=255) public int getAlpha() { ...` }
IntegerRes	Denotes that an integer parameter, field or method return value is expected to be an integer resource reference (e.g.
InterpolatorRes	Denotes that an integer parameter, field or method return value is expected to be an interpolator resource reference (e.g.
JavascriptInterface	Annotation that allows exposing methods to JavaScript.
Keep	Denotes that the annotated element should not be removed when the code is minified at build time.
LargeTest	Marks a test that should run as part of the large tests.
LayoutRes	Denotes that an integer parameter, field or method return value is expected to be a layout resource reference (e.g.
MainThread	Denotes that the annotated method should only be called on the main thread.
MediumTest	Marks a test that should run as part of the medium tests.
MenuRes	Denotes that an integer parameter, field or method return value is expected to be a menu resource reference.
NonNull	Denotes that a parameter, field or method return value can never be null.
Nullable	Denotes that a parameter, field or method return value can be null.
Override	Annotation type used to mark methods that override a method declaration in a superclass.
PermissionChecker.PermissionResult
PluralsRes	Denotes that an integer parameter, field or method return value is expected to be a plurals resource reference.
RawRes	Denotes that an integer parameter, field or method return value is expected to be a raw resource reference.
RemoteViews.RemoteView	This annotation indicates that a subclass of View is alllowed to be used with the `RemoteViews` mechanism.
Retention	Defines a meta-annotation for determining the scope of retention for an annotation.
SafeVarargs	Claims to the compiler that the annotation target does nothing potentially unsafe to its varargs argument.
Size	Denotes that the annotated element should have a given size or length.
SmallTest	Marks a test that should run as part of the small tests.
Smoke	Marks a test that should run as part of the smoke tests.
StringDef	Denotes that the annotated String element, represents a logical type and that its value should be one of the explicitly named constants.
StringRes	Denotes that an integer parameter, field or method return value is expected to be a String resource reference (e.g.
StyleRes	Denotes that an integer parameter, field or method return value is expected to be a style resource reference (e.g.
StyleableRes	Denotes that an integer parameter, field or method return value is expected to be a styleable resource reference (e.g.
Suppress	Use this annotation on test classes or test methods that should not be included in a test suite.
SuppressLint	Indicates that Lint should ignore the specified warnings for the annotated element.
SuppressWarnings	Annotation type used to indicate that the compiler should not issue the specified warnings for the marked program element.
Target	Defines a meta-annotation for determining what `ElementType`s an annotation can be applied to.
TargetApi	Indicates that Lint should treat this type as targeting a given API level, no matter what the project target is.
TestTarget	This @interface was deprecated in API level 14. Obsolete.
TestTargetClass	This @interface was deprecated in API level 14. Obsolete.
TransitionRes	Denotes that an integer parameter, field or method return value is expected to be a transition resource reference.
UiThread	Denotes that the annotated method or constructor should only be called on the UI thread.
UiThreadTest	This annotation can be used on an `InstrumentationTestCase`'s test methods.
ViewDebug.CapturedViewProperty	This annotation can be used to mark fields and methods to be dumped when the view is captured.
ViewDebug.ExportedProperty	This annotation can be used to mark fields and methods to be dumped by the view server.
ViewDebug.FlagToString	Defines a mapping from a flag to a String.
ViewDebug.IntToString	Defines a mapping from an int value to a String.
VisibleForTesting	Denotes that the class, method or field has its visibility relaxed, so that it is more widely visible than otherwise necessary to make code testable.
WorkerThread	Denotes that the annotated method should only be called on a worker thread.
XmlRes	Denotes that an integer parameter, field or method return value is expected to be an XML resource reference.

Class Overview

Defines the interface implemented by all annotations. Note that the interface itself is not an annotation, and neither is an interface that simply extends this one. Only the compiler is able to create proper annotation types.

Summary

Public Methods
abstract Class<? extends Annotation>	annotationType() Returns the type of this annotation.
abstract boolean	equals(Object obj) Determines whether or not this annotation is equivalent to the annotation passed.
abstract int	hashCode() Returns the hash code of this annotation.
abstract String	toString() Returns a `String` representation of this annotation.

Public Methods

public abstract Class<? extends Annotation> annotationType ()

Added in API level 1

Returns the type of this annotation.

Returns

A Class instance representing the annotation type.

public abstract boolean equals (Object obj)

Added in API level 1

Determines whether or not this annotation is equivalent to the annotation passed. This is determined according to the following rules:

Two annotations x and y are equal if and only if they are members of the same annotation type and all the member values of x are equal to the corresponding member values of y.
The equality of primitive member values x and y is determined (in a way similar to) using the corresponding wrapper classes. For example, Integer.valueOf(x).equals(Integer.valueOf(y) is used for int values. Note: The behavior is identical to the == operator for all but the floating point type, so the implementation may as well use == in these cases for performance reasons. Only for the float and double types the result will be slightly different: NaN is equal to NaN, and -0.0 is equal to 0.0, both of which is normally not the case.
The equality of two array member values x and y is determined using the corresponding equals(x, y) helper function in Arrays.
The hash code for all other member values is determined by simply calling their equals() method.

Parameters

obj	The object to compare to.

Returns

true if obj is equal to this annotation, false otherwise.

public abstract int hashCode ()

Added in API level 1

Returns the hash code of this annotation. The hash code is determined according to the following rules:

The hash code of an annotation is the sum of the hash codes of its annotation members.
The hash code of an annotation member is calculated as (0x7f * n.hashCode()) ^ v.hashCode()), where n is the name of the member (as a String) and v its value.
The hash code for a primitive member value is determined using the corresponding wrapper type. For example, Integer.valueOf(v).hashCode() is used for an int value v.
The hash code for an array member value v is determined using the corresponding hashCode(v) helper function in Arrays.
The hash code for all other member values is determined by simply calling their hashCode method.

Returns

the hash code.

public abstract String toString ()

Added in API level 1

Returns a String representation of this annotation. It is not strictly defined what the representation has to look like, but it usually consists of the name of the annotation, preceded by a "@". If the annotation contains field members, their names and values are also included in the result.

Returns

the String that represents this annotation.

Results

Annotations

Interfaces

Enums

Exceptions

Errors

Annotation

Class Overview

Summary

Public Methods

public abstract Class<? extends Annotation> annotationType ()

Returns

public abstract boolean equals (Object obj)

Parameters

Returns

public abstract int hashCode ()

Returns

public abstract String toString ()

Returns