Package org.jboss.jandex
Jandex is a space efficient Java class file indexer and offline reflection library.
See the documentation.
-
Interface Summary Interface Description AnnotationOverlay Annotation overlay allows overriding annotation information from an index.AnnotationTarget Represents an object that can be a target of an annotation.AnnotationTransformation An annotation transformation.AnnotationTransformation.TransformationContext A transformation context.Declaration AnAnnotationTarget
that is also a declaration.Descriptor Implementations of this interface have a bytecode descriptor, as defined in JVMS 17, chapter 4.3.GenericSignature Implementations of this interface have a generic signature, as defined in JVMS 17, chapter 4.7.9.1.IndexView The basic contract for accessing Jandex indexed information.MutableAnnotationOverlay AnAnnotationOverlay
that can be freely mutated. -
Class Summary Class Description AnnotationInstance An annotation instance represents a specific usage of an annotation on a target.AnnotationInstance.NameComparator AnnotationInstanceBuilder Builder forAnnotationInstance
.AnnotationInstanceEquivalenceProxy Holds anAnnotationInstance
and implements equality and hash code as equivalence.AnnotationOverlay.Builder The builder for an annotation overlay.AnnotationOverlayImpl AnnotationOverlayImpl.TransformationContextImpl AnnotationTransformation.Builder<THIS extends AnnotationTransformation.Builder<THIS>> Abstract class for annotation transformation builders.AnnotationTransformation.ClassBuilder A builder of annotation transformations for classes.AnnotationTransformation.DeclarationBuilder A builder of annotation transformations for arbitrary declarations.AnnotationTransformation.FieldBuilder A builder of annotation transformations for fields.AnnotationTransformation.MethodBuilder A builder of annotation transformations for methods.AnnotationTransformation.MethodParameterBuilder A builder of annotation transformations for method parameters.AnnotationTransformation.RecordComponentBuilder A builder of annotation transformations for record components.AnnotationValue An annotation value represents a specific name and value combination in the parameter list of an annotation instance.AnnotationValue.ArrayValue AnnotationValue.BooleanValue AnnotationValue.ByteValue AnnotationValue.CharacterValue AnnotationValue.ClassValue AnnotationValue.DoubleValue AnnotationValue.EnumValue AnnotationValue.FloatValue AnnotationValue.IntegerValue AnnotationValue.LongValue AnnotationValue.NestedAnnotation AnnotationValue.ShortValue AnnotationValue.StringValue ArrayType Represents a Java array type.ArrayType.Builder Convenient builder forArrayType
.BitTricks ClassExtendsTypeTarget Represents a target of type annotation which occurs in theextends
orimplements
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.ClassInfo.ExtraInfo ClassInfo.NestingInfo ClassSummary Summary of a just-indexed class, returned byIndexer.indexWithSummary(InputStream)
.ClassType Represents a class type.ClassType.Builder Convenient builder forClassType
.CompositeIndex Composite annotation index.DescriptorReconstruction DotName ADotName
represents a dot separated name, typically a Java package or a Java class.EmptyIndex Immutable empty index; that is, an index that doesn't contain any 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.FieldInfoGenerator A list which wraps FieldInternal objects with a FieldInfo, so that the declaring class' reference can be set.FieldInternal The shared internal representation for FieldInfo objects.FieldInternal.NameComparator GenericSignatureParser A simple recursive decent generic signature parser.GenericSignatureParser.ClassSignature GenericSignatureParser.MethodSignature GenericSignatureReconstruction ImmutableArrayList<T> Index An index useful for quickly processing annotations.Indexer Analyzes and indexes the annotation and key structural information of a set of classes.Indexer.BooleanHolder Indexer.InnerClassInfo Indexer.IntegerHolder Indexer.NameAndType Indexer.PathElement Indexer.PathElementStack Indexer.TmpObjects Indexer.TypeAnnotationState IndexReader Reads a Jandex index file and returns the saved index.IndexReaderImpl A common base class for index reader implementations.IndexReaderV1 Reads a Jandex index file and returns the saved index.IndexReaderV2 Reads a Jandex index file and returns the saved index.IndexWriter Writes a Jandex index file to a stream.IndexWriterImpl IndexWriterV1 Writes a Jandex index file to a stream.IndexWriterV2 Writes a Jandex index file to a stream.IndexWriterV2.ReferenceEntry IndexWriterV2.ReferenceTable<T> JandexAntTask Ant Task that indexes jars, and saves the resulting indexJandexReflection 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 fileMain Responsible for launching the indexing tool on a java command line.MethodInfo Represents a Java method, constructor, or static initializer.MethodInfoGenerator A list which wraps MethodInternal objects with a MethodInfo, so that the declaring class' reference can be set.MethodInternal The shared internal representation for MethodInfo objects.MethodInternal.ExtraInfo MethodInternal.NameAndParameterComponentComparator MethodParameterInfo Represents an individual Java method parameter that was annotated.MethodParameterTypeTarget Represents a type annotation target which occurs within a method parameter type.MethodParamList MethodParamList.ParamData Modifiers ModuleInfo Represents a module descriptor entry in an index.ModuleInfo.ExportedPackageInfo ModuleInfo.OpenedPackageInfo ModuleInfo.ProvidedServiceInfo ModuleInfo.RequiredModuleInfo MutableAnnotationOverlay.Builder The builder for a mutable annotation overlay.MutableAnnotationOverlayImpl NameTable A collection of intern pools.PackedDataInputStream An input stream that reads integers that were packed byPackedDataOutputStream
PackedDataOutputStream An output stream that can pack integers into as few bytes as possible.ParameterizedType Represents a parameterized type.ParameterizedType.Builder Convenient builder forParameterizedType
.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.RecordComponentInfoGenerator A list which wraps RecordComponentInternal objects with a RecordComponentInfo, so that the declaring class' reference can be set.RecordComponentInternal The shared internal representation for RecordComponentInfo objects.RecordComponentInternal.NameComparator Result The result from a jar indexing operation.StackedIndex A stack of indexes with overlay semantics.StrongInternPool<E> A strong intern pool.StrongInternPool.ByteArrayInternPool StrongInternPool.FieldInternPool StrongInternPool.MethodInternPool StrongInternPool.RecordComponentInternPool StrongInternPool.StringInternPool StrongInternPool.TypeArrayInternPool StrongInternPool.TypeInternPool ThrowsTypeTarget Represents a target of type annotation which occurs in thethrows
clause of an enclosing method.Type Represents a Java type usage that is specified on methods, fields, classes, annotations, or other types.Type.Builder<THIS extends Type.Builder<THIS>> Base class for type builders.TypeInterning Certain Jandex classes have to implement special equality/hash code for the purpose of interning.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.TypeParser TypeTarget Represents a type that is the target of a type annotation.TypeVariable Represents a resolved type parameter or type argument.TypeVariable.Builder Convenient builder forTypeVariable
.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.Utils Common utilitiesUtils.ReusableBufferedDataInputStream Utils.ReusableBufferedInputStream VoidType Represents thevoid
pseudo-type, which may appear in a method signature.WildcardType Represents a generic wildcard.WildcardType.Builder Convenient builder forWildcardType
. -
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 classIndexer.PathElement.Kind PrimitiveType.Primitive Specifies the underlying Java primitive type for aPrimitiveType
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.