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:ClassInfoList

The list of directly-related classes.

Return an unmodifiable empty ClassInfoList.

Returns:ClassInfoList

the unmodifiable empty ClassInfoList.

Overrides io.github.classgraph.InfoList.equals.

Implements java.util.List.equals, java.util.Collection.equals.

Doc from java.util.ArrayList.equals.

Compares the specified object with this list for equality. Returns true if and only if the specified object is also a list, both lists have the same size, and all corresponding pairs of elements in the two lists are equal. (Two elements e1 and e2 are equal if Objects.equals(e1, e2).) In other words, two lists are defined to be equal if they contain the same elements in the same order. This definition ensures that the equals method works properly across different implementations of the List interface.

Parameters

obj:Object

Doc from java.util.List.equals.

the object to be compared for equality with this list

Returns:boolean

Doc from java.util.List.equals.

true if the specified object is equal to this list

Annotations

@Override

Find the set difference between this ClassInfoList and another ClassInfoList, i.e. (this \ other).

Parameters

other:ClassInfoList

The other ClassInfoList to subtract from this one.

Returns:ClassInfoList

The set difference of this ClassInfoList and other, i.e. (this \ other).

Find the subset of this ClassInfoList for which the given filter predicate is true.

Parameters

filter:ClassInfoList.ClassInfoFilter

The ClassInfoFilter to apply.

Returns:ClassInfoList

The subset of this ClassInfoList for which the given filter predicate is true.

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.

To show non-public classes, call ClassGraph#ignoreClassVisibility() before scanning.

To show fields, call ClassGraph#enableFieldInfo() before scanning. To show non-public fields, also call ClassGraph#ignoreFieldVisibility() before scanning.

To show methods, call ClassGraph#enableMethodInfo() before scanning. To show non-public methods, also call ClassGraph#ignoreMethodVisibility() before scanning.

To show annotations, call ClassGraph#enableAnnotationInfo() before scanning. To show non-public annotations, also call ClassGraph#ignoreFieldVisibility() before scanning (there is no separate visibility modifier for annotations).

Parameters

sizeX:float

The GraphViz layout width in inches.

sizeY:float

The GraphViz layout width in inches.

showFields:boolean

If true, show fields within class nodes in the graph.

showFieldTypeDependencyEdges:boolean

If true, show edges between classes and the types of their fields.

showMethods:boolean

If true, show methods within class nodes in the graph.

showMethodTypeDependencyEdges:boolean

If true, show edges between classes and the return types and/or parameter types of their methods.

showAnnotations:boolean

If true, show annotations in the graph.

useSimpleNames:boolean

whether to use simple names for classes in type signatures (if true, the package name is stripped from class names in method and field type signatures).

Returns:String

the GraphViz file contents.

Exceptions

IllegalArgumentException:

if this ClassInfoList is empty or ClassGraph#enableClassInfo() was not called before scanning (since there would be nothing to graph).

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.

To show non-public classes, call ClassGraph#ignoreClassVisibility() before scanning.

To show fields, call ClassGraph#enableFieldInfo() before scanning. To show non-public fields, also call ClassGraph#ignoreFieldVisibility() before scanning.

To show methods, call ClassGraph#enableMethodInfo() before scanning. To show non-public methods, also call ClassGraph#ignoreMethodVisibility() before scanning.

To show annotations, call ClassGraph#enableAnnotationInfo() before scanning. To show non-public annotations, also call ClassGraph#ignoreFieldVisibility() before scanning (there is no separate visibility modifier for annotations).

This method uses simple names for class names in type signatures of fields and methods (package names are stripped).

Parameters

sizeX:float

The GraphViz layout width in inches.

sizeY:float

The GraphViz layout width in inches.

showFields:boolean

If true, show fields within class nodes in the graph.

showFieldTypeDependencyEdges:boolean

If true, show edges between classes and the types of their fields.

showMethods:boolean

If true, show methods within class nodes in the graph.

showMethodTypeDependencyEdges:boolean

If true, show edges between classes and the return types and/or parameter types of their methods.

showAnnotations:boolean

If true, show annotations in the graph.

Returns:String

the GraphViz file contents.

Exceptions

IllegalArgumentException:

if this ClassInfoList is empty or ClassGraph#enableClassInfo() was not called before scanning (since there would be nothing to graph).

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 ClassGraph#enableMethodInfo(), ClassGraph#enableFieldInfo() and ClassGraph#enableAnnotationInfo().

