Class CompositeIndex
- java.lang.Object
-
- org.jboss.jandex.CompositeIndex
-
- All Implemented Interfaces:
IndexView
public class CompositeIndex extends java.lang.Object implements IndexView
Composite annotation index. Represents an aggregation of multipleIndex
instances. An example application is a Java EE deployment, which can contain multiple nested jars, each with their own index.
-
-
Constructor Summary
Constructors Modifier Constructor Description private
CompositeIndex(java.util.Collection<IndexView> indexes)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CompositeIndex
create(java.util.Collection<IndexView> indexes)
static CompositeIndex
create(IndexView... indexes)
static CompositeIndex
createMerged(CompositeIndex... indexes)
java.util.Set<ClassInfo>
getAllKnownImplementors(DotName interfaceName)
Returns all known classes that implement the given interface, directly and indirectly.java.util.Set<ClassInfo>
getAllKnownSubclasses(DotName className)
Returns all known (including non-direct) subclasses of the given class.private void
getAllKnownSubClasses(DotName className, java.util.Set<ClassInfo> allKnown, java.util.Set<DotName> processedClasses)
private void
getAllKnownSubClasses(DotName name, java.util.Set<ClassInfo> allKnown, java.util.Set<DotName> subClassesToProcess, java.util.Set<DotName> processedClasses)
java.util.Collection<ClassInfo>
getAllKnownSubinterfaces(DotName interfaceName)
Returns all known interfaces that extend the given interface, directly and indirectly.java.util.List<AnnotationInstance>
getAnnotations(DotName annotationName)
Obtains a list of instances for the specified annotation.java.util.Collection<AnnotationInstance>
getAnnotationsWithRepeatable(DotName annotationName, IndexView index)
Obtains a list of instances for the specified annotation.ClassInfo
getClassByName(DotName className)
Gets the class (or interface, or annotation) that was scanned during the indexing phase.java.util.Collection<ClassInfo>
getClassesInPackage(DotName packageName)
Returns all classes known to this index that are present in given package.java.util.Collection<ClassInfo>
getKnownClasses()
Gets all known classes by this index (those which were scanned).java.util.Collection<ClassInfo>
getKnownDirectImplementors(DotName interfaceName)
Gets all known direct implementors of the specified interface.java.util.Set<ClassInfo>
getKnownDirectSubclasses(DotName className)
Gets all known direct subclasses of the specified class.java.util.Collection<ClassInfo>
getKnownDirectSubinterfaces(DotName interfaceName)
Gets all known direct subinterfaces of the specified interface.private void
getKnownImplementors(DotName name, java.util.Set<ClassInfo> allKnown, java.util.Set<DotName> subInterfacesToProcess, java.util.Set<DotName> processedClasses)
java.util.Collection<ModuleInfo>
getKnownModules()
Gets all known modules by this index (those which were scanned).java.util.Collection<ClassInfo>
getKnownUsers(DotName className)
Returns a list of classes in this index that use the specified class.ModuleInfo
getModuleByName(DotName moduleName)
Gets the module that was scanned during the indexing phase.java.util.Set<DotName>
getSubpackages(DotName packageName)
Returns a set of packages known to this index that are direct subpackages of given package.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.jboss.jandex.IndexView
getAllKnownImplementors, getAllKnownImplementors, getAllKnownSubclasses, getAllKnownSubclasses, getAllKnownSubinterfaces, getAllKnownSubinterfaces, getAnnotations, getAnnotations, getAnnotationsWithRepeatable, getAnnotationsWithRepeatable, getClassByName, getClassByName, getClassesInPackage, getKnownDirectImplementors, getKnownDirectImplementors, getKnownDirectSubclasses, getKnownDirectSubclasses, getKnownDirectSubinterfaces, getKnownDirectSubinterfaces, getKnownUsers, getKnownUsers, getModuleByName, getSubpackages
-
-
-
-
Field Detail
-
indexes
final java.util.Collection<IndexView> indexes
-
-
Constructor Detail
-
CompositeIndex
private CompositeIndex(java.util.Collection<IndexView> indexes)
-
-
Method Detail
-
create
public static CompositeIndex create(java.util.Collection<IndexView> indexes)
-
create
public static CompositeIndex create(IndexView... indexes)
-
createMerged
public static CompositeIndex createMerged(CompositeIndex... indexes)
-
getAnnotations
public java.util.List<AnnotationInstance> getAnnotations(DotName annotationName)
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.- Specified by:
getAnnotations
in interfaceIndexView
- Parameters:
annotationName
- the name of the annotation to look for- Returns:
- a non-null list of annotation instances
-
getAnnotationsWithRepeatable
public java.util.Collection<AnnotationInstance> getAnnotationsWithRepeatable(DotName annotationName, IndexView index)
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, theAnnotationInstance.target()
returns the target of the container annotation instance.- Specified by:
getAnnotationsWithRepeatable
in interfaceIndexView
- Parameters:
annotationName
- the name of the repeatable annotationindex
- the index containing the annotation class- Returns:
- a non-null list of annotation instances
-
getKnownDirectSubclasses
public java.util.Set<ClassInfo> getKnownDirectSubclasses(DotName className)
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.
Also note that interfaces are considered direct subclasses of
java.lang.Object
.- Specified by:
getKnownDirectSubclasses
in interfaceIndexView
- Parameters:
className
- the super class of the desired subclasses- Returns:
- a non-null list of all known subclasses of className
-
getAllKnownSubclasses
public java.util.Set<ClassInfo> getAllKnownSubclasses(DotName className)
Returns all known (including non-direct) subclasses of the given class. I.e., returns all known classes that are assignable to the given class.- Specified by:
getAllKnownSubclasses
in interfaceIndexView
- Parameters:
className
- The class- Returns:
- All known subclasses
-
getAllKnownSubClasses
private void getAllKnownSubClasses(DotName className, java.util.Set<ClassInfo> allKnown, java.util.Set<DotName> processedClasses)
-
getAllKnownSubClasses
private void getAllKnownSubClasses(DotName name, java.util.Set<ClassInfo> allKnown, java.util.Set<DotName> subClassesToProcess, java.util.Set<DotName> processedClasses)
-
getKnownDirectSubinterfaces
public java.util.Collection<ClassInfo> getKnownDirectSubinterfaces(DotName interfaceName)
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.
- Specified by:
getKnownDirectSubinterfaces
in interfaceIndexView
- Parameters:
interfaceName
- the super interface of the desired subinterfaces- Returns:
- a non-null list of all known subinterfaces of interfaceName
-
getAllKnownSubinterfaces
public java.util.Collection<ClassInfo> getAllKnownSubinterfaces(DotName interfaceName)
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.- Specified by:
getAllKnownSubinterfaces
in interfaceIndexView
- Parameters:
interfaceName
- The interface- Returns:
- all known subinterfaces
-
getKnownDirectImplementors
public java.util.Collection<ClassInfo> getKnownDirectImplementors(DotName interfaceName)
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
IndexView.getAllKnownImplementors(DotName)
, which doesn't return subinterfaces.Note that this will only pick up classes that directly implement given interface. It will not pick up classes implementing subinterfaces.
- Specified by:
getKnownDirectImplementors
in interfaceIndexView
- Parameters:
interfaceName
- The interface- Returns:
- All known direct implementors of the interface
-
getAllKnownImplementors
public java.util.Set<ClassInfo> getAllKnownImplementors(DotName interfaceName)
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
IndexView.getKnownDirectImplementors(DotName)
, this method does not return subinterfaces of given interface.- Specified by:
getAllKnownImplementors
in interfaceIndexView
- Parameters:
interfaceName
- The interface- Returns:
- All known implementors of the interface
-
getKnownImplementors
private void getKnownImplementors(DotName name, java.util.Set<ClassInfo> allKnown, java.util.Set<DotName> subInterfacesToProcess, java.util.Set<DotName> processedClasses)
-
getClassByName
public ClassInfo getClassByName(DotName className)
Gets the class (or interface, or annotation) that was scanned during the indexing phase.- Specified by:
getClassByName
in interfaceIndexView
- Parameters:
className
- the name of the class- Returns:
- information about the class or null if it is not known
-
getKnownClasses
public java.util.Collection<ClassInfo> getKnownClasses()
Gets all known classes by this index (those which were scanned).- Specified by:
getKnownClasses
in interfaceIndexView
- Returns:
- a collection of known classes
-
getModuleByName
public ModuleInfo getModuleByName(DotName moduleName)
Gets the module that was scanned during the indexing phase.- Specified by:
getModuleByName
in interfaceIndexView
- Parameters:
moduleName
- the name of the module- Returns:
- information about the module or null if it is not known
-
getKnownModules
public java.util.Collection<ModuleInfo> getKnownModules()
Gets all known modules by this index (those which were scanned).- Specified by:
getKnownModules
in interfaceIndexView
- Returns:
- a collection of known modules
-
getKnownUsers
public java.util.Collection<ClassInfo> getKnownUsers(DotName className)
Returns a list of classes in this index that use the specified class. For one class to use another class, the other class has to:- occur in the signature of the class (that is, in the superclass type, in the superinterface types, in the type parameters, or in the list of permitted subclasses), or
- occur in the signature of any of the class's methods (that is, in the return type, in the parameter types, in the exception types, or in the type parameters), or
- occur in the type of any of the class's fields or record components, or
- occur in the list of class references in the constant pool, as described by the JLS and JVMS.
- Specified by:
getKnownUsers
in interfaceIndexView
- Parameters:
className
- the name of the class to look for- Returns:
- a non-null list of classes that use the specified class
-
getClassesInPackage
public java.util.Collection<ClassInfo> getClassesInPackage(DotName packageName)
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 usingnull
as the package name. If this index does not contain any class in given package, returns an empty collection.In the default
Index
implementation, this information is not stored in the index initially. Instead, an index of classes by package name is constructed on demand (on the first invocation of this method).- Specified by:
getClassesInPackage
in interfaceIndexView
- Parameters:
packageName
- package name in the common, dot-separated form (e.g.com.example.foobar
);null
means the unnamed package- Returns:
- immutable collection of classes present in given package, never
null
-
getSubpackages
public java.util.Set<DotName> getSubpackages(DotName packageName)
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
null
as the package name is permitted, but always results in an empty set.In the default
Index
implementation, this information is not stored in the index initially. Instead, an index of packages is constructed on demand (on the first invocation of this method).- Specified by:
getSubpackages
in interfaceIndexView
- Parameters:
packageName
- package name in the common, dot-separated form (e.g.com.example.foobar
);null
means the unnamed package- Returns:
- immutable set of subpackages of given package, never
null
-
-