ScanResult (FastClasspathScanner 2.0.6 API)

java.lang.Object
- io.github.lukehutch.fastclasspathscanner.scanner.ScanResult

```
public class ScanResult
extends Object
```
The result of a scan.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`classpathContentsLastModifiedTime()` Find the maximum last-modified timestamp of any whitelisted file/directory/jarfile encountered during the scan.
`boolean`	`classpathContentsModifiedSinceScan()` Determine whether the classpath contents have been modified since the last scan.
`String`	`generateClassGraphDotFile(float sizeX, float sizeY)` Generate a .dot file which can be fed into GraphViz for layout and visualization of the class graph.
`Map<String,ClassInfo>`	`getClassNameToClassInfo()` Get a map from class name to ClassInfo object for all whitelisted classes found during the scan.
`List<Throwable>`	`getMatchProcessorExceptions()` Return the exceptions and errors thrown during classloading and/or while calling MatchProcessors on loaded classes.
`List<String>`	`getNamesOfAllAnnotationClasses()` Get the names of all annotation classes found during the scan.
`List<String>`	`getNamesOfAllClasses()` Get the names of all classes, interfaces and annotations found during the scan.
`List<String>`	`getNamesOfAllInterfaceClasses()` Get the names of all interface classes found during the scan.
`List<String>`	`getNamesOfAllStandardClasses()` Get the names of all standard (non-interface/non-annotation) classes found during the scan.
`List<String>`	`getNamesOfAnnotationsOnClass(Class<?> klass)` Get the names of all annotations and meta-annotations on the given class.
`List<String>`	`getNamesOfAnnotationsOnClass(String className)` Get the names of all annotations and meta-annotations on the named class.
`List<String>`	`getNamesOfAnnotationsWithMetaAnnotation(Class<?> metaAnnotation)` Return the names of all annotations that have the named meta-annotation.
`List<String>`	`getNamesOfAnnotationsWithMetaAnnotation(String metaAnnotationName)` Return the names of all annotations that have the named meta-annotation.
`List<String>`	`getNamesOfClassesImplementing(Class<?> implementedInterface)` Get the names of all classes that implement (or have superclasses that implement) the given interface (or one of its subinterfaces).
`List<String>`	`getNamesOfClassesImplementing(String interfaceName)` Get the names of all classes that implement (or have superclasses that implement) the named interface (or one of its subinterfaces).
`List<String>`	`getNamesOfClassesImplementingAllOf(Class<?>... implementedInterfaces)` Get the names of all classes that implement (or have superclasses that implement) all of the given interfaces (or their subinterfaces).
`List<String>`	`getNamesOfClassesImplementingAllOf(String... implementedInterfaceNames)` Get the names of all classes that implement (or have superclasses that implement) all of the named interfaces (or their subinterfaces).
`List<String>`	`getNamesOfClassesWithAnnotation(Class<?> annotation)` Get the names of non-annotation classes with the given class annotation or meta-annotation.
`List<String>`	`getNamesOfClassesWithAnnotation(String annotationName)` Get the names of non-annotation classes with the named class annotation or meta-annotation.
`List<String>`	`getNamesOfClassesWithAnnotationsAllOf(Class<?>... annotations)` Get the names of classes that have all of the given annotations.
`List<String>`	`getNamesOfClassesWithAnnotationsAllOf(String... annotationNames)` Get the names of classes that have all of the named annotations.
`List<String>`	`getNamesOfClassesWithAnnotationsAnyOf(Class<?>... annotations)` Get the names of classes that have any of the given annotations.
`List<String>`	`getNamesOfClassesWithAnnotationsAnyOf(String... annotationNames)` Get the names of classes that have any of the named annotations.
`List<String>`	`getNamesOfClassesWithFieldOfType(Class<?> fieldType)` Get the names of classes that have a field of the given type, or that have the given type as a type parameter.
`List<String>`	`getNamesOfClassesWithFieldOfType(String fieldTypeName)` Get the names of classes that have a field of the named type, or that have the given type as a type parameter.
`List<String>`	`getNamesOfClassesWithMethodAnnotation(Class<?> annotation)` Get the names of classes that have a method with an annotation of the given type.
`List<String>`	`getNamesOfClassesWithMethodAnnotation(String annotationName)` Get the names of classes that have a method with an annotation of the named type.
`List<String>`	`getNamesOfSubclassesOf(Class<?> superclass)` Get the names of classes on the classpath that extend the specified superclass.
`List<String>`	`getNamesOfSubclassesOf(String superclassName)` Get the names of all subclasses of the named class.
`List<String>`	`getNamesOfSubinterfacesOf(Class<?> superInterface)` Get the names of interfaces on the classpath that extend a given superinterface.
`List<String>`	`getNamesOfSubinterfacesOf(String interfaceName)` Get the names of all subinterfaces of the named interface.
`List<String>`	`getNamesOfSuperclassesOf(Class<?> subclass)` Get the names of classes on the classpath that are superclasses of the specified subclass.
`List<String>`	`getNamesOfSuperclassesOf(String subclassName)` Get the names of classes on the classpath that are superclasses of the named subclass.
`List<String>`	`getNamesOfSuperinterfacesOf(Class<?> subInterface)` Get the names of all superinterfaces of the given subinterface.
`List<String>`	`getNamesOfSuperinterfacesOf(String subInterfaceName)` Get the names of all superinterfaces of the named interface.
`List<File>`	`getUniqueClasspathElements()` Returns the list of File objects for unique classpath elements (directories or jarfiles), in classloader resolution order.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getMatchProcessorExceptions
```
public List<Throwable> getMatchProcessorExceptions()
```
    Return the exceptions and errors thrown during classloading and/or while calling MatchProcessors on loaded classes.
  - getUniqueClasspathElements
