Interface Annotated<T>

Type Parameters:

T - the type of the annotated object

public interface Annotated<T>

An interface whose implementations bear semantically significant annotations.

Semantically significant annotations are included in hashcode and equality computations.

Author:

Laird Nelson

See Also:

• AnnotationMirrors.sameAnnotation(AnnotationMirror, AnnotationMirror, java.util.function.Predicate)
• AnnotationMirrors.containsAll(java.util.Collection, java.util.Collection, java.util.function.Predicate)
• AnnotationMirrors.hashCode(AnnotationMirror, java.util.function.Predicate)

Method Summary

Modifier and Type	Method	Description
T	annotated()	Returns the non-null, determinate, annotated object.
List<AnnotationMirror>	annotations()	Returns a non-null, immutable, determinate List of semantically significant AnnotationMirrors.
static <T extends AnnotatedConstruct> Annotated<T>	of(T ac)	A convenience method that returns a new Annotated implementation.
static <T extends AnnotatedConstruct> Annotated<T>	of(T ac, Predicate<? super ExecutableElement> p)	A convenience method that returns a new Annotated implementation.

Method Details

annotations

List<AnnotationMirror> annotations()

Returns a non-null, immutable, determinate List of semantically significant AnnotationMirrors.

These annotations supersede any annotations that might otherwise be available from objects returned by the annotated() method.

Returns:

a non-null, immutable, determinate List of semantically significant AnnotationMirrors.

annotated

T annotated()

Returns the non-null, determinate, annotated object.

Returns:

the non-null, determinate, annotated object.

of

static <T extends AnnotatedConstruct> Annotated<T> of(T ac)

A convenience method that returns a new Annotated implementation.

Type Parameters:

T - the type of AnnotatedConstruct

Parameters:

ac - a non-null AnnotatedConstruct

Returns:

a new, non-null Annotated implementation

Throws:

NullPointerException - if ac is null

See Also:

• of(AnnotatedConstruct, Predicate)

of

static <T extends AnnotatedConstruct> Annotated<T> of(T ac,
 Predicate<? super ExecutableElement> p)

A convenience method that returns a new Annotated implementation.

Type Parameters:

T - the type of AnnotatedConstruct

Parameters:

ac - a non-null AnnotatedConstruct

p - a Predicate that returns true if a given ExecutableElement, representing an annotation element, is to be included in comparison operations; may be null in which case it is as if e -> true were supplied instead

Returns:

a new, non-null Annotated implementation

Throws:

NullPointerException - if ac is null