Class AnnotationOverlayImpl

java.lang.Object

org.jboss.jandex.AnnotationOverlayImpl

All Implemented Interfaces:

AnnotationOverlay

Direct Known Subclasses:

MutableAnnotationOverlayImpl

class AnnotationOverlayImpl
extends Object
implements AnnotationOverlay

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	AnnotationOverlayImpl.TransformationContextImpl

Nested classes/interfaces inherited from interface AnnotationOverlay

AnnotationOverlay.Builder

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final boolean	compatibleMode
(package private) final IndexView	index
(package private) final boolean	inheritedAnnotations
(package private) final Map<EquivalenceKey, Collection<AnnotationInstance>>	overlay
(package private) final boolean	runtimeAnnotationsOnly
(package private) final List<AnnotationTransformation>	transformations

Constructor Summary

Constructors

Constructor	Description
AnnotationOverlayImpl(IndexView index, boolean compatibleMode, boolean runtimeAnnotationsOnly, boolean inheritedAnnotations, Collection<AnnotationTransformation> annotationTransformations)

Method Summary

Modifier and Type	Method	Description
final AnnotationInstance	annotation(Declaration declaration, DotName name)	Returns the annotation instance with given name declared on given declaration.
final Collection<AnnotationInstance>	annotations(Declaration declaration)	Returns the annotation instances declared on given declaration.
final Collection<AnnotationInstance>	annotationsWithRepeatable(Declaration declaration, DotName name)	Returns the annotation instances with given name declared on given declaration.
(package private) Collection<AnnotationInstance>	getAnnotationsFor(Declaration declaration)
(package private) final Collection<AnnotationInstance>	getOriginalAnnotations(Declaration declaration)
final boolean	hasAnnotation(Declaration declaration, DotName name)	Returns whether an annotation instance with given name is declared on given declaration.
final boolean	hasAnyAnnotation(Declaration declaration, Set<DotName> names)	Returns whether any annotation instance with one of given names is declared on given declaration.
final IndexView	index()	Returns the index whose annotation information is being overlaid.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface AnnotationOverlay

annotation, annotationsWithRepeatable, hasAnnotation, hasAnyAnnotation

Field Details

index

final IndexView index

compatibleMode

final boolean compatibleMode

runtimeAnnotationsOnly

final boolean runtimeAnnotationsOnly

inheritedAnnotations

final boolean inheritedAnnotations

transformations

final List<AnnotationTransformation> transformations

overlay

final Map<EquivalenceKey, Collection<AnnotationInstance>> overlay

Constructor Details

AnnotationOverlayImpl

AnnotationOverlayImpl(IndexView index,
 boolean compatibleMode,
 boolean runtimeAnnotationsOnly,
 boolean inheritedAnnotations,
 Collection<AnnotationTransformation> annotationTransformations)

Method Details

index

public final IndexView index()

Description copied from interface: AnnotationOverlay

Returns the index whose annotation information is being overlaid.

Specified by:

index in interface AnnotationOverlay

Returns:

the index underlying this annotation overlay, never null

hasAnnotation

public final boolean hasAnnotation(Declaration declaration,
 DotName name)

Description copied from interface: AnnotationOverlay

Returns whether an annotation instance with given name is declared on given declaration.

Like AnnotationTarget.hasDeclaredAnnotation(DotName), and unlike AnnotationTarget.hasAnnotation(DotName), this method ignores annotations declared on nested annotation targets. This doesn't hold in case of methods in the compatible mode, where method parameters are considered part of methods.

Specified by:

hasAnnotation in interface AnnotationOverlay

Parameters:

declaration - the declaration to inspect, must not be null

name - name of the annotation type to look for, must not be null

Returns:

true if the annotation is present, false otherwise

hasAnyAnnotation

public final boolean hasAnyAnnotation(Declaration declaration,
 Set<DotName> names)

Description copied from interface: AnnotationOverlay

Returns whether any annotation instance with one of given names is declared on given declaration.

This method ignores annotations declared on nested annotation targets. This doesn't hold in case of methods in the compatible mode, where method parameters are considered part of methods.

Specified by:

hasAnyAnnotation in interface AnnotationOverlay

Parameters:

declaration - the declaration to inspect, must not be null

names - names of the annotation types to look for, must not be null

Returns:

true if any of the annotations is present, false otherwise

annotation

public final AnnotationInstance annotation(Declaration declaration,
 DotName name)

Description copied from interface: AnnotationOverlay

Returns the annotation instance with given name declared on given declaration.

Like AnnotationTarget.declaredAnnotation(DotName), and unlike AnnotationTarget.annotation(DotName), this method doesn't return annotations declared on nested annotation targets. This doesn't hold in case of methods in the compatible mode, where method parameters are considered part of methods. In such case, if more than one annotation of given name is present, an unspecified instance is returned.

Specified by:

annotation in interface AnnotationOverlay

Parameters:

declaration - the declaration to inspect, must not be null

name - name of the annotation type to look for, must not be null

Returns:

the annotation instance, or null if not found

annotationsWithRepeatable

public final Collection<AnnotationInstance> annotationsWithRepeatable(Declaration declaration,
 DotName name)

Description copied from interface: AnnotationOverlay

Returns the annotation instances with given name declared on given declaration. If the specified annotation is repeatable, the result also contains all values from the container annotation instance.

The annotation class must be present in the index underlying this annotation overlay.

Like AnnotationTarget.declaredAnnotationsWithRepeatable(DotName, IndexView), and unlike AnnotationTarget.annotationsWithRepeatable(DotName, IndexView), this method doesn't return annotations declared on nested annotation targets. This doesn't hold in case of methods in the compatible mode, where method parameters are considered part of methods.

Specified by:

annotationsWithRepeatable in interface AnnotationOverlay

Parameters:

declaration - the declaration to inspect, must not be null

name - name of the annotation type, must not be null

Returns:

immutable collection of annotation instances, never null

annotations

public final Collection<AnnotationInstance> annotations(Declaration declaration)

Description copied from interface: AnnotationOverlay

Returns the annotation instances declared on given declaration.

Like AnnotationTarget.declaredAnnotations(), and unlike AnnotationTarget.annotations(), this method doesn't return annotations declared on nested annotation targets. This doesn't hold in case of methods in the compatible mode, where method parameters are considered part of methods.

Specified by:

annotations in interface AnnotationOverlay

Parameters:

declaration - the declaration to inspect, must not be null

Returns:

immutable collection of annotation instances, never null

getAnnotationsFor

Collection<AnnotationInstance> getAnnotationsFor(Declaration declaration)

getOriginalAnnotations

final Collection<AnnotationInstance> getOriginalAnnotations(Declaration declaration)