org.springframework.boot.test.context

Class AnnotatedClassFinder

java.lang.Object

org.springframework.boot.test.context.AnnotatedClassFinder

public final class AnnotatedClassFinder
extends java.lang.Object

Utility class to find a class annotated with a particular annotation in a hierarchy.

Since:

2.1.0

Constructor Summary

Constructors

Constructor and Description
AnnotatedClassFinder(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) Create a new instance with the annotationType to find.

Method Summary

Modifier and Type	Method and Description
java.lang.Class<?>	findFromClass(java.lang.Class<?> source) Find the first Class that is annotated with the target annotation, starting from the package defined by the given source up to the root.
java.lang.Class<?>	findFromPackage(java.lang.String source) Find the first Class that is annotated with the target annotation, starting from the package defined by the given source up to the root.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotatedClassFinder

public AnnotatedClassFinder(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

Create a new instance with the annotationType to find.

Parameters:

annotationType - the annotation to find

Method Detail

findFromClass

public java.lang.Class<?> findFromClass(java.lang.Class<?> source)

Find the first Class that is annotated with the target annotation, starting from the package defined by the given source up to the root.

Parameters:

source - the source class to use to initiate the search

Returns:

the first Class annotated with the target annotation within the hierarchy defined by the given source or null if none is found.

findFromPackage

public java.lang.Class<?> findFromPackage(java.lang.String source)

Find the first Class that is annotated with the target annotation, starting from the package defined by the given source up to the root.

Parameters:

source - the source package to use to initiate the search

Returns:

the first Class annotated with the target annotation within the hierarchy defined by the given source or null if none is found.