APIdia Launch Partner
Top Description Methods
java.lang.reflect

public Interface AnnotatedType

extends AnnotatedElement
Known Direct Subinterfaces
java.lang.reflect.AnnotatedTypeVariable, java.lang.reflect.AnnotatedWildcardType, java.lang.reflect.AnnotatedArrayType, java.lang.reflect.AnnotatedParameterizedType
Known Direct Implementers
sun.reflect.annotation.AnnotatedTypeFactory.AnnotatedTypeBaseImpl
Imports
java.lang.annotation.Annotation
AnnotatedType represents the potentially annotated use of a type in the program currently running in this VM. The use may be of any type in the Java programming language, including an array type, a parameterized type, a type variable, or a wildcard type. Note that any annotations returned by methods on this interface are type annotations (JLS 9.7.4) as the entity being potentially annotated is a type.
Since
1.8
Java Language Specification
4.1 The Kinds of Types and Values, 4.2 Primitive Types and Values, 4.3 Reference Types and Values, 4.4 Type Variables, 4.5 Parameterized Types, 4.8 Raw Types, 4.9 Intersection Types, 10.1 Array Types

Method Summary

Modifier and TypeMethod and Description
public default AnnotatedType

Returns:

an AnnotatedType object representing the potentially annotated type that this type is a member of, or null
getAnnotatedOwnerType()

Returns the potentially annotated type that this type is a member of, if this type represents a nested type.

public <T extends Annotation> T
getAnnotation(Class<T> annotationClass)

Redeclares java.lang.reflect.AnnotatedElement.getAnnotation.

Returns this element's annotation for the specified type if such an annotation is present, else null.

public Annotation[]
getAnnotations()

Redeclares java.lang.reflect.AnnotatedElement.getAnnotations.

Returns annotations that are present on this element.

public Annotation[]
getDeclaredAnnotations()

Redeclares java.lang.reflect.AnnotatedElement.getDeclaredAnnotations.

Returns annotations that are directly present on this element.

public Type

Returns:

the type this annotated type represents
getType()

Returns the underlying type that this annotated type represents.

Inherited from java.lang.reflect.AnnotatedElement:
getAnnotationsByTypegetDeclaredAnnotationgetDeclaredAnnotationsByTypeisAnnotationPresent

Method Detail

getAnnotatedOwnerTypeback to summary
public default AnnotatedType getAnnotatedOwnerType()

Returns the potentially annotated type that this type is a member of, if this type represents a nested type. For example, if this type is @TA O<T>.I<S>, return a representation of @TA O<T>.

Returns null if this AnnotatedType represents a top-level class or interface, or a local or anonymous class, or a primitive type, or void.

Returns null if this AnnotatedType is an instance of AnnotatedArrayType, AnnotatedTypeVariable, or AnnotatedWildcardType.

Implementation Specification

This default implementation returns null and performs no other action.

Returns:AnnotatedType

an AnnotatedType object representing the potentially annotated type that this type is a member of, or null

Exceptions
TypeNotPresentException:
if the owner type refers to a non-existent class or interface declaration
MalformedParameterizedTypeException:
if the owner type refers to a parameterized type that cannot be instantiated for any reason
Since
9
getAnnotationback to summary
public <T extends Annotation> T getAnnotation(Class<T> annotationClass)

Redeclares java.lang.reflect.AnnotatedElement.getAnnotation.

Doc from java.lang.reflect.AnnotatedElement.getAnnotation.

Returns this element's annotation for the specified type if such an annotation is present, else null.

Note that any annotation returned by this method is a type annotation.

Annotations
@Override
Exceptions
NullPointerException:
if the given annotation class is null
getAnnotationsback to summary
public Annotation[] getAnnotations()

Redeclares java.lang.reflect.AnnotatedElement.getAnnotations.

Doc from java.lang.reflect.AnnotatedElement.getAnnotations.

Returns annotations that are present on this element. If there are no annotations present on this element, the return value is an array of length 0. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.

Note that any annotations returned by this method are type annotations.

Annotations
@Override
getDeclaredAnnotationsback to summary
public Annotation[] getDeclaredAnnotations()

Redeclares java.lang.reflect.AnnotatedElement.getDeclaredAnnotations.

Doc from java.lang.reflect.AnnotatedElement.getDeclaredAnnotations.

Returns annotations that are directly present on this element. This method ignores inherited annotations. If there are no annotations directly present on this element, the return value is an array of length 0. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.

Note that any annotations returned by this method are type annotations.

Annotations
@Override
getTypeback to summary
public Type getType()

Returns the underlying type that this annotated type represents.

Returns:Type

the type this annotated type represents