java.lang.Object
- io.github.lukehutch.fastclasspathscanner.ClassInfoList

All Implemented Interfaces:

Iterable<ClassInfo>, Collection<ClassInfo>, List<ClassInfo>
```
public class ClassInfoList
extends Object
implements List<ClassInfo>
```
A list of ClassInfo objects, which stores both reachable classes (obtained through a given class relationship, either by direct relationship or through an indirect path), and directly related classes (classes reachable through a direct relationship only).
By default, this list returns reachable classes. By calling directOnly(), you can get the directly related classes.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static interface`	`ClassInfoList.ClassInfoFilter`	Filter a `ClassInfoList` using a predicate mapping a `ClassInfo` object to a boolean, producing another `ClassInfoList` for all items in the list for which the predicate is true.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`add(int index, ClassInfo element)`
`boolean`	`add(ClassInfo e)`
`boolean`	`addAll(int index, Collection<? extends ClassInfo> c)`
`boolean`	`addAll(Collection<? extends ClassInfo> c)`
`void`	`clear()`
`boolean`	`contains(Object o)`
`boolean`	`containsAll(Collection<?> c)`
`boolean`	`containsName(String className)`	Return true if this `ClassInfo` list contains a class with the given name.
`ClassInfoList`	`directOnly()`	Get the list of classes that were directly related, as opposed to reachable through multiple steps.
`ClassInfoList`	`exclude(ClassInfoList other)`	Find the set difference between this `ClassInfoList` and another `ClassInfoList`, i.e.
`ClassInfoList`	`filter(ClassInfoList.ClassInfoFilter filter)`	Find the set difference between this ClassInfoList and another ClassInfoList, i.e.
`String`	`generateGraphVizDotFile()`	Generate a .dot file which can be fed into GraphViz for layout and visualization of the class graph.
`String`	`generateGraphVizDotFile(float sizeX, float sizeY)`	Generate a .dot file which can be fed into GraphViz for layout and visualization of the class graph.
`String`	`generateGraphVizDotFile(float sizeX, float sizeY, boolean showFields, boolean showMethods, boolean showAnnotations)`	Generate a .dot file which can be fed into GraphViz for layout and visualization of the class graph.
`void`	`generateGraphVizDotFile(File file)`	Generate a and save a .dot file, which can be fed into GraphViz for layout and visualization of the class graph.
`ClassInfo`	`get(int index)`
`ClassInfo`	`get(String name)`	Return the `ClassInfo` object in the list with the given name, or null if not found.
`ClassInfoList`	`getAnnotations()`	Filter this `ClassInfoList` to include only annotations.
`List<String>`	`getAsStrings()`	Get the string representations of all classes in this list (with annotations, modifiers, etc.), by calling `ClassInfo.toString()` on each item in the list.
`ClassInfoList`	`getEnums()`	Filter this `ClassInfoList` to include only `Enum` classes.
`ClassInfoList`	`getImplementedInterfaces()`	Filter this `ClassInfoList` to include only implemented interfaces, i.e.
`ClassInfoList`	`getInterfaces()`	Filter this `ClassInfoList` to include only interfaces that are not annotations.
`ClassInfoList`	`getInterfacesAndAnnotations()`	Filter this `ClassInfoList` to include only interfaces and annotations (annotations are interfaces, and can be implemented).
`List<String>`	`getNames()`	Get the names of all classes in this list.
`ClassInfoList`	`getStandardClasses()`	Filter this `ClassInfoList` to include only standard classes (classes that are not interfaces or annotations).
`int`	`indexOf(Object o)`
`ClassInfoList`	`intersect(ClassInfoList... others)`	Find the intersection of this `ClassInfoList` with one or more others.
`boolean`	`isEmpty()`
`Iterator<ClassInfo>`	`iterator()`
`int`	`lastIndexOf(Object o)`
`ListIterator<ClassInfo>`	`listIterator()`
`ListIterator<ClassInfo>`	`listIterator(int index)`
`List<Class<?>>`	`loadClasses()`	Convert this list of `ClassInfo` objects to a list of `Class<?>` objects.
`List<Class<?>>`	`loadClasses(boolean ignoreExceptions)`	Convert this list of `ClassInfo` objects to a list of `Class<?>` objects.
`<T> List<Class<T>>`	`loadClasses(Class<T> superclassOrInterfaceType)`	Convert this list of `ClassInfo` objects to a list of `Class<?>` objects, casting each item in the list to the requested superclass or interface type.
`<T> List<Class<T>>`	`loadClasses(Class<T> superclassOrInterfaceType, boolean ignoreExceptions)`	Convert this list of `ClassInfo` objects to a list of `Class<?>` objects, casting each item in the list to the requested superclass or interface type.
`ClassInfo`	`remove(int index)`
`boolean`	`remove(Object o)`
`boolean`	`removeAll(Collection<?> c)`
`boolean`	`retainAll(Collection<?> c)`
`ClassInfo`	`set(int index, ClassInfo element)`
`int`	`size()`
`List<ClassInfo>`	`subList(int fromIndex, int toIndex)`
`Object[]`	`toArray()`
`<T> T[]`	`toArray(T[] a)`
`String`	`toString()`
`ClassInfoList`	`union(ClassInfoList... others)`	Find the union of this `ClassInfoList` with one or more others.

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface java.util.List
equals, hashCode, replaceAll, sort, spliterator

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

- Method Detail
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<ClassInfo>
    
    Specified by:
    
    size in interface List<ClassInfo>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<ClassInfo>
    
    Specified by:
    
    isEmpty in interface List<ClassInfo>
  - get
```
public ClassInfo get(int index)
```
    Specified by:
    
    get in interface List<ClassInfo>
  - contains
```
public boolean contains(Object o)
```
    Specified by:
    
    contains in interface Collection<ClassInfo>
    
    Specified by:
    
    contains in interface List<ClassInfo>
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    Specified by:
    
    containsAll in interface Collection<ClassInfo>
    
    Specified by:
    
    containsAll in interface List<ClassInfo>
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<ClassInfo>
    
    Specified by:
    
    toArray in interface List<ClassInfo>
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Specified by:
    
    toArray in interface Collection<ClassInfo>
    
    Specified by:
    
    toArray in interface List<ClassInfo>
  - indexOf
```
public int indexOf(Object o)
```
    Specified by:
    
    indexOf in interface List<ClassInfo>
  - lastIndexOf
```
public int lastIndexOf(Object o)
```
    Specified by:
    
    lastIndexOf in interface List<ClassInfo>
  - iterator
```
public Iterator<ClassInfo> iterator()
```
    Specified by:
    
    iterator in interface Collection<ClassInfo>
    
    Specified by:
    
    iterator in interface Iterable<ClassInfo>
    
    Specified by:
    
    iterator in interface List<ClassInfo>
  - listIterator
```
public ListIterator<ClassInfo> listIterator()
```
    Specified by:
    
    listIterator in interface List<ClassInfo>
  - listIterator
```
public ListIterator<ClassInfo> listIterator(int index)
```
    Specified by:
    
    listIterator in interface List<ClassInfo>
  - subList
```
public List<ClassInfo> subList(int fromIndex,
                               int toIndex)
