Class StackedIndex
- java.lang.Object
-
- org.jboss.jandex.StackedIndex
-
- All Implemented Interfaces:
IndexView
public final class StackedIndex extends java.lang.Object implements IndexView
A stack of indexes with overlay semantics. Overlaying is done on class granularity. That is, if a class is present in multiple indexes on the stack, only the top-most occurrence is considered; the other variants of the class present below on the stack are ignored.- Since:
- 3.2.0
-
-
Constructor Summary
Constructors Modifier Constructor Description private
StackedIndex(IndexView[] stack)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static StackedIndex
create(java.util.List<IndexView> indexes)
Creates a stacked index from givenindexes
.static StackedIndex
create(IndexView... indexes)
Creates a stacked index from givenindexes
.java.util.Collection<ClassInfo>
getAllKnownImplementations(DotName interfaceName)
Returns all known classes that implement the given interface, directly and indirectly.java.util.Collection<ClassInfo>
getAllKnownImplementors(DotName interfaceName)
Returns all known classes that implement the given interface, directly and indirectly.java.util.Collection<ClassInfo>
getAllKnownSubclasses(DotName className)
Returns all known subclasses of the given class, direct and indirect.java.util.Collection<ClassInfo>
getAllKnownSubinterfaces(DotName interfaceName)
Returns all known subinterfaces of the given interface, direct and indirect.java.util.Collection<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)
Returns the class (or enum, record, interface, annotation) with given name.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>
getKnownDirectImplementations(DotName interfaceName)
Returns all known classes that directly implement the given interface.java.util.Collection<ClassInfo>
getKnownDirectImplementors(DotName interfaceName)
Gets all known direct implementors of the specified interface.java.util.Collection<ClassInfo>
getKnownDirectSubclasses(DotName className)
Returns all known direct subclasses of the given class.java.util.Collection<ClassInfo>
getKnownDirectSubinterfaces(DotName interfaceName)
Returns all known direct subinterfaces of the given interface.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.private static DotName
nameOfDeclaringClass(AnnotationTarget target)
StackedIndex
pushIndex(IndexView index)
Creates a new stacked index where the givenindex
is on top of the stack and the rest of the stack is equivalent to this stacked index.-
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
getAllKnownImplementations, getAllKnownImplementations, getAllKnownImplementors, getAllKnownImplementors, getAllKnownSubclasses, getAllKnownSubclasses, getAllKnownSubinterfaces, getAllKnownSubinterfaces, getAnnotations, getAnnotations, getAnnotationsWithRepeatable, getAnnotationsWithRepeatable, getClassByName, getClassByName, getClassesInPackage, getKnownDirectImplementations, getKnownDirectImplementations, getKnownDirectImplementors, getKnownDirectImplementors, getKnownDirectSubclasses, getKnownDirectSubclasses, getKnownDirectSubinterfaces, getKnownDirectSubinterfaces, getKnownUsers, getKnownUsers, getModuleByName, getSubpackages
-
-
-
-
Field Detail
-
stack
private final IndexView[] stack
-
-
Constructor Detail
-
StackedIndex
private StackedIndex(IndexView[] stack)
-
-
Method Detail
-
create
public static StackedIndex create(java.util.List<IndexView> indexes)
Creates a stacked index from givenindexes
. The first element of the list is the bottom-most index on the stack, while the last element of the list is the top-most index on the stack.- Parameters:
indexes
- indexes in stack order; must not benull
and must not containnull
elements- Returns:
- stacked index, never
null
-
create
public static StackedIndex create(IndexView... indexes)
Creates a stacked index from givenindexes
. The first element of the array is the bottom-most index on the stack, while the last element of the array is the top-most index on the stack.- Parameters:
indexes
- indexes in stack order; must not benull
and must not containnull
elements- Returns:
- stacked index, never
null
-
pushIndex
public StackedIndex pushIndex(IndexView index)
Creates a new stacked index where the givenindex
is on top of the stack and the rest of the stack is equivalent to this stacked index.- Parameters:
index
- the index to become a new top of the stack- Returns:
- a new stacked index that results from pushing
index
on top of this stacked index
-
getKnownClasses
public java.util.Collection<ClassInfo> getKnownClasses()
Description copied from interface:IndexView
Gets all known classes by this index (those which were scanned).- Specified by:
getKnownClasses
in interfaceIndexView
- Returns:
- immutable collection of known classes, never
null
-
getClassByName
public ClassInfo getClassByName(DotName className)
Description copied from interface:IndexView
Returns the class (or enum, record, interface, annotation) with given name. Returnsnull
if class with given name is not present in the index.- Specified by:
getClassByName
in interfaceIndexView
- Parameters:
className
- the name of the class- Returns:
- information about the class or
null
if it is not known
-
getKnownDirectSubclasses
public java.util.Collection<ClassInfo> getKnownDirectSubclasses(DotName className)
Description copied from interface:IndexView
Returns all known direct subclasses of the given class. Indirect subclasses are not returned.Note that interfaces are considered direct subclasses of
java.lang.Object
.- Specified by:
getKnownDirectSubclasses
in interfaceIndexView
- Parameters:
className
- the class- Returns:
- an immutable collection of known direct subclasses of given class, never
null
-
getAllKnownSubclasses
public java.util.Collection<ClassInfo> getAllKnownSubclasses(DotName className)
Description copied from interface:IndexView
Returns all known subclasses of the given class, direct and indirect. In other words, all classes that are assignable to the given class.- Specified by:
getAllKnownSubclasses
in interfaceIndexView
- Parameters:
className
- the class- Returns:
- immutable collection of all known subclasses of given class, never
null
-
getKnownDirectSubinterfaces
public java.util.Collection<ClassInfo> getKnownDirectSubinterfaces(DotName interfaceName)
Description copied from interface:IndexView
Returns all known direct subinterfaces of the given interface. Indirect subinterfaces are not returned.- Specified by:
getKnownDirectSubinterfaces
in interfaceIndexView
- Parameters:
interfaceName
- the interface- Returns:
- immutable collection of all known subinterfaces of given interface, never
null
-
getAllKnownSubinterfaces
public java.util.Collection<ClassInfo> getAllKnownSubinterfaces(DotName interfaceName)
Description copied from interface:IndexView
Returns all known subinterfaces of the given interface, direct and indirect. In other words, all interfaces that are assignable to the given interface.- Specified by:
getAllKnownSubinterfaces
in interfaceIndexView
- Parameters:
interfaceName
- the interface- Returns:
- immutable collection of all known subinterfaces of given interface, never
null
-
getKnownDirectImplementations
public java.util.Collection<ClassInfo> getKnownDirectImplementations(DotName interfaceName)
Description copied from interface:IndexView
Returns all known classes that directly implement the given interface. Classes that do not directly implement the given interface but do directly implement subinterfaces are not returned. Subclasses of classes that directly implement the given interface are not returned either.Note that unlike
IndexView.getKnownDirectImplementors(DotName)
, this method does NOT return direct subinterfaces of the given interface, which is typically what you expect when you call this method.- Specified by:
getKnownDirectImplementations
in interfaceIndexView
- Parameters:
interfaceName
- the interface- Returns:
- immutable collection of all known direct implementations of the interface, never
null
-
getAllKnownImplementations
public java.util.Collection<ClassInfo> getAllKnownImplementations(DotName interfaceName)
Description copied from interface:IndexView
Returns all known classes that implement the given interface, directly and indirectly. That is, all classes that implement the interface and its subinterfaces, as well as all their subclasses. In other words, all classes that are assignable to the interface.- Specified by:
getAllKnownImplementations
in interfaceIndexView
- Parameters:
interfaceName
- the interface- Returns:
- immutable collection of all known implementations of the interface, never
null
-
getKnownDirectImplementors
public java.util.Collection<ClassInfo> getKnownDirectImplementors(DotName interfaceName)
Description copied from interface:IndexView
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.Collection<ClassInfo> getAllKnownImplementors(DotName interfaceName)
Description copied from interface:IndexView
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
-
getAnnotations
public java.util.Collection<AnnotationInstance> getAnnotations(DotName annotationName)
Description copied from interface:IndexView
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:
- immutable collection of annotation instances, never
null
-
getAnnotationsWithRepeatable
public java.util.Collection<AnnotationInstance> getAnnotationsWithRepeatable(DotName annotationName, IndexView index)
Description copied from interface:IndexView
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:
- immutable collection of annotation instances, never
null
-
nameOfDeclaringClass
private static DotName nameOfDeclaringClass(AnnotationTarget target)
-
getKnownModules
public java.util.Collection<ModuleInfo> getKnownModules()
Description copied from interface:IndexView
Gets all known modules by this index (those which were scanned).- Specified by:
getKnownModules
in interfaceIndexView
- Returns:
- immutable collection of known modules, never
null
-
getModuleByName
public ModuleInfo getModuleByName(DotName moduleName)
Description copied from interface:IndexView
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
-
getKnownUsers
public java.util.Collection<ClassInfo> getKnownUsers(DotName className)
Description copied from interface:IndexView
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:
- immutable collection of classes that use the specified class, never
null
-
getClassesInPackage
public java.util.Collection<ClassInfo> getClassesInPackage(DotName packageName)
Description copied from interface:IndexView
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)
Description copied from interface:IndexView
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
-
-