Top Description Interfaces Classes
[default module]

Package org.jboss.jandex


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

Interface Summary

Modifier and TypeInterface and Description
public interface
AnnotationTarget

Represents an object that can be a target of an annotation.

public interface
Declaration

An AnnotationTarget that is also a declaration.

public interface
Descriptor

Implementations of this interface have a bytecode descriptor, as defined in JVMS 17, chapter 4.3.

public interface
GenericSignature

Implementations of this interface have a generic signature, as defined in JVMS 17, chapter 4.7.9.1.

public interface
IndexView

The basic contract for accessing Jandex indexed information.

Class Summary

Modifier and TypeClass and Description
public class
AnnotationInstance

An annotation instance represents a specific usage of an annotation on a target.

public class
public class
AnnotationInstanceEquivalenceProxy

Holds an AnnotationInstance and implements equality and hash code as equivalence.

public abstract class
AnnotationValue

An annotation value represents a specific name and value combination in the parameter list of an annotation instance.

public class
ArrayType

Represents a Java array type.

pack-priv class
public class
ClassExtendsTypeTarget

Represents a target of type annotation which occurs in the extends or implements clause of an enclosing class.

public class
ClassInfo

Represents a class entry in an index.

public class
ClassSummary

Summary of a just-indexed class, returned by Indexer#indexWithSummary(InputStream).

public class
ClassType

Represents a class type.

public class
CompositeIndex

Composite annotation index.

pack-priv class
public class
DotName

A DotName represents a dot separated name, typically a Java package or a Java class.

public class
EmptyTypeTarget

Represents a target of type annotation which occurs directly on a field type, a method return type, or a method receiver type.

public abstract class
EquivalenceKey

Establishes a notion of equivalence of Jandex objects.

public class
FieldInfo

Represents a field.

pack-priv class
FieldInfoGenerator

A list which wraps FieldInternal objects with a FieldInfo, so that the declaring class' reference can be set.

pack-priv class
FieldInternal

The shared internal representation for FieldInfo objects.

pack-priv class
GenericSignatureParser

A simple recursive decent generic signature parser.

pack-priv class
pack-priv class
public class
Index

An index useful for quickly processing annotations.

public class
Indexer

Analyzes and indexes the annotation and key structural information of a set of classes.

public class
IndexReader

Reads a Jandex index file and returns the saved index.

pack-priv abstract class
IndexReaderImpl

A common base class for index reader implementations.

pack-priv class
IndexReaderV1

Reads a Jandex index file and returns the saved index.

pack-priv class
IndexReaderV2

Reads a Jandex index file and returns the saved index.

public class
IndexWriter

Writes a Jandex index file to a stream.

pack-priv abstract class
pack-priv class
IndexWriterV1

Writes a Jandex index file to a stream.

pack-priv class
IndexWriterV2

Writes a Jandex index file to a stream.

public class
JandexAntTask

Ant Task that indexes jars, and saves the resulting index

public class
JandexReflection

Utilities that allow moving from the Jandex world to the runtime world using reflection.

public class
JarIndexer

Class which contains utility methods to create an index for a jar file

public class
Main

Responsible for launching the indexing tool on a java command line.

public class
MethodInfo

Represents a Java method, constructor, or static initializer.

pack-priv class
MethodInfoGenerator

A list which wraps MethodInternal objects with a MethodInfo, so that the declaring class' reference can be set.

pack-priv class
MethodInternal

The shared internal representation for MethodInfo objects.

public class
MethodParameterInfo

Represents an individual Java method parameter that was annotated.

public class
MethodParameterTypeTarget

Represents a type annotation target which occurs within a method parameter type.

pack-priv class
pack-priv class
public class
ModuleInfo

Represents a module descriptor entry in an index.

pack-priv class
NameTable

A collection of intern pools.

pack-priv class
PackedDataInputStream

An input stream that reads integers that were packed by PackedDataOutputStream

Thread-Safety This class is not thread-safe can not be shared between threads.

pack-priv class
PackedDataOutputStream

An output stream that can pack integers into as few bytes as possible.

public class
ParameterizedType

Represents a parameterized type.

public abstract class
PositionBasedTypeTarget

A common parent for type targets which provide a position.

public class
PrimitiveType

Represents a primitive Java type.

public class
RecordComponentInfo

Represents an individual Java record component that was annotated.

pack-priv class
RecordComponentInfoGenerator

A list which wraps RecordComponentInternal objects with a RecordComponentInfo, so that the declaring class' reference can be set.

pack-priv class
RecordComponentInternal

The shared internal representation for RecordComponentInfo objects.

public class
Result

The result from a jar indexing operation.

pack-priv abstract class
StrongInternPool<E>

A strong intern pool.

public class
ThrowsTypeTarget

Represents a target of type annotation which occurs in the throws clause of an enclosing method.

public abstract class
Type

Represents a Java type usage that is specified on methods, fields, classes, annotations, or other types.

pack-priv class
TypeInterning

Certain Jandex classes have to implement special equality/hash code for the purpose of interning.

public class
TypeParameterBoundTypeTarget

Represents a target of type annotation which occurs within a bound of type parameter.

public class
TypeParameterTypeTarget

Represents a target of type annotation which occurs within a type parameter.

public abstract class
TypeTarget

Represents a type that is the target of a type annotation.

public class
TypeVariable

Represents a resolved type parameter or type argument.

public class
TypeVariableReference

Represents a reference to a type variable in the bound of a recursive type parameter.

public class
UnresolvedTypeVariable

Represents a type variable that could not be resolved during indexing.

public class
UnsupportedVersion

The version encountered is not supported.

pack-priv class
Utils

Common utilities

public class
VoidType

Specifies "void" in a method signature.

public class
WildcardType

Represents a generic wildcard.