```
    Specified by:
    
    subList in interface List<ClassInfo>
  - add
```
public boolean add(ClassInfo e)
```
    Specified by:
    
    add in interface Collection<ClassInfo>
    
    Specified by:
    
    add in interface List<ClassInfo>
  - add
```
public void add(int index,
                ClassInfo element)
```
    Specified by:
    
    add in interface List<ClassInfo>
  - remove
```
public boolean remove(Object o)
```
    Specified by:
    
    remove in interface Collection<ClassInfo>
    
    Specified by:
    
    remove in interface List<ClassInfo>
  - remove
```
public ClassInfo remove(int index)
```
    Specified by:
    
    remove in interface List<ClassInfo>
  - addAll
```
public boolean addAll(Collection<? extends ClassInfo> c)
```
    Specified by:
    
    addAll in interface Collection<ClassInfo>
    
    Specified by:
    
    addAll in interface List<ClassInfo>
  - addAll
```
public boolean addAll(int index,
                      Collection<? extends ClassInfo> c)
```
    Specified by:
    
    addAll in interface List<ClassInfo>
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Specified by:
    
    removeAll in interface Collection<ClassInfo>
    
    Specified by:
    
    removeAll in interface List<ClassInfo>
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Specified by:
    
    retainAll in interface Collection<ClassInfo>
    
    Specified by:
    
    retainAll in interface List<ClassInfo>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<ClassInfo>
    
    Specified by:
    
    clear in interface List<ClassInfo>
  - set
```
public ClassInfo set(int index,
                     ClassInfo element)
