com.sdl.delivery.deployer.api.util

Class AnnotationUtil

java.lang.Object

com.sdl.delivery.deployer.api.util.AnnotationUtil

public class AnnotationUtil
extends Object

Class with utility methods to handle annotations.

Method Summary

Modifier and Type	Method and Description
static <T extends Annotation> T	getAnnotation(AnnotatedElement annotatedType, Class<T> annotationClass) Gets the annotation of the given annotation type from the given annotated class as an optional.
static <T extends Annotation> Optional<T>	getAnnotationSafely(AnnotatedElement annotatedType, Class<T> annotationClass) Gets the annotation of the given annotation type safely from the given annotated class.

Methods inherited from class java.lang.Object

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

Method Detail

getAnnotationSafely

public static <T extends Annotation> Optional<T> getAnnotationSafely(AnnotatedElement annotatedType,
                                                                     Class<T> annotationClass)

Gets the annotation of the given annotation type safely from the given annotated class. By safely it means that either an absent optional or an optional containing the annotation will be retrieved, avoiding returning null.

Type Parameters:

T - The type of the annotation returned.

Parameters:

annotatedType - The given annotated type. It can not be null.

annotationClass - The given annotation type. It can not be null.

Returns:

The annotation returned as an optional.

getAnnotation

public static <T extends Annotation> T getAnnotation(AnnotatedElement annotatedType,
                                                     Class<T> annotationClass)

Gets the annotation of the given annotation type from the given annotated class as an optional.

Type Parameters:

T - The type of the annotation returned.

Parameters:

annotatedType - The given annotated type.

annotationClass - The given annotation type.

Returns:

The annotation returned as an optional.