io.github.lukehutch.fastclasspathscanner.scanner

Class ScanResult

java.lang.Object

io.github.lukehutch.fastclasspathscanner.scanner.ScanResult

public class ScanResult
extends Object

The result of a scan.

Constructor Summary

Constructors

Constructor and Description
ScanResult(ScanSpec scanSpec, Map<String,ClassInfo> classNameToClassInfo, Map<File,Long> fileToTimestamp, ThreadLog log)

Method Summary

Modifier and Type	Method and Description
long	classpathContentsLastModifiedTime()
boolean	classpathContentsModifiedSinceScan() Returns true if the classpath contents have been modified since the last scan.
String	generateClassGraphDotFile(float sizeX, float sizeY) Generates a .dot file which can be fed into GraphViz for layout and visualization of the class graph.
List<String>	getNamesOfAllAnnotationClasses() Return the sorted unique names of all annotation classes found during the scan.
List<String>	getNamesOfAllClasses() Get the sorted unique names of all classes, interfaces and annotations found during the scan.
List<String>	getNamesOfAllInterfaceClasses() Return the sorted unique names of all interface classes found during the scan.
List<String>	getNamesOfAllStandardClasses() Get the sorted unique names of all standard (non-interface/annotation) classes found during the scan.
List<String>	getNamesOfAnnotationsOnClass(Class<?> classOrInterface) Return the names of all annotations and meta-annotations on the specified class or interface.
List<String>	getNamesOfAnnotationsOnClass(String classOrInterfaceName) Return the sorted list of names of all annotations and meta-annotations on the named class.
List<String>	getNamesOfAnnotationsWithMetaAnnotation(Class<?> metaAnnotation) Return the names of all annotations that are annotated with the specified meta-annotation.
List<String>	getNamesOfAnnotationsWithMetaAnnotation(String metaAnnotationName) Return the names of all annotations that have the named meta-annotation.
List<String>	getNamesOfClassesImplementing(Class<?> implementedInterface) Returns the names of classes on the classpath that implement the specified interface or a subinterface, or whose superclasses implement the specified interface or a sub-interface.
List<String>	getNamesOfClassesImplementing(String interfaceName) Return the sorted list of names of all classes implementing the named interface.
List<String>	getNamesOfClassesImplementingAllOf(Class<?>... implementedInterfaces) Returns the names of classes on the classpath that implement (or have superclasses that implement) all of the specified interfaces or their subinterfaces.
List<String>	getNamesOfClassesImplementingAllOf(String... implementedInterfaceNames) Returns the names of classes on the classpath that implement (or have superclasses that implement) all of the specified interfaces or their subinterfaces.
List<String>	getNamesOfClassesWithAnnotation(Class<?> annotation) Returns the names of classes on the classpath that have the specified annotation.
List<String>	getNamesOfClassesWithAnnotation(String annotationName) Return the sorted list of names of all standard classes or non-annotation interfaces with the named class annotation or meta-annotation.
List<String>	getNamesOfClassesWithAnnotationsAllOf(Class<?>... annotations) Returns the names of classes on the classpath that have all of the specified annotations.
List<String>	getNamesOfClassesWithAnnotationsAllOf(String... annotationNames) Returns the names of classes on the classpath that have all of the specified annotations.
List<String>	getNamesOfClassesWithAnnotationsAnyOf(Class<?>... annotations) Returns the names of classes on the classpath that have any of the specified annotations.
List<String>	getNamesOfClassesWithAnnotationsAnyOf(String... annotationNames) Returns the names of classes on the classpath that have any of the specified annotations.
List<String>	getNamesOfClassesWithFieldOfType(Class<?> fieldType) Returns the names of classes that have a field of the given type.
List<String>	getNamesOfClassesWithFieldOfType(String fieldTypeName) Return a sorted list of classes that have a field of the named type, where the field type is in a whitelisted (non-blacklisted) package.
List<String>	getNamesOfMetaAnnotationsOnAnnotation(Class<?> annotation) Return the names of all meta-annotations on the specified annotation.
List<String>	getNamesOfMetaAnnotationsOnAnnotation(String annotationName) Return the sorted list of names of all meta-annotations on the named annotation.
List<String>	getNamesOfSubclassesOf(Class<?> superclass) Returns the names of classes on the classpath that extend the specified superclass.
List<String>	getNamesOfSubclassesOf(String className) Return the sorted list of names of all subclasses of the named class.
List<String>	getNamesOfSubinterfacesOf(Class<?> superInterface) Returns the names of interfaces on the classpath that extend a given superinterface.
List<String>	getNamesOfSubinterfacesOf(String interfaceName) Return the sorted list of names of all subinterfaces of the named interface.
List<String>	getNamesOfSuperclassesOf(Class<?> subclass) Returns the names of classes on the classpath that are superclasses of the specified subclass.
List<String>	getNamesOfSuperclassesOf(String className) Return the sorted list of names of all superclasses of the named class.
List<String>	getNamesOfSuperinterfacesOf(Class<?> subInterface) Returns the names of interfaces on the classpath that are superinterfaces of a given subinterface.
List<String>	getNamesOfSuperinterfacesOf(String interfaceName) Return the names of all superinterfaces of the named interface.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScanResult

