Interface Description

All Known Implementing Classes:

AnnotationDescription, ClassDescription, MethodDescription, PackageDescription, ParameterDescription

public sealed interface Description
permits AnnotationDescription<T>, ClassDescription, MethodDescription, PackageDescription, ParameterDescription

The common interface of all Description types.

A Description is, as the name says, a description of a class, method or parameter, similar to how java.lang.reflect works.

See Also:

• ClassDescription
• MethodDescription
• ParameterDescription

Method Summary

Modifier and Type	Method	Description
default <T extends Annotation> T	annotation(Class<T> type)	Gets the Annotation of this element for the specified type.
Collection<AnnotationDescription<?>>	annotations()	Gets all Annotations this element is annotated with
default <T extends Annotation> Optional<T>	findAnnotation(Class<T> type)	Gets the Annotation of this element for the specified type if such an annotation is present
default boolean	hasAnnotation(Class<? extends Annotation> type)	Checks whether this element has an Annotation of the specified type.

Method Details

annotations

Collection<AnnotationDescription<?>> annotations()

Gets all Annotations this element is annotated with

Returns:

a possibly-empty Collection of all Annotations this element is annotated with.

findAnnotation

default <T extends Annotation> Optional<T> findAnnotation(Class<T> type)

Gets the Annotation of this element for the specified type if such an annotation is present

Parameters:

type - the type of the annotation to get

Returns:

an Optional holding the Annotation if present at this element or else an empty Optional

annotation

default <T extends Annotation> T annotation(Class<T> type)

Gets the Annotation of this element for the specified type. Throws if no matching annotation is found.

Parameters:

type - the type of the annotation to get

Returns:

an Optional holding the Annotation

Throws:

NoSuchElementException - if no element was found

See Also:

• Optional.orElseThrow()

hasAnnotation

default boolean hasAnnotation(Class<? extends Annotation> type)

Checks whether this element has an Annotation of the specified type.

Parameters:

type - the type of the annotation

Returns:

true if the annotation is present else false