Package org.jboss.jandex

Jandex is a space efficient Java class file indexer and offline reflection library.

See: Description

Interface Summary

Interface	Description
AnnotationTarget	Represents an object that can be a target of an annotation.
IndexView	The basic contract for accessing Jandex indexed information.

Class Summary

Class	Description
AnnotationInstance	An annotation instance represents a specific usage of an annotation on a target.
AnnotationInstanceBuilder	Builder for AnnotationInstance.
AnnotationValue	An annotation value represents a specific name and value combination in the parameter list of an annotation instance.
ArrayType	Represents a Java array type declaration.
ClassExtendsTypeTarget	Represents a target of type annotation which occurs in the extends or implements clause of an enclosing class.
ClassInfo	Represents a class entry in an index.
ClassInfo.EnclosingMethodInfo	Provides information on the enclosing method or constructor for a local or anonymous class, if available.
ClassSummary
ClassType	Represents a standard raw class name.
CompositeIndex	Composite annotation index.
DotName	A DotName represents a dot separated name, typically a Java package or a Java class.
EmptyTypeTarget	Represents a target of type annotation which occurs directly on a field type, a method return type, or a method receiver type.
EquivalenceKey	Establishes a notion of equivalence of Jandex objects.
EquivalenceKey.ArrayTypeEquivalenceKey
EquivalenceKey.ClassEquivalenceKey
EquivalenceKey.ClassTypeEquivalenceKey
EquivalenceKey.DeclarationEquivalenceKey
EquivalenceKey.FieldEquivalenceKey
EquivalenceKey.MethodEquivalenceKey
EquivalenceKey.MethodParameterEquivalenceKey
EquivalenceKey.ParameterizedTypeEquivalenceKey
EquivalenceKey.PrimitiveTypeEquivalenceKey
EquivalenceKey.RecordComponentEquivalenceKey
EquivalenceKey.TypeEquivalenceKey
EquivalenceKey.TypeVariableEquivalenceKey
EquivalenceKey.TypeVariableReferenceEquivalenceKey
EquivalenceKey.UnresolvedTypeVariableEquivalenceKey
EquivalenceKey.VoidTypeEquivalenceKey
EquivalenceKey.WildcardTypeEquivalenceKey
FieldInfo	Represents a field.
Index	An index useful for quickly processing annotations.
Indexer	Analyzes and indexes the annotation and key structural information of a set of classes.
IndexReader	Reads a Jandex index file and returns the saved index.
IndexWriter	Writes a Jandex index file to a stream.
JandexAntTask	Ant Task that indexes jars, and saves the resulting index
JandexReflection	Utilities that allow moving from the Jandex world to the runtime world using reflection.
JarIndexer	Class which contains utility methods to create an index for a jar file
Main	Responsible for launching the indexing tool on a java command line.
MethodInfo	Represents a Java method, constructor, or static initializer.
MethodParameterInfo	Represents an individual Java method parameter that was annotated.
MethodParameterTypeTarget	Represents a type annotation target which occurs within a method parameter type.
ModuleInfo	Represents a module descriptor entry in an index.
ModuleInfo.ExportedPackageInfo
ModuleInfo.OpenedPackageInfo
ModuleInfo.ProvidedServiceInfo
ModuleInfo.RequiredModuleInfo
ParameterizedType	Represents a parameterized type.
PositionBasedTypeTarget	A common parent for type targets which provide a position.
PrimitiveType	Represents a primitive Java type.
RecordComponentInfo	Represents an individual Java record component that was annotated.
Result	The result from a jar indexing operation.
ThrowsTypeTarget	Represents a target of type annotation which occurs in the throws clause of an enclosing method.
Type	Represents a Java type usage that is specified on methods, fields, classes, annotations, or other types.
TypeParameterBoundTypeTarget	Represents a target of type annotation which occurs within a bound of type parameter.
TypeParameterTypeTarget	Represents a target of type annotation which occurs within a type parameter.
TypeTarget	Represents a type that is the target of a type annotation.
TypeVariable	Represents a resolved type parameter or type argument.
TypeVariableReference	Represents a reference to a type variable in the bound of a recursive type parameter.
UnresolvedTypeVariable	Represents a type variable that could not be resolved during indexing.
VoidType	Specifies "void" in a method signature.
WildcardType	Represents a generic wildcard.

Enum Summary

Enum	Description
AnnotationTarget.Kind	Specifies the kind of object a target represents.
AnnotationValue.Kind	Specifies the kind of annotation value, which can be used to determine the underlying Java type.
ClassInfo.NestingType	Describes the form of nesting used by a class
PrimitiveType.Primitive	Specifies the underlying Java primitive type for a PrimitiveType
Type.Kind	Represents a "kind" of Type.
TypeTarget.Usage	Specifies a form of usage of a type annotation

Exception Summary

Exception	Description
UnsupportedVersion	The version encountered is not supported.

Package org.jboss.jandex Description

Jandex is a space efficient Java class file indexer and offline reflection library. See the documentation.