io.github.lukehutch.fastclasspathscanner.scanner

Class ClassInfo

java.lang.Object

io.github.lukehutch.fastclasspathscanner.scanner.ClassInfo

All Implemented Interfaces:

Comparable<ClassInfo>

public class ClassInfo
extends Object
implements Comparable<ClassInfo>

Method Summary

Modifier and Type	Method and Description
boolean	annotatesClass(String annotatedClassName) Returns true if this class annotates the named class.
int	compareTo(ClassInfo o)
boolean	directlyAnnotatesClass(String directlyAnnotatedClassName) Returns true if this class annotates the named class.
boolean	directlyImplementsInterface(String interfaceName) Returns true if this standard class directly implements the named interface, or by one of its superclasses.
boolean	equals(Object obj)
Set<ClassInfo>	getAnnotations() Return the set of all annotations and meta-annotations on this class or interface, or meta-annotations if this is an annotation.
Set<ClassInfo>	getAnnotationsWithDirectMetaAnnotation() Return the set of all annotations that have this direct meta-annotation.
Set<ClassInfo>	getAnnotationsWithMetaAnnotation() Return the set of all annotations that have this meta-annotation.
Set<ClassInfo>	getClassesDirectlyImplementing() Return the set of all class directly implementing this interface.
Set<ClassInfo>	getClassesImplementing() Return the set of all class implementing this interface, and all their subclasses.
Set<ClassInfo>	getClassesWithAnnotation() Return the set of all standard classes or non-annotation interfaces that this annotation class annotates.
String	getClassName() Get the name of this class.
static List<String>	getClassNames(Collection<ClassInfo> classInfoColl) Get the sorted list of the names of classes given a collection of ClassInfo objects.
Set<ClassInfo>	getDirectAnnotations() Return the set of all direct annotations and meta-annotations on this class or interface, or of direct meta-annotations if this is an annotation.
Set<ClassInfo>	getDirectlyAnnotatedClasses() Return the set of all standard classes or non-annotation interfaces that are directly annotated with this annotation class.
Set<ClassInfo>	getDirectlyImplementedInterfaces() Return the set of all interfaces directly implemented by this standard class, or by one of its superclasses.
Set<ClassInfo>	getDirectSubclasses() Return the set of all direct subclasses.
Set<ClassInfo>	getDirectSubinterfaces() Return the set of all direct subinterfaces of an interface.
Set<ClassInfo>	getDirectSuperclasses() Return the set of all direct superclasses.
Set<ClassInfo>	getDirectSuperinterfaces() Return the set of all direct superinterfaces of an interface.
List<String>	getFieldTypes() Return the sorted list of names of field types.
Set<ClassInfo>	getImplementedInterfaces() Return the set of all interfaces implemented by this standard class, or by one of its superclasses.
Set<ClassInfo>	getMetaAnnotations() Return the set of all annotations and meta-annotations, if this is an annotation class.
List<String>	getNamesOfAnnotations() Return the sorted list of names of all annotations and meta-annotations on this class or interface, or meta-annotations if this is an annotation.
List<String>	getNamesOfAnnotationsWithDirectMetaAnnotation() Return the sorted list of names of all annotations that have this direct meta-annotation.
List<String>	getNamesOfAnnotationsWithMetaAnnotation() Return the sorted list of names of all annotations that have this meta-annotation.
List<String>	getNamesOfClassesDirectlyImplementing() Return the names of all classes directly implementing this interface.
List<String>	getNamesOfClassesImplementing() Return the names of all classes implementing this interface, and all their subclasses.
List<String>	getNamesOfClassesWithAnnotation() Return the sorted list of names of all standard classes or non-annotation interfaces with this class as a class annotation or meta-annotation.
List<String>	getNamesOfDirectAnnotations() Return the sorted list of names of all direct annotations and meta-annotations on this class or interface, or of direct meta-annotations if this is an annotation.
List<String>	getNamesOfDirectlyAnnotatedClasses() Return the sorted list of names of all standard classes or non-annotation interfaces that are directly annotated with this annotation class.
List<String>	getNamesOfDirectlyImplementedInterfaces() Return the set of all interfaces directly implemented by this standard class, or by one of its superclasses.
List<String>	getNamesOfDirectSubclasses() Return the sorted list of names of all direct subclasses.
List<String>	getNamesOfDirectSubinterfaces() Return the sorted list of names of all direct subinterfaces of an interface.
List<String>	getNamesOfDirectSuperclasses() Return the sorted list of names of all direct superclasses.
List<String>	getNamesOfDirectSuperinterfaces() Return the names of all direct superinterfaces of an interface.
List<String>	getNamesOfImplementedInterfaces() Return the set of all interfaces implemented by this standard class, or by one of its superclasses.
List<String>	getNamesOfMetaAnnotations() Return the sorted list of names of all annotations and meta-annotations, if this is an annotation class.
List<String>	getNamesOfSubclasses() Return the sorted list of names of all subclasses.
List<String>	getNamesOfSubinterfaces() Return the sorted list of names of all subinterfaces of an interface.
List<String>	getNamesOfSuperclasses() Return the sorted list of names of all superclasses.
List<String>	getNamesOfSuperinterfaces() Return the sorted list of names of all superinterfaces of an interface.
Set<ClassInfo>	getSubclasses() Return the set of all subclasses.
Set<ClassInfo>	getSubinterfaces() Return the set of all subinterfaces of an interface.
Set<ClassInfo>	getSuperclasses() Return the set of all superclasses.
Set<ClassInfo>	getSuperinterfaces() Return the set of all superinterfaces of an interface.
boolean	hasAnnotation(String annotationName) Returns true if this class, interface or annotation has the named class annotation or meta-annotation.
boolean	hasDirectAnnotation(String directAnnotationName) Returns true if this class has the named direct annotation or meta-annotation.
boolean	hasDirectMetaAnnotation(String directMetaAnnotationName) Returns true if this annotation is directly meta-annotated with the named annotation.
boolean	hasDirectSubclass(String directSubclassName) Returns true if this class has the named direct subclass.
boolean	hasDirectSubinterface(String directSubinterfaceName) Returns true if this class is and interface and has the named direct subinterface.
boolean	hasDirectSuperclass(String directSuperclassName) Returns true if this class has the named direct subclass.
boolean	hasDirectSuperinterface(String directSuperinterfaceName) Returns true if this class is an interface and has the named direct superinterface.
int	hashCode()
boolean	hasMetaAnnotation(String metaAnnotationName) Returns true if this is an annotation class and it has the named meta-annotation.
boolean	hasSubclass(String subclassName) Returns true if this class has the named subclass.
boolean	hasSubinterface(String subinterfaceName) Returns true if this class is an interface and has the named subinterface.
boolean	hasSuperclass(String superclassName) Returns true if this class has the named superclass.
boolean	hasSuperinterface(String superinterfaceName) Returns true if this class is an interface and has the named superinterface.
boolean	implementsInterface(String interfaceName) Returns true if this standard class implements the named interface, or by one of its superclasses.
boolean	isAnnotation() Returns true if this ClassInfo corresponds to an annotation.
boolean	isDirectlyImplementedByClass(String className) Returns true if this class is directly implemented by the named class.
boolean	isImplementedByClass(String className) Returns true if this class is implemented by the named class, or by one of its superclasses.
boolean	isImplementedInterface() Returns true if this ClassInfo corresponds to an "implemented interface" (meaning a standard, non-annotation interface, or an annotation that has also been implemented as an interface by some class).
boolean	isStandardClass() Regular classes are not annotations or interfaces.
boolean	metaAnnotatesAnnotation(String annotationName) Returns true if this annotation has the named meta-annotation.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getClassName

