public interface AnnotationReader<T,C,F,M>
This is the lowest abstraction that encapsulates the difference between reading inline annotations and external binding files.
Because the former operates on a Field
and Method
while the latter operates on a "property", the methods defined
on this interface takes both, and the callee gets to choose which
to use.
Most of the get method takes Locatable
, which points to
the place/context in which the annotation is read. The returned
annotation also implements Locatable
(so that it can
point to the place where the annotation is placed), and its
Locatable.getUpstream()
will return the given
Locatable
.
Errors found during reading annotations are reported through the error handler.
A valid ErrorHandler
must be registered before the AnnotationReader
is used.
Modifier and Type | Method and Description |
---|---|
Annotation[] |
getAllFieldAnnotations(F field,
Locatable srcPos)
Gets all the annotations on a field.
|
Annotation[] |
getAllMethodAnnotations(M method,
Locatable srcPos)
Gets all the annotations on a method.
|
<A extends Annotation> |
getClassAnnotation(Class<A> annotation,
C clazz,
Locatable srcpos)
Reads an annotation on a class.
|
T[] |
getClassArrayValue(Annotation a,
String name)
Similar to
getClassValue(Annotation, String) method but
obtains an array parameter. |
T |
getClassValue(Annotation a,
String name)
Reads a value of an annotation that returns a Class object.
|
<A extends Annotation> |
getFieldAnnotation(Class<A> annotation,
F field,
Locatable srcpos)
Reads an annotation on a property that consists of a field.
|
<A extends Annotation> |
getMethodAnnotation(Class<A> annotation,
M method,
Locatable srcpos) |
<A extends Annotation> |
getMethodAnnotation(Class<A> annotation,
M getter,
M setter,
Locatable srcpos)
Reads an annotation on a property that consists of a getter and a setter.
|
<A extends Annotation> |
getMethodParameterAnnotation(Class<A> annotation,
M method,
int paramIndex,
Locatable srcPos)
Reads an annotation on a parameter of the method.
|
<A extends Annotation> |
getPackageAnnotation(Class<A> annotation,
C clazz,
Locatable srcpos)
Reads an annotation on the package that the given class belongs to.
|
boolean |
hasClassAnnotation(C clazz,
Class<? extends Annotation> annotationType)
Checks if a class has the annotation.
|
boolean |
hasFieldAnnotation(Class<? extends Annotation> annotationType,
F field)
Checks if the given field has an annotation.
|
boolean |
hasMethodAnnotation(Class<? extends Annotation> annotation,
M method) |
boolean |
hasMethodAnnotation(Class<? extends Annotation> annotation,
String propertyName,
M getter,
M setter,
Locatable srcPos)
Checks if the given method has an annotation.
|
void |
setErrorHandler(ErrorHandler errorHandler)
Sets the error handler that receives errors found
during reading annotations.
|
void setErrorHandler(ErrorHandler errorHandler)
errorHandler
- must not be null.<A extends Annotation> A getFieldAnnotation(Class<A> annotation, F field, Locatable srcpos)
boolean hasFieldAnnotation(Class<? extends Annotation> annotationType, F field)
boolean hasClassAnnotation(C clazz, Class<? extends Annotation> annotationType)
Annotation[] getAllFieldAnnotations(F field, Locatable srcPos)
<A extends Annotation> A getMethodAnnotation(Class<A> annotation, M getter, M setter, Locatable srcpos)
boolean hasMethodAnnotation(Class<? extends Annotation> annotation, String propertyName, M getter, M setter, Locatable srcPos)
Annotation[] getAllMethodAnnotations(M method, Locatable srcPos)
srcPos
- the location from which this annotation is read.<A extends Annotation> A getMethodAnnotation(Class<A> annotation, M method, Locatable srcpos)
boolean hasMethodAnnotation(Class<? extends Annotation> annotation, M method)
@Nullable <A extends Annotation> A getMethodParameterAnnotation(Class<A> annotation, M method, int paramIndex, Locatable srcPos)
@Nullable <A extends Annotation> A getClassAnnotation(Class<A> annotation, C clazz, Locatable srcpos)
@Nullable <A extends Annotation> A getPackageAnnotation(Class<A> annotation, C clazz, Locatable srcpos)
T getClassValue(Annotation a, String name)
Depending on the underlying reflection library, you can't always
obtain the Class
object directly (see the Annotation Processing MirrorTypeException
for example), so use this method to avoid that.
name
- The name of the annotation parameter to be read.T[] getClassArrayValue(Annotation a, String name)
getClassValue(Annotation, String)
method but
obtains an array parameter.Copyright © 2019 JBoss by Red Hat. All rights reserved.