public ScanResult(ScanSpec scanSpec,
                  Map<String,ClassInfo> classNameToClassInfo,
                  Map<File,Long> fileToTimestamp,
                  ThreadLog log)

Method Detail

classpathContentsModifiedSinceScan

public boolean classpathContentsModifiedSinceScan()

Returns true if the classpath contents have been modified since the last scan. Checks the timestamps of files and jarfiles encountered during the previous scan to see if they have changed. Does not perform a full scan, so cannot detect the addition of files to whitelisted paths in regular (non-jar) directories -- you need to perform a full scan to detect those changes. However, can detect the deletion of files from whitelisted directories, and changes to the contents of jarfiles (since the timestamp of the whole jarfile changes).

classpathContentsLastModifiedTime

public long classpathContentsLastModifiedTime()

getNamesOfAllClasses

public List<String> getNamesOfAllClasses()

Get the sorted unique names of all classes, interfaces and annotations found during the scan.

getNamesOfAllStandardClasses

public List<String> getNamesOfAllStandardClasses()

Get the sorted unique names of all standard (non-interface/annotation) classes found during the scan.

getNamesOfSubclassesOf

public List<String> getNamesOfSubclassesOf(String className)

Return the sorted list of names of all subclasses of the named class.

getNamesOfSubclassesOf

public List<String> getNamesOfSubclassesOf(Class<?> superclass)

Returns the names of classes on the classpath that extend the specified superclass. Should be called after scan(), and returns matching classes whether or not a SubclassMatchProcessor was added to the scanner before the call to scan(). Does not call the classloader on the matching classes, just returns their names.

Parameters:

superclass - The superclass to match (i.e. the class that subclasses need to extend to match).

Returns:

A list of the names of matching classes, or the empty list if none.

getNamesOfSuperclassesOf

public List<String> getNamesOfSuperclassesOf(String className)

Return the sorted list of names of all superclasses of the named class.

getNamesOfSuperclassesOf

public List<String> getNamesOfSuperclassesOf(Class<?> subclass)

Returns the names of classes on the classpath that are superclasses of the specified subclass. Should be called after scan(), and returns matching classes whether or not a SubclassMatchProcessor was added to the scanner before the call to scan(). Does not call the classloader on the matching classes, just returns their names.

Parameters:

subclass - The subclass to match (i.e. the class that needs to extend a superclass for the superclass to match).

Returns:

A list of the names of matching classes, or the empty list if none.

getNamesOfClassesWithFieldOfType

public List<String> getNamesOfClassesWithFieldOfType(String fieldTypeName)

Return a sorted list of classes that have a field of the named type, where the field type is in a whitelisted (non-blacklisted) package.

getNamesOfClassesWithFieldOfType

public List<String> getNamesOfClassesWithFieldOfType(Class<?> fieldType)

Returns the names of classes that have a field of the given type. Returns classes that have fields with the same type as the requested type, array fields with an element type that matches the requested type, and fields of parameterized type that have a type parameter of the requested type. The field type must be declared in a package that is whitelisted (and not blacklisted).

