| Modifier and Type | Method and Description |
|---|---|
| public Collection | Returns: All known implementors of the interfaceThe interface interfaceName)Returns all known classes that implement the given interface, directly and indirectly. |
| public default Collection | Returns: All known implementors of the interfaceThe interface interfaceName)Returns all known classes that implement the given interface, directly and indirectly. |
| public default Collection | Returns: All known implementors of the interfaceThe interface interfaceClass)Returns all known classes that implement the given interface, directly and indirectly. |
| public Collection | Returns: All known subclassesThe class className)Returns all known (including non-direct) subclasses of the given class. |
| public default Collection | Returns: All known subclassesThe class className)Returns all known (including non-direct) subclasses of the given class. |
| public default Collection | Returns: All known subclassesThe class clazz)Returns all known (including non-direct) subclasses of the given class. |
| public Collection | Returns: all known subinterfacesThe interace interfaceName)Returns all known interfaces that extend the given interface, directly and indirectly. |
| public default Collection | Returns: all known subinterfacesThe interace interfaceName)Returns all known interfaces that extend the given interface, directly and indirectly. |
| public default Collection | Returns: all known subinterfacesThe interace iface)Returns all known interfaces that extend the given interface, directly and indirectly. |
| public Collection | Returns: a non-null list of annotation instancesthe name of the annotation to look for annotationName)Obtains a list of instances for the specified annotation. |
| public default Collection | Returns: a non-null list of annotation instancesthe name of the annotation to look for annotationName)Obtains a list of instances for the specified annotation. |
| public default Collection | Returns: a non-null list of annotation instancesthe type of the annotation to look for annotationType)Obtains a list of instances for the specified annotation. |
| public Collection | Returns: a non-null list of annotation instancesthe name of the repeatable annotation annotationName, IndexView the index containing the annotation class index)Obtains a list of instances for the specified annotation. |
| public default Collection | Returns: a non-null list of annotation instancesthe name of the repeatable annotation annotationName, IndexView the index containing the annotation class index)Obtains a list of instances for the specified annotation. |
| public default Collection | Returns: a non-null list of annotation instancesthe name of the repeatable annotation annotationType, IndexView the index containing the annotation class index)Obtains a list of instances for the specified annotation. |
| public ClassInfo | Returns: information about the class or null if it is not knownthe name of the class className)Gets the class (or interface, or annotation) that was scanned during the indexing phase. |
| public default ClassInfo | Returns: information about the class or null if it is not knownthe name of the class className)Gets the class (or interface, or annotation) that was scanned during the indexing phase. |
| public default ClassInfo | Returns: information about the class or null if it is not knownthe class clazz)Gets the class (or interface, or annotation) that was scanned during the indexing phase. |
| public Collection | Returns: immutable collection of classes present in given package, nevernullpackage name in the common, dot-separated form (e.g. packageName)com.example.foobar);
null means the unnamed packageReturns all classes known to this index that are present in given package. |
| public default Collection | Returns: immutable collection of classes present in given package, nevernullpackage name in the common, dot-separated form (e.g. packageName)com.example.foobar);
null means the unnamed packageReturns all classes known to this index that are present in given package. |
| public Collection | Returns: a collection of known classesGets all known classes by this index (those which were scanned). |
| public Collection | Returns: a non-null list of all known subclasses of classNamethe super class of the desired subclasses className)Gets all known direct implementors of the specified interface. |
| public default Collection | Returns: a non-null list of all known subclasses of classNamethe super class of the desired subclasses className)Gets all known direct implementors of the specified interface name. |
| public default Collection | Returns: a non-null list of all known subclasses of classNamethe super class of the desired subclasses clazz)Gets all known direct implementors of the specified interface name. |
| public Collection | Returns: a non-null list of all known subclasses of classNamethe super class of the desired subclasses className)Gets all known direct subclasses of the specified class. |
| public default Collection | Returns: a non-null list of all known subclasses of classNamethe super class of the desired subclasses className)Gets all known direct subclasses of the specified class. |
| public default Collection | Returns: a non-null list of all known subclasses of classNamethe super class of the desired subclasses clazz)Gets all known direct subclasses of the specified class. |
| public Collection | Returns: a non-null list of all known subinterfaces of interfaceNamethe super interface of the desired subinterfaces interfaceName)Gets all known direct subinterfaces of the specified interface. |
| public default Collection | Returns: a non-null list of all known subinterfaces of interfaceNamethe super interface of the desired subinterfaces interfaceName)Gets all known direct subinterfaces of the specified interface. |
| public default Collection | Returns: a non-null list of all known subinterfaces of ifacethe super interface of the desired subinterfaces iface)Gets all known direct subinterfaces of the specified interface. |
| public Collection | Returns: a collection of known modulesGets all known modules by this index (those which were scanned). |
| public Collection | Returns: a non-null list of classes that use the specified classthe name of the class to look for className)Obtains a list of classes that use the specified class. |
| public default Collection | Returns: a non-null list of classes that use the specified classthe name of the class to look for className)Obtains a list of classes that use the specified class. |
| public default Collection | Returns: a non-null list of classes that use the specified classthe class to look for clazz)Obtains a list of classes that use the specified class. |
| public ModuleInfo | Returns: information about the module or null if it is not knownthe name of the module moduleName)Gets the module that was scanned during the indexing phase. |
| public default ModuleInfo | Returns: information about the module or null if it is not knownthe name of the module moduleName)Gets the module that was scanned during the indexing phase. |
| public Set | Returns: immutable set of subpackages of given package, nevernullpackage name in the common, dot-separated form (e.g. packageName)com.example.foobar);
null means the unnamed packageReturns a set of packages known to this index that are direct subpackages of given package. |
| public default Set | Returns: immutable set of subpackages of given package, nevernullpackage name in the common, dot-separated form (e.g. packageName)com.example.foobar);
null means the unnamed packageReturns a set of packages known to this index that are direct subpackages of given package. |
| getAllKnownImplementors | back to summary |
|---|---|
| public Collection Returns all known classes that implement the given interface, directly and indirectly. This will return all classes that implement the interface and its subinterfaces, as well as subclasses of classes that implement the interface and its subinterfaces. (In short, it will return every class in the index that is assignable to the interface.)
Note that this method only returns classes. Unlike
| |
| getAllKnownImplementors | back to summary |
|---|---|
| public default Collection Returns all known classes that implement the given interface, directly and indirectly. This will return all classes that implement the interface and its subinterfaces, as well as subclasses of classes that implement the interface and its subinterfaces. (In short, it will return every class in the index that is assignable to the interface.)
Note that this method only returns classes. Unlike
| |
| getAllKnownImplementors | back to summary |
|---|---|
| public default Collection Returns all known classes that implement the given interface, directly and indirectly. This will return all classes that implement the interface and its subinterfaces, as well as subclasses of classes that implement the interface and its subinterfaces. (In short, it will return every class in the index that is assignable to the interface.)
Note that this method only returns classes. Unlike
| |
| getAllKnownSubclasses | back to summary |
|---|---|
| public Collection Returns all known (including non-direct) subclasses of the given class. I.e., returns all known classes that are assignable to the given class.
| |
| getAllKnownSubclasses | back to summary |
|---|---|
| public default Collection Returns all known (including non-direct) subclasses of the given class. I.e., returns all known classes that are assignable to the given class.
| |
| getAllKnownSubclasses | back to summary |
|---|---|
| public default Collection Returns all known (including non-direct) subclasses of the given class. I.e., returns all known classes that are assignable to the given class.
| |
| getAllKnownSubinterfaces | back to summary |
|---|---|
| public Collection Returns all known interfaces that extend the given interface, directly and indirectly. I.e., returns every interface in the index that is assignable to the given interface.
| |
| getAllKnownSubinterfaces | back to summary |
|---|---|
| public default Collection Returns all known interfaces that extend the given interface, directly and indirectly. I.e., returns every interface in the index that is assignable to the given interface.
| |
| getAllKnownSubinterfaces | back to summary |
|---|---|
| public default Collection Returns all known interfaces that extend the given interface, directly and indirectly. I.e., returns every interface in the index that is assignable to the given interface.
| |
| getAnnotations | back to summary |
|---|---|
| public Collection Obtains a list of instances for the specified annotation. This is done using an O(1) lookup. Valid instance targets include field, method, parameter, and class.
| |
| getAnnotations | back to summary |
|---|---|
| public default Collection Obtains a list of instances for the specified annotation. This is done using an O(1) lookup. Valid instance targets include field, method, parameter, and class.
| |
| getAnnotations | back to summary |
|---|---|
| public default Collection Obtains a list of instances for the specified annotation. This is done using an O(1) lookup. Valid instance targets include field, method, parameter, and class.
| |
| getAnnotationsWithRepeatable | back to summary |
|---|---|
| public Collection Obtains a list of instances for the specified annotation. If the specified annotation is repeatable (JLS 9.6), the result
also contains all values from all instances of the container annotation. In this case, the
| |
| getAnnotationsWithRepeatable | back to summary |
|---|---|
| public default Collection Obtains a list of instances for the specified annotation. If the specified annotation is repeatable (JLS 9.6), the result
also contains all values from all instances of the container annotation. In this case, the
| |
| getAnnotationsWithRepeatable | back to summary |
|---|---|
| public default Collection Obtains a list of instances for the specified annotation. If the specified annotation is repeatable (JLS 9.6), the result
also contains all values from all instances of the container annotation. In this case, the
| |
| getClassByName | back to summary |
|---|---|
| public ClassInfo getClassByName(DotName className) Gets the class (or interface, or annotation) that was scanned during the indexing phase. | |
| getClassByName | back to summary |
|---|---|
| public default ClassInfo getClassByName(String className) Gets the class (or interface, or annotation) that was scanned during the indexing phase. | |
| getClassByName | back to summary |
|---|---|
| public default ClassInfo getClassByName(Class<?> clazz) Gets the class (or interface, or annotation) that was scanned during the indexing phase. | |
| getClassesInPackage | back to summary |
|---|---|
| public Collection Returns all classes known to this index that are present in given package.
Classes present in subpackages of given package are not returned. Classes present in the unnamed
package may be looked up using
In the default
| |
| getClassesInPackage | back to summary |
|---|---|
| public default Collection Returns all classes known to this index that are present in given package.
Classes present in subpackages of given package are not returned. Classes present in the unnamed
package may be looked up using
In the default
| |
| getKnownClasses | back to summary |
|---|---|
| public Collection Gets all known classes by this index (those which were scanned).
| |
| getKnownDirectImplementors | back to summary |
|---|---|
| public Collection Gets all known direct implementors of the specified interface. A known direct implementor is one which was found during the scanning process; however, this is often not the complete universe of implementors, since typically indexes are constructed per jar. It is expected that several indexes will need to be searched when analyzing a jar that is a part of a complex multi-module/classloader environment (like an EE application server).
The list of implementors also includes direct subinterfaces. This is inconsistent
with Note that this will only pick up classes that directly implement given interface. It will not pick up classes implementing subinterfaces.
| |
| getKnownDirectImplementors | back to summary |
|---|---|
| public default Collection Gets all known direct implementors of the specified interface name. A known direct implementor is one which was found during the scanning process; however, this is often not the complete universe of implementors, since typically indexes are constructed per jar. It is expected that several indexes will need to be searched when analyzing a jar that is a part of a complex multi-module/classloader environment (like an EE application server).
The list of implementors also includes direct subinterfaces. This is inconsistent
with Note that this will only pick up classes that directly implement given interface. It will not pick up classes implementing subinterfaces.
| |
| getKnownDirectImplementors | back to summary |
|---|---|
| public default Collection Gets all known direct implementors of the specified interface name. A known direct implementor is one which was found during the scanning process; however, this is often not the complete universe of implementors, since typically indexes are constructed per jar. It is expected that several indexes will need to be searched when analyzing a jar that is a part of a complex multi-module/classloader environment (like an EE application server).
The list of implementors also includes direct subinterfaces. This is inconsistent
with Note that this will only pick up classes that directly implement given interface. It will not pick up classes implementing subinterfaces.
| |
| getKnownDirectSubclasses | back to summary |
|---|---|
| public Collection Gets all known direct subclasses of the specified class. A known direct subclass is one which was found during the scanning process; however, this is often not the complete universe of subclasses, since typically indexes are constructed per jar. It is expected that several indexes will need to be searched when analyzing a jar that is a part of a complex multi-module/classloader environment (like an EE application server). Note that this will only pick up direct subclasses of the class. It will not pick up subclasses of subclasses.
| |
| getKnownDirectSubclasses | back to summary |
|---|---|
| public default Collection Gets all known direct subclasses of the specified class. A known direct subclass is one which was found during the scanning process; however, this is often not the complete universe of subclasses, since typically indexes are constructed per jar. It is expected that several indexes will need to be searched when analyzing a jar that is a part of a complex multi-module/classloader environment (like an EE application server). Note that this will only pick up direct subclasses of the class. It will not pick up subclasses of subclasses.
| |
| getKnownDirectSubclasses | back to summary |
|---|---|
| public default Collection Gets all known direct subclasses of the specified class. A known direct subclass is one which was found during the scanning process; however, this is often not the complete universe of subclasses, since typically indexes are constructed per jar. It is expected that several indexes will need to be searched when analyzing a jar that is a part of a complex multi-module/classloader environment (like an EE application server). Note that this will only pick up direct subclasses of the class. It will not pick up subclasses of subclasses.
| |
| getKnownDirectSubinterfaces | back to summary |
|---|---|
| public Collection Gets all known direct subinterfaces of the specified interface. A known direct subinterface is one which was found during the scanning process; however, this is often not the complete universe of subinterfaces, since typically indexes are constructed per jar. It is expected that several indexes will need to be searched when analyzing a jar that is a part of a complex multi-module/classloader environment (like an EE application server). Note that this will only pick up direct subinterfaces of the interface. It will not pick up subinterfaces of subinterfaces.
| |
| getKnownDirectSubinterfaces | back to summary |
|---|---|
| public default Collection Gets all known direct subinterfaces of the specified interface. A known direct subinterface is one which was found during the scanning process; however, this is often not the complete universe of subinterfaces, since typically indexes are constructed per jar. It is expected that several indexes will need to be searched when analyzing a jar that is a part of a complex multi-module/classloader environment (like an EE application server). Note that this will only pick up direct subinterfaces of the interface. It will not pick up subinterfaces of subinterfaces.
| |
| getKnownDirectSubinterfaces | back to summary |
|---|---|
| public default Collection Gets all known direct subinterfaces of the specified interface. A known direct subinterface is one which was found during the scanning process; however, this is often not the complete universe of subinterfaces, since typically indexes are constructed per jar. It is expected that several indexes will need to be searched when analyzing a jar that is a part of a complex multi-module/classloader environment (like an EE application server). Note that this will only pick up direct subinterfaces of the interface. It will not pick up subinterfaces of subinterfaces.
| |
| getKnownModules | back to summary |
|---|---|
| public Collection Gets all known modules by this index (those which were scanned).
| |
| getKnownUsers | back to summary |
|---|---|
| public Collection Obtains a list of classes that use the specified class. In other words, a list of classes that include a reference to the specified class in their constant pool.
| |
| getKnownUsers | back to summary |
|---|---|
| public default Collection Obtains a list of classes that use the specified class. In other words, a list of classes that include a reference to the specified class in their constant pool.
| |
| getKnownUsers | back to summary |
|---|---|
| public default Collection Obtains a list of classes that use the specified class. In other words, a list of classes that include a reference to the specified class in their constant pool.
| |
| getModuleByName | back to summary |
|---|---|
| public ModuleInfo getModuleByName(DotName moduleName) Gets the module that was scanned during the indexing phase.
| |
| getModuleByName | back to summary |
|---|---|
| public default ModuleInfo getModuleByName(String moduleName) Gets the module that was scanned during the indexing phase.
| |
| getSubpackages | back to summary |
|---|---|
| public Set Returns a set of packages known to this index that are direct subpackages of given package. Indirect subpackages of given package (subpackages of subpackages) are not returned. If this index does not contain any class in a direct or indirect subpackage of given package, returns an empty collection.
Given that the unnamed package may not contain subpackages, passing
In the default | |
| getSubpackages | back to summary |
|---|---|
| public default Set Returns a set of packages known to this index that are direct subpackages of given package. Indirect subpackages of given package (subpackages of subpackages) are not returned. If this index does not contain any class in a direct or indirect subpackage of given package, returns an empty collection.
Given that the unnamed package may not contain subpackages, passing
In the default | |