Only public classes, methods, and fields are shown, unless ClassGraph#ignoreClassVisibility(), ClassGraph#ignoreMethodVisibility(), and/or ClassGraph#ignoreFieldVisibility() has/have been called.

Parameters

sizeX:float

The GraphViz layout width in inches.

sizeY:float

The GraphViz layout width in inches.

Returns:String

the GraphViz file contents.

Exceptions

IllegalArgumentException:

if this ClassInfoList is empty or ClassGraph#enableClassInfo() was not called before scanning (since there would be nothing to graph).

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 ClassGraph#enableMethodInfo(), ClassGraph#enableFieldInfo() and ClassGraph#enableAnnotationInfo().

Only public classes, methods, and fields are shown, unless ClassGraph#ignoreClassVisibility(), ClassGraph#ignoreMethodVisibility(), and/or ClassGraph#ignoreFieldVisibility() has/have been called.

Returns:String

the GraphViz file contents.

Exceptions

IllegalArgumentException:

if this ClassInfoList is empty or ClassGraph#enableClassInfo() was not called before scanning (since there would be nothing to graph).

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 ClassGraph#enableMethodInfo(), ClassGraph#enableFieldInfo() and ClassGraph#enableAnnotationInfo().

Only public classes, methods, and fields are shown, unless ClassGraph#ignoreClassVisibility(), ClassGraph#ignoreMethodVisibility(), and/or ClassGraph#ignoreFieldVisibility() has/have been called.

Parameters

file:File

the file to save the GraphViz .dot file to.

Exceptions

IOException:

if the file could not be saved.

IllegalArgumentException:

if this ClassInfoList is empty or ClassGraph#enableClassInfo() was not called before scanning (since there would be nothing to graph).

Deprecated: use generateGraphVizDotFileFromInterClassDependencies() instead.

Returns:String

the GraphViz file contents.

Annotations

@Deprecated

Exceptions

IllegalArgumentException:

if this ClassInfoList is empty or ClassGraph#enableInterClassDependencies() was not called before scanning (since there would be nothing to graph).

Generate a .dot file which can be fed into GraphViz for layout and visualization of the class graph. The returned graph shows inter-class dependencies only. The sizeX and sizeY parameters are the image output size to use (in inches) when GraphViz is asked to render the .dot file. You must have called ClassGraph#enableInterClassDependencies() before scanning to use this method.

Parameters

sizeX:float

The GraphViz layout width in inches.

sizeY:float

The GraphViz layout width in inches.

includeExternalClasses:boolean

If true, and if ClassGraph#enableExternalClasses() was called before scanning, show "external classes" (non-accepted classes) within the dependency graph.

Returns:String

the GraphViz file contents.

Exceptions

IllegalArgumentException:

if this ClassInfoList is empty or ClassGraph#enableInterClassDependencies() was not called before scanning (since there would be nothing to graph).

Generate a .dot file which can be fed into GraphViz for layout and visualization of the class graph. The returned graph shows inter-class dependencies only. The sizeX and sizeY parameters are the image output size to use (in inches) when GraphViz is asked to render the .dot file. You must have called ClassGraph#enableInterClassDependencies() before scanning to use this method.

Equivalent to calling generateGraphVizDotFileFromInterClassDependencies(float, float, boolean) with parameters of (10.5f, 8f, scanSpec.enableExternalClasses), where scanSpec.enableExternalClasses is true if ClassGraph#enableExternalClasses() was called before scanning.

Parameters

sizeX:float

The GraphViz layout width in inches.

sizeY:float

The GraphViz layout width in inches.

Returns:String

the GraphViz file contents.

Exceptions

IllegalArgumentException:

if this ClassInfoList is empty or ClassGraph#enableInterClassDependencies() was not called before scanning (since there would be nothing to graph).

Generate a .dot file which can be fed into GraphViz for layout and visualization of the class graph. The returned graph shows inter-class dependencies only. The sizeX and sizeY parameters are the image output size to use (in inches) when GraphViz is asked to render the .dot file. You must have called ClassGraph#enableInterClassDependencies() before scanning to use this method.

Equivalent to calling generateGraphVizDotFileFromInterClassDependencies(float, float, boolean) with parameters of (10.5f, 8f, scanSpec.enableExternalClasses), where scanSpec.enableExternalClasses is true if ClassGraph#enableExternalClasses() was called before scanning.

