Package com.tngtech.archunit.core.domain.properties

Interface HasAnnotations<SELF extends HasAnnotations<SELF>>

All Superinterfaces:

CanBeAnnotated, HasDescription

All Known Implementing Classes:

JavaClass, JavaCodeUnit, JavaConstructor, JavaField, JavaMember, JavaMethod, JavaPackage, JavaParameter, JavaStaticInitializer

@PublicAPI(usage=ACCESS)
public interface HasAnnotations<SELF extends HasAnnotations<SELF>>
extends CanBeAnnotated, HasDescription

Nested Class Summary

Nested classes/interfaces inherited from interface com.tngtech.archunit.core.domain.properties.CanBeAnnotated

CanBeAnnotated.Predicates, CanBeAnnotated.Utils

Method Summary

Modifier and Type	Method	Description
<A extends Annotation> A	getAnnotationOfType(Class<A> type)
JavaAnnotation<? extends SELF>	getAnnotationOfType(String typeName)
Set<? extends JavaAnnotation<? extends SELF>>	getAnnotations()
<A extends Annotation> Optional<A>	tryGetAnnotationOfType(Class<A> type)
Optional<? extends JavaAnnotation<? extends SELF>>	tryGetAnnotationOfType(String typeName)

Methods inherited from interface com.tngtech.archunit.core.domain.properties.CanBeAnnotated

isAnnotatedWith, isAnnotatedWith, isAnnotatedWith, isMetaAnnotatedWith, isMetaAnnotatedWith, isMetaAnnotatedWith

Methods inherited from interface com.tngtech.archunit.base.HasDescription

getDescription

Method Details

getAnnotations

@PublicAPI(usage=ACCESS)
Set<? extends JavaAnnotation<? extends SELF>> getAnnotations()

getAnnotationOfType

@PublicAPI(usage=ACCESS)
<A extends Annotation> A getAnnotationOfType(Class<A> type)

Type Parameters:

A - The type of the Annotation to retrieve

Parameters:

type - The Class of the Annotation to retrieve.

Returns:

The Annotation of the given type. Will throw an IllegalArgumentException if no matching Annotation is present.

See Also:

• tryGetAnnotationOfType(Class)
• getAnnotationOfType(String)

getAnnotationOfType

@PublicAPI(usage=ACCESS)
JavaAnnotation<? extends SELF> getAnnotationOfType(String typeName)

Parameters:

typeName - The fully qualified class name of the Annotation type to retrieve.

Returns:

The JavaAnnotation matching the given type. Will throw an IllegalArgumentException if no matching Annotation is present.

See Also:

• tryGetAnnotationOfType(String)
• getAnnotationOfType(Class)

tryGetAnnotationOfType

@PublicAPI(usage=ACCESS)
<A extends Annotation> Optional<A> tryGetAnnotationOfType(Class<A> type)

Type Parameters:

A - The type of the Annotation to retrieve

Parameters:

type - The Class of the Annotation to retrieve.

Returns:

The Annotation of the given type or Optional.empty() if there is no Annotation with the respective annotation type.

See Also:

• getAnnotationOfType(Class)
• tryGetAnnotationOfType(String)

tryGetAnnotationOfType

@PublicAPI(usage=ACCESS)
Optional<? extends JavaAnnotation<? extends SELF>> tryGetAnnotationOfType(String typeName)

Parameters:

typeName - The fully qualified class name of the Annotation type to retrieve.

Returns:

The JavaAnnotation matching the given type or Optional.empty() if there is no Annotation with the respective annotation type.

See Also:

• getAnnotationOfType(String)
• tryGetAnnotationOfType(Class)