```
public List<File> getUniqueClasspathElements()
```
    Returns the list of File objects for unique classpath elements (directories or jarfiles), in classloader resolution order.
    
    Returns:
    
    The unique classpath elements.
  - classpathContentsModifiedSinceScan
```
public boolean classpathContentsModifiedSinceScan()
```
    Determine whether 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 directories that newly match whitelist criteria -- you need to perform a full scan to detect those changes.
    
    Returns:
    
    true if the classpath contents have been modified since the last scan.
  - classpathContentsLastModifiedTime
```
public long classpathContentsLastModifiedTime()
```
    Find the maximum last-modified timestamp of any whitelisted file/directory/jarfile encountered during the scan. Checks the current timestamps, so this should increase between calls if something changes in whitelisted paths. Assumes both file and system timestamps were generated from clocks whose time was accurate. Ignores timestamps greater than the system time.
    
    Returns:
    
    the maximum last-modified time for whitelisted files/directories/jars encountered during the scan.
  - getClassNameToClassInfo
```
public Map<String,ClassInfo> getClassNameToClassInfo()
```
    Get a map from class name to ClassInfo object for all whitelisted classes found during the scan. You can get the info for a specific class directly from this map, or the values() of this map may be filtered using Java 8 stream processing, see here: https://github.com/lukehutch/fast-classpath-scanner/wiki/1.-Usage#mechanism-3
    
    Returns:
    
    A map from class name to ClassInfo object for the class.
  - getNamesOfAllClasses
```
public List<String> getNamesOfAllClasses()
```
    Get the names of all classes, interfaces and annotations found during the scan.
    
    Returns:
    
    The sorted list of the names of all whitelisted classes found during the scan, or the empty list if none.
  - getNamesOfAllStandardClasses
```
public List<String> getNamesOfAllStandardClasses()
```
    Get the names of all standard (non-interface/non-annotation) classes found during the scan.
    
    Returns:
    
    The sorted list of the names of all encountered standard classes, or the empty list if none.
  - getNamesOfSubclassesOf
```
public List<String> getNamesOfSubclassesOf(String superclassName)
```
    Get the names of all subclasses of the named class.
    
    Parameters:
    
    superclassName - The name of the superclass.
    
    Returns:
    
    The sorted list of the names of matching subclasses, or the empty list if none.
  - getNamesOfSubclassesOf