```
    Specified by:
    
    set in interface List<ClassInfo>
  - loadClasses
```
public <T> List<Class<T>> loadClasses(Class<T> superclassOrInterfaceType,
                                      boolean ignoreExceptions)
```
    Convert this list of ClassInfo objects to a list of Class<?> objects, casting each item in the list to the requested superclass or interface type. Causes the classloader to load the class named by each ClassInfo object, if it is not already loaded.
    Important note: since superclassOrInterfaceType is a class reference for an already-loaded class, it is critical that superclassOrInterfaceType is loaded by the same classloader as the class referred to by this ClassInfo object, otherwise the class cast will fail.
    
    Parameters:
    
    superclassOrInterfaceType - The type to cast each loaded class to.
    
    ignoreExceptions - If true, ignore any exceptions or errors thrown during classloading, or when attempting to cast the resulting Class<?> reference to the requested type. If an exception or error is thrown, no Class<?> reference is added to the output class for the corresponding ClassInfo object, so the returned list may contain fewer items than this input list. If false, IllegalArgumentException is thrown if the class could not be loaded or cast to the requested type.
    
    Returns:
    
    The loaded Class<?> objects corresponding to each ClassInfo object in this list.
    
    Throws:
    
    IllegalArgumentException - if ignoreExceptions is false and an exception or error was thrown while trying to load or cast any of the classes.
  - loadClasses
```
public <T> List<Class<T>> loadClasses(Class<T> superclassOrInterfaceType)
```
    Convert this list of ClassInfo objects to a list of Class<?> objects, casting each item in the list to the requested superclass or interface type. Causes the classloader to load the class named by each ClassInfo object, if it is not already loaded.
    Important note: since superclassOrInterfaceType is a class reference for an already-loaded class, it is critical that superclassOrInterfaceType is loaded by the same classloader as the class referred to by this ClassInfo object, otherwise the class cast will fail.
    
    Parameters:
    
    superclassOrInterfaceType - The type to cast each loaded class to.
    
    Returns:
    
    The loaded Class<?> objects corresponding to each ClassInfo object in this list.
    
    Throws:
    
    IllegalArgumentException - if an exception or error was thrown while trying to load or cast any of the classes.
  - loadClasses
```
public List<Class<?>> loadClasses(boolean ignoreExceptions)
```
    Convert this list of ClassInfo objects to a list of Class<?> objects. Causes the classloader to load the class named by each ClassInfo object, if it is not already loaded.
    
    Parameters:
    
    ignoreExceptions - If true, ignore any exceptions or errors thrown during classloading. If an exception or error is thrown during classloading, no Class<?> reference is added to the output class for the corresponding ClassInfo object, so the returned list may contain fewer items than this input list. If false, IllegalArgumentException is thrown if the class could not be loaded.
    
    Returns:
    
    The loaded Class<?> objects corresponding to each ClassInfo object in this list.
    
    Throws:
    
    IllegalArgumentException - if ignoreExceptions is false and an exception or error was thrown while trying to load any of the classes.
  - loadClasses
```
public List<Class<?>> loadClasses()
```
    Convert this list of ClassInfo objects to a list of Class<?> objects. Causes the classloader to load the class named by each ClassInfo object, if it is not already loaded.
    
    Returns:
    
    The loaded Class<?> objects corresponding to each ClassInfo object in this list.
    
    Throws:
    
    IllegalArgumentException - if an exception or error was thrown while trying to load any of the classes.
  - getNames
```
public List<String> getNames()
```
    Get the names of all classes in this list.
  - getAsStrings
```
public List<String> getAsStrings()
```
    Get the string representations of all classes in this list (with annotations, modifiers, etc.), by calling ClassInfo.toString() on each item in the list.
  - containsName
```
public boolean containsName(String className)
```
    Return true if this ClassInfo list contains a class with the given name.
  - get
```
public ClassInfo get(String name)
```
    Return the ClassInfo object in the list with the given name, or null if not found.
  - directOnly
```
public ClassInfoList directOnly()
```
    Get the list of classes that were directly related, as opposed to reachable through multiple steps. For example, if this ClassInfoList was produced by querying for all superclasses of a given class, then directOnly() will return only the direct superclass of this class.
    
    Returns:
    
    The list of directly-related classes.
  - union
```
public ClassInfoList union(ClassInfoList... others)
```
    Find the union of this ClassInfoList with one or more others.
    
    Parameters:
    
    others - The other ClassInfoLists to union with this one.
    
    Returns:
    
    The union of this ClassInfoList with the others.
  - intersect
```
public ClassInfoList intersect(ClassInfoList... others)
```
    Find the intersection of this ClassInfoList with one or more others.
    
    Parameters:
    
    others - The other ClassInfoLists to intersect with this one.
    
    Returns:
    
    The intersection of this ClassInfoList with the others.
  - exclude
```
public ClassInfoList exclude(ClassInfoList other)
```
    Find the set difference between this ClassInfoList and another ClassInfoList, i.e. (this \ other).
    
    Parameters:
    
    other - The other ClassInfoList to subtract from this one.
    
    Returns:
    
    The set difference of this ClassInfoList and other, i.e. (this \ other).
  - filter
```
public ClassInfoList filter(ClassInfoList.ClassInfoFilter filter)
```
    Find the set difference between this ClassInfoList and another ClassInfoList, i.e. (this \ other).
    
    Parameters:
    
    filter - The ClassInfoList.ClassInfoFilter to apply.
    
    Returns:
    
    The set difference of this ClassInfoList and other, i.e. (this \ other).
  - getStandardClasses
```
public ClassInfoList getStandardClasses()
```
    Filter this ClassInfoList to include only standard classes (classes that are not interfaces or annotations).
    
    Returns:
    
    The filtered list, containing only standard classes.
  - getInterfaces
```
public ClassInfoList getInterfaces()
```
    Filter this ClassInfoList to include only interfaces that are not annotations. See also getInterfacesAndAnnotations().
    
    Returns:
    
    The filtered list, containing only interfaces.
  - getInterfacesAndAnnotations
```
public ClassInfoList getInterfacesAndAnnotations()
```
    Filter this ClassInfoList to include only interfaces and annotations (annotations are interfaces, and can be implemented). See also getInterfaces().
    
    Returns:
    
    The filtered list, containing only interfaces.
  - getImplementedInterfaces
```
public ClassInfoList getImplementedInterfaces()
```
    Filter this ClassInfoList to include only implemented interfaces, i.e. non-annotation interfaces, or annotations that have been implemented by a class.
    
    Returns:
    
    The filtered list, containing only implemented interfaces.
  - getAnnotations
```
public ClassInfoList getAnnotations()
```
    Filter this ClassInfoList to include only annotations.
    
    Returns:
    
    The filtered list, containing only annotations.
  - getEnums
```
public ClassInfoList getEnums()
```
    Filter this ClassInfoList to include only Enum classes.
    
    Returns:
    
    The filtered list, containing only enums.
  - generateGraphVizDotFile
```
public String generateGraphVizDotFile(float sizeX,
                                      float sizeY,
                                      boolean showFields,
                                      boolean showMethods,
                                      boolean showAnnotations)