Returns:String

the GraphViz file contents.

Exceptions

IllegalArgumentException:

if this ClassInfoList is empty or ClassGraph#enableInterClassDependencies() was not called before scanning (since there would be nothing to graph).

Filter this ClassInfoList to include only annotations.

Returns:ClassInfoList

The filtered list, containing only annotations.

Filter this ClassInfoList to include only classes that are assignable to the requested class, assignableToClass (i.e. where assignableToClass is a superclass or implemented interface of the list element).

Parameters

superclassOrInterface:ClassInfo

the superclass or interface to filter for.

Returns:ClassInfoList

The filtered list, containing only classes for which assignableToClassRef.isAssignableFrom(listItemClassRef) is true for the corresponding Class<?> references for assignableToClass and the list items. Returns the empty list if no classes were assignable to the requested class.

Exceptions

IllegalArgumentException:

if classInfo is null.

Filter this ClassInfoList to include only Enum classes.

Returns:ClassInfoList

The filtered list, containing only enums.

Filter this ClassInfoList to include only implemented interfaces, i.e. non-annotation interfaces, or annotations that have been implemented by a class.

Returns:ClassInfoList

The filtered list, containing only implemented interfaces.

Filter this ClassInfoList to include only interfaces that are not annotations. See also getInterfacesAndAnnotations().

Returns:ClassInfoList

The filtered list, containing only interfaces.

Filter this ClassInfoList to include only interfaces and annotations (annotations are interfaces, and can be implemented). See also getInterfaces().

Returns:ClassInfoList

The filtered list, containing only interfaces.

Filter this ClassInfoList to include only record classes.

Returns:ClassInfoList

The filtered list, containing only record classes.

Filter this ClassInfoList to include only standard classes (classes that are not interfaces or annotations).

Returns:ClassInfoList

The filtered list, containing only standard classes.

Overrides io.github.classgraph.InfoList.hashCode.

Implements java.util.List.hashCode, java.util.Collection.hashCode.

Doc from java.util.ArrayList.hashCode.

Returns the hash code value for this list. The hash code of a list is defined to be the result of the following calculation:

int hashCode = 1;
    for (E e : list)
        hashCode = 31*hashCode + (e==null ? 0 : e.hashCode());

Returns:int

Doc from java.util.List.hashCode.

the hash code value for this list

Annotations

@Override

Find the intersection of this ClassInfoList with one or more others.

Parameters

others:ClassInfoList[]

The other ClassInfoLists to intersect with this one.

Returns:ClassInfoList

The intersection of this ClassInfoList with the others.

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.

Parameters

<T>

The superclass or interface.

superclassOrInterfaceType:Class<T>

The superclass or interface class reference to cast each loaded class to.

ignoreExceptions:boolean

If true, ignore any exceptions or errors thrown during classloading, or when attempting to cast the resulting Class<?> reference to the requested type -- instead, skip the element (i.e. the returned list may contain fewer items than this input list). If false, IllegalArgumentException is thrown if the class could not be loaded or could not be cast to the requested type.

Returns:List<Class<T>>

The loaded Class<?> objects corresponding to each ClassInfo object in this list.

Exceptions

IllegalArgumentException:

if ignoreExceptions is false and an exception or error was thrown while trying to load or cast any of the classes.

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.

Parameters

<T>

The superclass or interface.

superclassOrInterfaceType:Class<T>

The superclass or interface class reference to cast each loaded class to.

Returns:List<Class<T>>

The loaded Class<?> objects corresponding to each ClassInfo object in this list.

Exceptions

IllegalArgumentException:

if an exception or error was thrown while trying to load or cast any of the classes.

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:boolean

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:List<Class<?>>

The loaded Class<?> objects corresponding to each ClassInfo object in this list.

Exceptions

IllegalArgumentException:

if ignoreExceptions is false and an exception or error was thrown while trying to load any of the classes.

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:List<Class<?>>

The loaded Class<?> objects corresponding to each ClassInfo object in this list.

Exceptions

IllegalArgumentException:

if an exception or error was thrown while trying to load any of the classes.

Find the union of this ClassInfoList with one or more others.

Parameters

others:ClassInfoList[]

The other ClassInfoLists to union with this one.

Returns:ClassInfoList

The union of this ClassInfoList with the others.