```
public List<String> getNamesOfSubclassesOf(Class<?> superclass)
```
    Get the names of classes on the classpath that extend the specified superclass.
    
    Parameters:
    
    superclass - The superclass to match (i.e. the class that subclasses need to extend to match).
    
    Returns:
    
    The sorted list of the names of matching subclasses, or the empty list if none.
  - getNamesOfSuperclassesOf
```
public List<String> getNamesOfSuperclassesOf(String subclassName)
```
    Get the names of classes on the classpath that are superclasses of the named subclass.
    
    Parameters:
    
    subclassName - The name of the subclass.
    
    Returns:
    
    The sorted list of the names of superclasses of the named subclass, or the empty list if none.
  - getNamesOfSuperclassesOf
```
public List<String> getNamesOfSuperclassesOf(Class<?> subclass)
```
    Get the names of classes on the classpath that are superclasses of the specified subclass.
    
    Parameters:
    
    subclass - The subclass to match (i.e. the class that needs to extend a superclass for the superclass to match).
    
    Returns:
    
    The sorted list of the names of superclasses of the subclass, or the empty list if none.
  - getNamesOfClassesWithFieldOfType
```
public List<String> getNamesOfClassesWithFieldOfType(String fieldTypeName)
```
    Get the names of classes that have a field of the named type, or that have the given type as a type parameter.
    
    Parameters:
    
    fieldTypeName - the name of the field type.
    
    Returns:
    
    The sorted list of the names of classes with a field of the named type, or the empty list if none.
  - getNamesOfClassesWithFieldOfType
```
public List<String> getNamesOfClassesWithFieldOfType(Class<?> fieldType)
```
    Get the names of classes that have a field of the given type, or that have the given type as a type parameter.
    
    Parameters:
    
    fieldType - the field type.
    
    Returns:
    
    The sorted list of the names of classes with a field of the given type, or the empty list if none.
  - getNamesOfClassesWithMethodAnnotation
```
public List<String> getNamesOfClassesWithMethodAnnotation(String annotationName)
```
    Get the names of classes that have a method with an annotation of the named type.
    
    Parameters:
    
    annotationName - the name of the method annotation.
    
    Returns:
    
    The sorted list of the names of classes with a field of the named type, or the empty list if none.
  - getNamesOfClassesWithMethodAnnotation
```
public List<String> getNamesOfClassesWithMethodAnnotation(Class<?> annotation)
```
    Get the names of classes that have a method with an annotation of the given type.
    
    Parameters:
    
    annotation - the method annotation.
    
    Returns:
    
    The sorted list of the names of classes with a field of the given type, or the empty list if none.
  - getNamesOfAllInterfaceClasses
```
public List<String> getNamesOfAllInterfaceClasses()
```
    Get the names of all interface classes found during the scan.
    
    Returns:
    
    The sorted list of the names of all whitelisted interfaces found during the scan, or the empty list if none.
  - getNamesOfSubinterfacesOf
```
public List<String> getNamesOfSubinterfacesOf(String interfaceName)
```
    Get the names of all subinterfaces of the named interface.
    
    Parameters:
    
    interfaceName - The interface name.
    
    Returns:
    
    The sorted list of the names of all subinterfaces of the named interface, or the empty list if none.
  - getNamesOfSubinterfacesOf
```
public List<String> getNamesOfSubinterfacesOf(Class<?> superInterface)
```
    Get the names of interfaces on the classpath that extend a given superinterface.
    
    Parameters:
    
    superInterface - The superinterface.
    
    Returns:
    
    The sorted list of the names of subinterfaces of the given superinterface, or the empty list if none.
  - getNamesOfSuperinterfacesOf