public String getClassName()

Get the name of this class.

compareTo

public int compareTo(ClassInfo o)

Specified by:

compareTo in interface Comparable<ClassInfo>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getClassNames

public static List<String> getClassNames(Collection<ClassInfo> classInfoColl)

Get the sorted list of the names of classes given a collection of ClassInfo objects. (Class names are not deduplicated.)

isStandardClass

public boolean isStandardClass()

Regular classes are not annotations or interfaces.

getSubclasses

public Set<ClassInfo> getSubclasses()

Return the set of all subclasses.

getNamesOfSubclasses

public List<String> getNamesOfSubclasses()

Return the sorted list of names of all subclasses.

hasSubclass

public boolean hasSubclass(String subclassName)

Returns true if this class has the named subclass.

getDirectSubclasses

public Set<ClassInfo> getDirectSubclasses()

Return the set of all direct subclasses.

getNamesOfDirectSubclasses

public List<String> getNamesOfDirectSubclasses()

Return the sorted list of names of all direct subclasses.

hasDirectSubclass

public boolean hasDirectSubclass(String directSubclassName)

Returns true if this class has the named direct subclass.

getSuperclasses

public Set<ClassInfo> getSuperclasses()

Return the set of all superclasses.

getNamesOfSuperclasses

public List<String> getNamesOfSuperclasses()