```
    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.
    Note that if you call this with showFields or showMethods set to false, but with method and/or field info enabled during scanning, then arrows will still be added between classes even if the field or method that created that dependency is not shown.
    
    Parameters:
    
    sizeX - The GraphViz layout width in inches.
    
    sizeY - The GraphViz layout width in inches.
    
    showFields - If true, show fields within class nodes in the graph. To show fields, FastClasspathScanner.enableFieldInfo() must be called before scanning. You may also want to call FastClasspathScanner.ignoreFieldVisibility() before scanning, to show non-public fields.
    
    showMethods - If true, show methods within class nodes in the graph. To show methods, FastClasspathScanner.enableMethodInfo() must be called before scanning. You may also want to call FastClasspathScanner.ignoreMethodVisibility() before scanning, to show non-public methods.
    
    showAnnotations - If true, show annotations in the graph. To show annotations, FastClasspathScanner.enableAnnotationInfo() must be called before scanning. You may also want to call FastClasspathScanner.ignoreClassVisibility() before scanning, to show non-public classes (including non-public annotation classes).
    
    Returns:
    
    the GraphViz file contents.
  - generateGraphVizDotFile
```
public String generateGraphVizDotFile(float sizeX,
                                      float sizeY)
```
    Generate a .dot file which can be fed into GraphViz for layout and visualization of the class graph.
    Methods, fields and annotations are shown if enabled, via FastClasspathScanner.enableMethodInfo(), FastClasspathScanner.enableFieldInfo() and FastClasspathScanner.enableAnnotationInfo().
    Only public classes, methods, and fields are shown, unless FastClasspathScanner.ignoreClassVisibility(), FastClasspathScanner.ignoreMethodVisibility(), and/or FastClasspathScanner.ignoreFieldVisibility() has/have been called.
    
    Parameters:
    
    sizeX - The GraphViz layout width in inches.
    
    sizeY - The GraphViz layout width in inches.
    
    Returns:
    
    the GraphViz file contents.
  - generateGraphVizDotFile
```
public String generateGraphVizDotFile()
```
    Generate a .dot file which can be fed into GraphViz for layout and visualization of the class graph.
    Methods, fields and annotations are shown if enabled, via FastClasspathScanner.enableMethodInfo(), FastClasspathScanner.enableFieldInfo() and FastClasspathScanner.enableAnnotationInfo().
    Only public classes, methods, and fields are shown, unless FastClasspathScanner.ignoreClassVisibility(), FastClasspathScanner.ignoreMethodVisibility(), and/or FastClasspathScanner.ignoreFieldVisibility() has/have been called.
    
    Returns:
    
    the GraphViz file contents.
  - generateGraphVizDotFile
```
public void generateGraphVizDotFile(File file)
                             throws IOException