```
public List<String> getNamesOfSuperinterfacesOf(String subInterfaceName)
```
    Get the names of all superinterfaces of the named interface.
    
    Parameters:
    
    subInterfaceName - The subinterface name.
    
    Returns:
    
    The sorted list of the names of superinterfaces of the named subinterface, or the empty list if none.
  - getNamesOfSuperinterfacesOf
```
public List<String> getNamesOfSuperinterfacesOf(Class<?> subInterface)
```
    Get the names of all superinterfaces of the given subinterface.
    
    Parameters:
    
    subInterface - The subinterface.
    
    Returns:
    
    The sorted list of the names of superinterfaces of the given subinterface, or the empty list if none.
  - getNamesOfClassesImplementing
```
public List<String> getNamesOfClassesImplementing(String interfaceName)
```
    Get the names of all classes that implement (or have superclasses that implement) the named interface (or one of its subinterfaces).
    
    Parameters:
    
    interfaceName - The interface name.
    
    Returns:
    
    The sorted list of the names of all classes that implement the named interface, or the empty list if none.
  - getNamesOfClassesImplementing
```
public List<String> getNamesOfClassesImplementing(Class<?> implementedInterface)
```
    Get the names of all classes that implement (or have superclasses that implement) the given interface (or one of its subinterfaces).
    
    Parameters:
    
    implementedInterface - The interface.
    
    Returns:
    
    The sorted list of the names of all classes that implement the given interface, or the empty list if none.
  - getNamesOfClassesImplementingAllOf
```
public List<String> getNamesOfClassesImplementingAllOf(String... implementedInterfaceNames)
```
    Get the names of all classes that implement (or have superclasses that implement) all of the named interfaces (or their subinterfaces).
    
    Parameters:
    
    implementedInterfaceNames - The names of the interfaces.
    
    Returns:
    
    The sorted list of the names of all classes that implement all of the named interfaces, or the empty list if none.
  - getNamesOfClassesImplementingAllOf
```
public List<String> getNamesOfClassesImplementingAllOf(Class<?>... implementedInterfaces)
```
    Get the names of all classes that implement (or have superclasses that implement) all of the given interfaces (or their subinterfaces).
    
    Parameters:
    
    implementedInterfaces - The interfaces.
    
    Returns:
    
    The sorted list of the names of all classes that implement all of the given interfaces, or the empty list if none.
  - getNamesOfAllAnnotationClasses
```
public List<String> getNamesOfAllAnnotationClasses()
```
    Get the names of all annotation classes found during the scan.
    
    Returns:
    
    The sorted list of the names of all annotation classes found during the scan, or the empty list if none.
  - getNamesOfClassesWithAnnotation
```
public List<String> getNamesOfClassesWithAnnotation(String annotationName)
```
    Get the names of non-annotation classes with the named class annotation or meta-annotation.
    
    Parameters:
    
    annotationName - The name of the class annotation or meta-annotation.
    
    Returns:
    
    The sorted list of the names of all non-annotation classes that were found with the named class annotation during the scan, or the empty list if none.
  - getNamesOfClassesWithAnnotation
```
public List<String> getNamesOfClassesWithAnnotation(Class<?> annotation)
```
    Get the names of non-annotation classes with the given class annotation or meta-annotation.
    
    Parameters:
    
    annotation - The class annotation or meta-annotation to match.
    
    Returns:
    
    The sorted list of the names of all non-annotation classes that were found with the given class annotation during the scan, or the empty list if none.
  - getNamesOfClassesWithAnnotationsAllOf
```
public List<String> getNamesOfClassesWithAnnotationsAllOf(String... annotationNames)
```
    Get the names of classes that have all of the named annotations.
    
    Parameters:
    
    annotationNames - The class annotation names.
    
    Returns:
    
    The sorted list of the names of classes that have all of the named class annotations, or the empty list if none.
  - getNamesOfClassesWithAnnotationsAllOf
```
public List<String> getNamesOfClassesWithAnnotationsAllOf(Class<?>... annotations)
```
    Get the names of classes that have all of the given annotations.
    
    Parameters:
    
    annotations - The class annotations.
    
    Returns:
    
    The sorted list of the names of classes that have all of the given class annotations, or the empty list if none.
  - getNamesOfClassesWithAnnotationsAnyOf