Return the sorted list of names of all superclasses.

hasSuperclass

public boolean hasSuperclass(String superclassName)

Returns true if this class has the named superclass.

getDirectSuperclasses

public Set<ClassInfo> getDirectSuperclasses()

Return the set of all direct superclasses.

getNamesOfDirectSuperclasses

public List<String> getNamesOfDirectSuperclasses()

Return the sorted list of names of all direct superclasses.

hasDirectSuperclass

public boolean hasDirectSuperclass(String directSuperclassName)

Returns true if this class has the named direct subclass.

isImplementedInterface

public boolean isImplementedInterface()

Returns true if this ClassInfo corresponds to an "implemented interface" (meaning a standard, non-annotation interface, or an annotation that has also been implemented as an interface by some class). Annotations are interfaces, but you can also implement an annotation, so to we return true if an interface (even an annotation) is implemented by a class or extended by a subinterface, or (failing that) if it is not an interface but not an annotation. (This is named "implemented interface" rather than just "interface" to distinguish it from an annotation.)

getSubinterfaces

public Set<ClassInfo> getSubinterfaces()

Return the set of all subinterfaces of an interface.

getNamesOfSubinterfaces

public List<String> getNamesOfSubinterfaces()

Return the sorted list of names of all subinterfaces of an interface.

hasSubinterface

public boolean hasSubinterface(String subinterfaceName)

Returns true if this class is an interface and has the named subinterface.

getDirectSubinterfaces

public Set<ClassInfo> getDirectSubinterfaces()

Return the set of all direct subinterfaces of an interface.

getNamesOfDirectSubinterfaces

public List<String> getNamesOfDirectSubinterfaces()

Return the sorted list of names of all direct subinterfaces of an interface.

hasDirectSubinterface

public boolean hasDirectSubinterface(String directSubinterfaceName)

Returns true if this class is and interface and has the named direct subinterface.

getSuperinterfaces

public Set<ClassInfo> getSuperinterfaces()

Return the set of all superinterfaces of an interface.

getNamesOfSuperinterfaces

public List<String> getNamesOfSuperinterfaces()

Return the sorted list of names of all superinterfaces of an interface.

hasSuperinterface

public boolean hasSuperinterface(String superinterfaceName)

Returns true if this class is an interface and has the named superinterface.

getDirectSuperinterfaces

public Set<ClassInfo> getDirectSuperinterfaces()

Return the set of all direct superinterfaces of an interface.

getNamesOfDirectSuperinterfaces

public List<String> getNamesOfDirectSuperinterfaces()

Return the names of all direct superinterfaces of an interface.

hasDirectSuperinterface

public boolean hasDirectSuperinterface(String directSuperinterfaceName)

Returns true if this class is an interface and has the named direct superinterface.

getImplementedInterfaces

public Set<ClassInfo> getImplementedInterfaces()

Return the set of all interfaces implemented by this standard class, or by one of its superclasses.

getNamesOfImplementedInterfaces

public List<String> getNamesOfImplementedInterfaces()

Return the set of all interfaces implemented by this standard class, or by one of its superclasses.

implementsInterface

public boolean implementsInterface(String interfaceName)

Returns true if this standard class implements the named interface, or by one of its superclasses.

getDirectlyImplementedInterfaces

public Set<ClassInfo> getDirectlyImplementedInterfaces()

Return the set of all interfaces directly implemented by this standard class, or by one of its superclasses.

getNamesOfDirectlyImplementedInterfaces

public List<String> getNamesOfDirectlyImplementedInterfaces()

Return the set of all interfaces directly implemented by this standard class, or by one of its superclasses.

directlyImplementsInterface

public boolean directlyImplementsInterface(String interfaceName)

Returns true if this standard class directly implements the named interface, or by one of its superclasses.

getClassesImplementing

public Set<ClassInfo> getClassesImplementing()

Return the set of all class implementing this interface, and all their subclasses.

getNamesOfClassesImplementing

public List<String> getNamesOfClassesImplementing()

Return the names of all classes implementing this interface, and all their subclasses.

isImplementedByClass

public boolean isImplementedByClass(String className)

Returns true if this class is implemented by the named class, or by one of its superclasses.

getClassesDirectlyImplementing

public Set<ClassInfo> getClassesDirectlyImplementing()

Return the set of all class directly implementing this interface.

getNamesOfClassesDirectlyImplementing