getNamesOfAllInterfaceClasses

public List<String> getNamesOfAllInterfaceClasses()

Return the sorted unique names of all interface classes found during the scan.

getNamesOfSubinterfacesOf

public List<String> getNamesOfSubinterfacesOf(String interfaceName)

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

getNamesOfSubinterfacesOf

public List<String> getNamesOfSubinterfacesOf(Class<?> superInterface)

Returns the names of interfaces on the classpath that extend a given superinterface. Should be called after scan(), and returns matching interfaces whether or not a SubinterfaceMatchProcessor was added to the scanner before the call to scan(). Does not call the classloader on the matching interfaces, just returns their names.

Parameters:

superInterface - The superinterface to match (i.e. the interface that subinterfaces need to extend to match).

Returns:

A list of the names of matching interfaces, or the empty list if none.

getNamesOfSuperinterfacesOf

public List<String> getNamesOfSuperinterfacesOf(String interfaceName)

Return the names of all superinterfaces of the named interface.

getNamesOfSuperinterfacesOf

public List<String> getNamesOfSuperinterfacesOf(Class<?> subInterface)

Returns the names of interfaces on the classpath that are superinterfaces of a given subinterface. Should be called after scan(), and returns matching interfaces whether or not a SubinterfaceMatchProcessor was added to the scanner before the call to scan(). Does not call the classloader on the matching interfaces, just returns their names.

Parameters:

subInterface - The superinterface to match (i.e. the interface that subinterfaces need to extend to match).

Returns:

A list of the names of matching interfaces, or the empty list if none.

getNamesOfClassesImplementing

public List<String> getNamesOfClassesImplementing(String interfaceName)

Return the sorted list of names of all classes implementing the named interface.

getNamesOfClassesImplementing

public List<String> getNamesOfClassesImplementing(Class<?> implementedInterface)

Returns the names of classes on the classpath that implement the specified interface or a subinterface, or whose superclasses implement the specified interface or a sub-interface. Should be called after scan(), and returns matching interfaces whether or not an InterfaceMatchProcessor was added to the scanner before the call to scan(). Does not call the classloader on the matching classes, just returns their names.

Parameters:

implementedInterface - The interface that classes need to implement to match.

Returns:

A list of the names of matching classes, or the empty list if none.

getNamesOfClassesImplementingAllOf

public List<String> getNamesOfClassesImplementingAllOf(String... implementedInterfaceNames)

Returns the names of classes on the classpath that implement (or have superclasses that implement) all of the specified interfaces or their subinterfaces. Should be called after scan(), and returns matching interfaces whether or not an InterfaceMatchProcessor was added to the scanner before the call to scan(). Does not call the classloader on the matching classes, just returns their names.

Parameters:

implementedInterfaceNames - The name of the interfaces that classes need to implement.

Returns:

A list of the names of matching classes, or the empty list if none.

getNamesOfClassesImplementingAllOf

public List<String> getNamesOfClassesImplementingAllOf(Class<?>... implementedInterfaces)

Returns the names of classes on the classpath that implement (or have superclasses that implement) all of the specified interfaces or their subinterfaces. Should be called after scan(), and returns matching interfaces whether or not an InterfaceMatchProcessor was added to the scanner before the call to scan(). Does not call the classloader on the matching classes, just returns their names.

Parameters:

implementedInterfaces - The name of the interfaces that classes need to implement.

Returns:

A list of the names of matching classes, or the empty list if none.

getNamesOfAllAnnotationClasses

public List<String> getNamesOfAllAnnotationClasses()

Return the sorted unique names of all annotation classes found during the scan.

getNamesOfClassesWithAnnotation

public List<String> getNamesOfClassesWithAnnotation(String annotationName)

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

getNamesOfClassesWithAnnotation

public List<String> getNamesOfClassesWithAnnotation(Class<?> annotation)

Returns the names of classes on the classpath that have the specified annotation. Should be called after scan(), and returns matching classes whether or not a ClassAnnotationMatchProcessor was added to the scanner before the call to scan(). Does not call the classloader on the matching classes, just returns their names.

Parameters:

annotation - The class annotation.