```
public List<String> getNamesOfClassesWithAnnotationsAnyOf(String... annotationNames)
```
    Get the names of classes that have any of the named annotations.
    
    Parameters:
    
    annotationNames - The annotation names.
    
    Returns:
    
    The sorted list of the names of classes that have any of the named class annotations, or the empty list if none.
  - getNamesOfClassesWithAnnotationsAnyOf
```
public List<String> getNamesOfClassesWithAnnotationsAnyOf(Class<?>... annotations)
```
    Get the names of classes that have any of the given annotations.
    
    Parameters:
    
    annotations - The annotations.
    
    Returns:
    
    The sorted list of the names of classes that have any of the given class annotations, or the empty list if none.
  - getNamesOfAnnotationsOnClass
```
public List<String> getNamesOfAnnotationsOnClass(String className)
```
    Get the names of all annotations and meta-annotations on the named class.
    
    Parameters:
    
    className - The class name.
    
    Returns:
    
    The sorted list of the names of annotations and meta-annotations on the named class, or the empty list if none.
  - getNamesOfAnnotationsOnClass
```
public List<String> getNamesOfAnnotationsOnClass(Class<?> klass)
```
    Get the names of all annotations and meta-annotations on the given class.
    
    Parameters:
    
    klass - The class.
    
    Returns:
    
    The sorted list of the names of annotations and meta-annotations on the given class, 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.
    
    Parameters:
    
    metaAnnotationName - The name of the meta-annotation.
    
    Returns:
    
    The sorted list of the names of annotations that have the named meta-annotation, or the empty list if none.
  - getNamesOfAnnotationsWithMetaAnnotation
```
public List<String> getNamesOfAnnotationsWithMetaAnnotation(Class<?> metaAnnotation)
```
    Return the names of all annotations that have the named meta-annotation.
    
    Parameters:
    
    metaAnnotation - The meta-annotation.
    
    Returns:
    
    The sorted list of the names of annotations that have the given meta-annotation, or the empty list if none.
  - generateClassGraphDotFile
```
public String generateClassGraphDotFile(float sizeX,
                                        float sizeY)
```
    Generate 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.
    
    Parameters:
    
    sizeX - The GraphViz layout width in inches.
    
    sizeY - The GraphViz layout width in inches.
    
    Returns:
    
    the GraphViz file contents.

Class ScanResult

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getMatchProcessorExceptions

getUniqueClasspathElements

classpathContentsModifiedSinceScan

classpathContentsLastModifiedTime

getClassNameToClassInfo

getNamesOfAllClasses

getNamesOfAllStandardClasses

getNamesOfSubclassesOf

getNamesOfSubclassesOf

getNamesOfSuperclassesOf

getNamesOfSuperclassesOf

getNamesOfClassesWithFieldOfType

getNamesOfClassesWithFieldOfType

getNamesOfClassesWithMethodAnnotation

getNamesOfClassesWithMethodAnnotation

getNamesOfAllInterfaceClasses

getNamesOfSubinterfacesOf

getNamesOfSubinterfacesOf

getNamesOfSuperinterfacesOf

getNamesOfSuperinterfacesOf

getNamesOfClassesImplementing

getNamesOfClassesImplementing

getNamesOfClassesImplementingAllOf

getNamesOfClassesImplementingAllOf

getNamesOfAllAnnotationClasses

getNamesOfClassesWithAnnotation

getNamesOfClassesWithAnnotation

getNamesOfClassesWithAnnotationsAllOf

getNamesOfClassesWithAnnotationsAllOf

getNamesOfClassesWithAnnotationsAnyOf

getNamesOfClassesWithAnnotationsAnyOf

getNamesOfAnnotationsOnClass

getNamesOfAnnotationsOnClass

getNamesOfAnnotationsWithMetaAnnotation

getNamesOfAnnotationsWithMetaAnnotation

generateClassGraphDotFile