```
    Generate a and save a .dot file, which can be fed into GraphViz for layout and visualization of the class graph.
    Methods, fields and annotations are shown if enabled, via FastClasspathScanner.enableMethodInfo(), FastClasspathScanner.enableFieldInfo() and FastClasspathScanner.enableAnnotationInfo().
    Only public classes, methods, and fields are shown, unless FastClasspathScanner.ignoreClassVisibility(), FastClasspathScanner.ignoreMethodVisibility(), and/or FastClasspathScanner.ignoreFieldVisibility() has/have been called.
    
    Parameters:
    
    file - the file to save the GraphViz .dot file to.
    
    Throws:
    
    IOException - if the file could not be saved.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ClassInfoList

Nested Class Summary

Method Summary

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.List

Methods inherited from class java.lang.Object

Method Detail

size

isEmpty

get

contains

containsAll

toArray

toArray

indexOf

lastIndexOf

iterator

listIterator

listIterator

subList

add

add

remove

remove

addAll

addAll

removeAll

retainAll

clear

set

loadClasses

loadClasses

loadClasses

loadClasses

getNames

getAsStrings

containsName

get

directOnly

union

intersect

exclude

filter

getStandardClasses

getInterfaces

getInterfacesAndAnnotations

getImplementedInterfaces

getAnnotations

getEnums

generateGraphVizDotFile

generateGraphVizDotFile

generateGraphVizDotFile

generateGraphVizDotFile

toString