Returns:

A list of the names of classes with the class annotation, or the empty list if none.

getNamesOfClassesWithAnnotationsAllOf

public List<String> getNamesOfClassesWithAnnotationsAllOf(String... annotationNames)

Returns the names of classes on the classpath that have all of the specified annotations. Should be called after scan(), and returns matching classes whether or not a ClassAnnotationMatchProcessor was added to the scanner before the call to scan(). Does not call the classloader on the matching classes, just returns their names.

Parameters:

annotationNames - The annotation names.

Returns:

A list of the names of classes that have all of the annotations, or the empty list if none.

getNamesOfClassesWithAnnotationsAllOf

public List<String> getNamesOfClassesWithAnnotationsAllOf(Class<?>... annotations)

Returns the names of classes on the classpath that have all of the specified annotations. Should be called after scan(), and returns matching classes whether or not a ClassAnnotationMatchProcessor was added to the scanner before the call to scan(). Does not call the classloader on the matching classes, just returns their names.

Parameters:

annotations - The annotations.

Returns:

A list of the names of classes that have all of the annotations, or the empty list if none.

getNamesOfClassesWithAnnotationsAnyOf

public List<String> getNamesOfClassesWithAnnotationsAnyOf(String... annotationNames)

Returns the names of classes on the classpath that have any of the specified annotations. Should be called after scan(), and returns matching classes whether or not a ClassAnnotationMatchProcessor was added to the scanner before the call to scan(). Does not call the classloader on the matching classes, just returns their names.

Parameters:

annotationNames - The annotation names.

Returns:

A list of the names of classes that have one or more of the annotations, or the empty list if none.

getNamesOfClassesWithAnnotationsAnyOf

public List<String> getNamesOfClassesWithAnnotationsAnyOf(Class<?>... annotations)

Returns the names of classes on the classpath that have any of the specified annotations. Should be called after scan(), and returns matching classes whether or not a ClassAnnotationMatchProcessor was added to the scanner before the call to scan(). Does not call the classloader on the matching classes, just returns their names.

Parameters:

annotations - The annotations.

Returns:

A list of the names of classes that have one or more of the annotations, or the empty list if none.

getNamesOfAnnotationsOnClass

public List<String> getNamesOfAnnotationsOnClass(String classOrInterfaceName)

Return the sorted list of names of all annotations and meta-annotations on the named class.

getNamesOfAnnotationsOnClass

public List<String> getNamesOfAnnotationsOnClass(Class<?> classOrInterface)

Return the names of all annotations and meta-annotations on the specified class or interface.

Parameters:

classOrInterface - The class or interface.

Returns:

A list of the names of annotations and meta-annotations on the class, or the empty list if none.

getNamesOfMetaAnnotationsOnAnnotation

public List<String> getNamesOfMetaAnnotationsOnAnnotation(String annotationName)

Return the sorted list of names of all meta-annotations on the named annotation.

getNamesOfMetaAnnotationsOnAnnotation

public List<String> getNamesOfMetaAnnotationsOnAnnotation(Class<?> annotation)

Return the names of all meta-annotations on the specified annotation.

Parameters:

annotation - The specified annotation.

Returns:

A list of the names of meta-annotations on the specified annotation, or the empty list if none.

getNamesOfAnnotationsWithMetaAnnotation

public List<String> getNamesOfAnnotationsWithMetaAnnotation(String metaAnnotationName)

Return the names of all annotations that have the named meta-annotation.

getNamesOfAnnotationsWithMetaAnnotation

public List<String> getNamesOfAnnotationsWithMetaAnnotation(Class<?> metaAnnotation)

Return the names of all annotations that are annotated with the specified meta-annotation.

Parameters:

metaAnnotation - The specified meta-annotation.

Returns:

A list of the names of annotations that are annotated with the specified meta annotation, or the empty list if none.

generateClassGraphDotFile

public String generateClassGraphDotFile(float sizeX,
                                        float sizeY)

Generates a .dot file which can be fed into GraphViz for layout and visualization of the class graph. The sizeX and sizeY parameters are the image output size to use (in inches) when GraphViz is asked to render the .dot file.