Package io.github.lukehutch.fastclasspathscanner.scanner

Class AnnotationInfo

java.lang.Object

io.github.lukehutch.fastclasspathscanner.scanner.AnnotationInfo

All Implemented Interfaces:

Comparable<AnnotationInfo>

public class AnnotationInfo
extends Object
implements Comparable<AnnotationInfo>

Holds metadata about annotations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AnnotationInfo.AnnotationClassRef	Stores a class descriptor in an annotation as a class type string, e.g.
static class	AnnotationInfo.AnnotationEnumValue	Class for wrapping an enum constant value (split into class name and constant name) referenced inside an annotation.
static class	AnnotationInfo.AnnotationParamValue	A wrapper used to pair annotation parameter names with annotation parameter values.

Constructor Summary

Constructors

Constructor	Description
AnnotationInfo(String annotationName, List<AnnotationInfo.AnnotationParamValue> annotationParamValues)

Method Summary

Modifier and Type	Method	Description
int	compareTo(AnnotationInfo o)
boolean	equals(Object obj)
String	getAnnotationName()	Get the name of the annotation.
List<AnnotationInfo.AnnotationParamValue>	getAnnotationParamValues()	Get the parameter value of the annotation.
Class<?>	getAnnotationType()	Get a class reference for the annotation.
static String[]	getUniqueAnnotationNamesSorted(AnnotationInfo[] annotationInfo)	From an array of AnnotationInfo objects, extract the annotation names, uniquify them, and sort them.
static String[]	getUniqueAnnotationNamesSorted(Collection<AnnotationInfo> annotationInfo)	From a collection of AnnotationInfo objects, extract the annotation names, uniquify them, and sort them.
int	hashCode()
String	toString()
void	toString(StringBuilder buf)	Render as a string, into a StringBuilder buffer.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AnnotationInfo

public AnnotationInfo(String annotationName,
                      List<AnnotationInfo.AnnotationParamValue> annotationParamValues)

Parameters:

annotationName - The name of the annotation.

annotationParamValues - The annotation parameter values, or null if none.

Method Detail

getAnnotationName

public String getAnnotationName()

Get the name of the annotation.

Returns:

The annotation name.

getAnnotationType

public Class<?> getAnnotationType()

Get a class reference for the annotation.

Returns:

The annotation type, as a Class<?> reference.

getAnnotationParamValues

public List<AnnotationInfo.AnnotationParamValue> getAnnotationParamValues()

Get the parameter value of the annotation.

Returns:

The annotation parameter values.

compareTo

public int compareTo(AnnotationInfo o)

Specified by:

compareTo in interface Comparable<AnnotationInfo>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public void toString(StringBuilder buf)

Render as a string, into a StringBuilder buffer.

Parameters:

buf - The buffer.

toString

public String toString()

Overrides:

toString in class Object

getUniqueAnnotationNamesSorted

public static String[] getUniqueAnnotationNamesSorted(Collection<AnnotationInfo> annotationInfo)

From a collection of AnnotationInfo objects, extract the annotation names, uniquify them, and sort them.

Parameters:

annotationInfo - The annotation info.

Returns:

The sorted, uniquified annotation names.

getUniqueAnnotationNamesSorted

public static String[] getUniqueAnnotationNamesSorted(AnnotationInfo[] annotationInfo)

From an array of AnnotationInfo objects, extract the annotation names, uniquify them, and sort them.

Parameters:

annotationInfo - The annotation info.

Returns:

The sorted, uniquified annotation names.