public List<String> getNamesOfClassesDirectlyImplementing()

Return the names of all classes directly implementing this interface.

isDirectlyImplementedByClass

public boolean isDirectlyImplementedByClass(String className)

Returns true if this class is directly implemented by the named class.

isAnnotation

public boolean isAnnotation()

Returns true if this ClassInfo corresponds to an annotation.

getClassesWithAnnotation

public Set<ClassInfo> getClassesWithAnnotation()

Return the set of all standard classes or non-annotation interfaces that this annotation class annotates.

getNamesOfClassesWithAnnotation

public List<String> getNamesOfClassesWithAnnotation()

Return the sorted list of names of all standard classes or non-annotation interfaces with this class as a class annotation or meta-annotation.

annotatesClass

public boolean annotatesClass(String annotatedClassName)

Returns true if this class annotates the named class.

getDirectlyAnnotatedClasses

public Set<ClassInfo> getDirectlyAnnotatedClasses()

Return the set of all standard classes or non-annotation interfaces that are directly annotated with this annotation class.

getNamesOfDirectlyAnnotatedClasses

public List<String> getNamesOfDirectlyAnnotatedClasses()

Return the sorted list of names of all standard classes or non-annotation interfaces that are directly annotated with this annotation class.

directlyAnnotatesClass

public boolean directlyAnnotatesClass(String directlyAnnotatedClassName)

Returns true if this class annotates the named class.

getAnnotations

public Set<ClassInfo> getAnnotations()

Return the set of all annotations and meta-annotations on this class or interface, or meta-annotations if this is an annotation.

getNamesOfAnnotations

public List<String> getNamesOfAnnotations()

Return the sorted list of names of all annotations and meta-annotations on this class or interface, or meta-annotations if this is an annotation.

hasAnnotation

public boolean hasAnnotation(String annotationName)

Returns true if this class, interface or annotation has the named class annotation or meta-annotation.

getMetaAnnotations

public Set<ClassInfo> getMetaAnnotations()

Return the set of all annotations and meta-annotations, if this is an annotation class.

getNamesOfMetaAnnotations

public List<String> getNamesOfMetaAnnotations()

Return the sorted list of names of all annotations and meta-annotations, if this is an annotation class.

hasMetaAnnotation

public boolean hasMetaAnnotation(String metaAnnotationName)

Returns true if this is an annotation class and it has the named meta-annotation.

getDirectAnnotations

public Set<ClassInfo> getDirectAnnotations()

Return the set of all direct annotations and meta-annotations on this class or interface, or of direct meta-annotations if this is an annotation. (This is equivalent to the reflection call Class#getAnnotations(), except that it does not require calling the classloader.)

getNamesOfDirectAnnotations

public List<String> getNamesOfDirectAnnotations()

Return the sorted list of names of all direct annotations and meta-annotations on this class or interface, or of direct meta-annotations if this is an annotation. (This is equivalent to the reflection call Class#getAnnotations(), except that it does not require calling the classloader.)

hasDirectAnnotation

public boolean hasDirectAnnotation(String directAnnotationName)

Returns true if this class has the named direct annotation or meta-annotation. (This is equivalent to the reflection call Class#getAnnotations(), except that it does not require calling the classloader.)

getAnnotationsWithMetaAnnotation

public Set<ClassInfo> getAnnotationsWithMetaAnnotation()

Return the set of all annotations that have this meta-annotation.

getNamesOfAnnotationsWithMetaAnnotation

public List<String> getNamesOfAnnotationsWithMetaAnnotation()

Return the sorted list of names of all annotations that have this meta-annotation.

metaAnnotatesAnnotation

public boolean metaAnnotatesAnnotation(String annotationName)

Returns true if this annotation has the named meta-annotation.

getAnnotationsWithDirectMetaAnnotation

public Set<ClassInfo> getAnnotationsWithDirectMetaAnnotation()

Return the set of all annotations that have this direct meta-annotation.

getNamesOfAnnotationsWithDirectMetaAnnotation

public List<String> getNamesOfAnnotationsWithDirectMetaAnnotation()

Return the sorted list of names of all annotations that have this direct meta-annotation.

hasDirectMetaAnnotation

public boolean hasDirectMetaAnnotation(String directMetaAnnotationName)

Returns true if this annotation is directly meta-annotated with the named annotation.

getFieldTypes

public List<String> getFieldTypes()

Return the sorted list of names of field types. Requires FastClasspathScanner#indexFieldTypes() to have been called before scanning.