Class IndexWriterV2

java.lang.Object

org.jboss.jandex.IndexWriterImpl

org.jboss.jandex.IndexWriterV2

final class IndexWriterV2
extends IndexWriterImpl

Writes a Jandex index file to a stream. The write process is somewhat more expensive to allow for fast reads and a compact size. For more information on the index content, see the documentation on Indexer.

The IndexWriter operates on standard output streams, and also provides suitable buffering.

Thread-Safety

IndexWriter is not thread-safe and can not be shared between concurrent threads.

See Also:

• Indexer
• Index

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	IndexWriterV2.ReferenceEntry
(package private) static class	IndexWriterV2.ReferenceTable<T>

Field Summary

Fields

Modifier and Type	Field	Description
private IndexWriterV2.ReferenceTable<AnnotationInstance>	annotationTable
private static final int	AVALUE_ARRAY
private static final int	AVALUE_BOOLEAN
private static final int	AVALUE_BYTE
private static final int	AVALUE_CHAR
private static final int	AVALUE_CLASS
private static final int	AVALUE_DOUBLE
private static final int	AVALUE_ENUM
private static final int	AVALUE_FLOAT
private static final int	AVALUE_INT
private static final int	AVALUE_LONG
private static final int	AVALUE_NESTED
private static final int	AVALUE_SHORT
private static final int	AVALUE_STRING
private static final byte	CLASS_EXTENDS_TYPE_TAG
private static final byte	CLASS_TAG
private static final byte	EMPTY_TYPE_TAG
private static final byte	FIELD_TAG
private static final int	HAS_ENCLOSING_METHOD
private static final int	HAS_NESTING
private static final int	MAGIC
(package private) static final int	MAX_VERSION
private static final byte	METHOD_PARAMETER_TAG
private static final byte	METHOD_PARAMETER_TYPE_TAG
private static final byte	METHOD_TAG
(package private) static final int	MIN_VERSION
private NameTable	names
private HashMap<DotName,Integer>	nameTable
private static final int	NO_ENCLOSING_METHOD
private static final int	NO_NESTING
private static final byte	NULL_TARGET_TAG
private final OutputStream	out
private static final byte	RECORD_COMPONENT_TAG
private TreeMap<String,DotName>	sortedNameTable
private static final byte	THROWS_TYPE_TAG
private static final byte	TYPE_PARAMETER_BOUND_TAG
private static final byte	TYPE_PARAMETER_TAG
private IndexWriterV2.ReferenceTable<Type[]>	typeListTable
private IndexWriterV2.ReferenceTable<Type>	typeTable
private final int	version

Constructor Summary

Constructors

Constructor	Description
IndexWriterV2(OutputStream out, int version)	Constructs an IndexWriter using the specified stream

Method Summary

Modifier and Type	Method	Description
private void	addAnnotation(AnnotationInstance instance)
private void	addAnnotationTarget(AnnotationTarget target)
private void	addClass(ClassInfo clazz)
private void	addClassName(DotName name)
private void	addClassNames(List<DotName> names)
private void	addEnclosingMethod(ClassInfo.EnclosingMethodInfo enclosingMethod)
private void	addFieldList(FieldInternal[] fields)
private void	addMethodList(MethodInternal[] methods)
private void	addModule(ModuleInfo module)
private String	addNullableString(String name)
private void	addRecordComponentList(RecordComponentInternal[] recordComponents)
private String	addString(String name)
private void	addType(Type type)
private void	addTypeList(Type[] types)
private void	buildAValueEntries(AnnotationValue value)
private void	buildTables(Index index)
private void	deepIntern(FieldInternal field)
private void	deepIntern(MethodInternal method)
private void	deepIntern(RecordComponentInternal recordComponent)
private boolean	markWritten(AnnotationInstance annotation)
private boolean	markWritten(Type[] types)
private int	positionOf(byte[] bytes)
private int	positionOf(String string)
private int	positionOf(AnnotationInstance instance)
private int	positionOf(DotName className)
private int	positionOf(FieldInternal field)
private int	positionOf(MethodInternal method)
private int	positionOf(RecordComponentInternal recordComponent)
private int	positionOf(Type type)
private int	positionOf(Type[] types)
(package private) int	write(Index index)	Writes the specified index to the associated output stream.
private void	writeAnnotation(PackedDataOutputStream stream, AnnotationInstance instance)
private void	writeAnnotations(PackedDataOutputStream stream, Collection<AnnotationInstance> annotations)
private void	writeAnnotations(PackedDataOutputStream stream, AnnotationInstance[] annotations)
private void	writeAnnotationTarget(PackedDataOutputStream stream, AnnotationTarget target)
private void	writeAnnotationValue(PackedDataOutputStream stream, AnnotationValue value)
private void	writeAnnotationValues(PackedDataOutputStream stream, Collection<AnnotationValue> values)
private void	writeByteTable(PackedDataOutputStream stream)
private void	writeClassEntry(PackedDataOutputStream stream, ClassInfo clazz)
private void	writeClasses(PackedDataOutputStream stream, Index index)
private void	writeDotNames(PackedDataOutputStream stream, List<DotName> names)
private void	writeFieldEntry(PackedDataOutputStream stream, FieldInternal field)
private void	writeFieldTable(PackedDataOutputStream stream)
private void	writeMethodEntry(PackedDataOutputStream stream, MethodInternal method)
private void	writeMethodTable(PackedDataOutputStream stream)
private void	writeModuleEntry(PackedDataOutputStream stream, ModuleInfo module)
private void	writeModules(PackedDataOutputStream stream, Index index)
private void	writeNameTable(PackedDataOutputStream stream)
private void	writeRecordComponentEntry(PackedDataOutputStream stream, RecordComponentInternal recordComponent)
private void	writeRecordComponentTable(PackedDataOutputStream stream)
private void	writeReference(PackedDataOutputStream stream, Type type, boolean nullable)
private void	writeReferenceOrFull(PackedDataOutputStream stream, AnnotationInstance annotation)
private void	writeReferenceOrFull(PackedDataOutputStream stream, Type[] types)
private void	writeStringTable(PackedDataOutputStream stream)
private void	writeTypeEntry(PackedDataOutputStream stream, Type type)
private void	writeTypeListEntry(PackedDataOutputStream stream, Type[] types)
private void	writeTypeListTable(PackedDataOutputStream stream)
private void	writeTypeTable(PackedDataOutputStream stream)
private void	writeTypeTarget(PackedDataOutputStream stream, TypeTarget typeTarget)
private void	writeTypeTargetFields(PackedDataOutputStream stream, byte tag, TypeTarget target)
private void	writeUsersSet(PackedDataOutputStream stream, DotName user, ClassInfo[] uses)
private void	writeUsersTable(PackedDataOutputStream stream, Map<DotName, ClassInfo[]> users)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MIN_VERSION

static final int MIN_VERSION

See Also:

• Constant Field Values

MAX_VERSION

static final int MAX_VERSION

See Also:

• Constant Field Values

MAGIC

private static final int MAGIC

See Also:

• Constant Field Values

NULL_TARGET_TAG

private static final byte NULL_TARGET_TAG

See Also:

• Constant Field Values

FIELD_TAG

private static final byte FIELD_TAG

See Also:

• Constant Field Values

METHOD_TAG

private static final byte METHOD_TAG

See Also:

• Constant Field Values

METHOD_PARAMETER_TAG

private static final byte METHOD_PARAMETER_TAG

See Also:

• Constant Field Values

CLASS_TAG

private static final byte CLASS_TAG

See Also:

• Constant Field Values

EMPTY_TYPE_TAG

private static final byte EMPTY_TYPE_TAG

See Also:

• Constant Field Values

CLASS_EXTENDS_TYPE_TAG

private static final byte CLASS_EXTENDS_TYPE_TAG

See Also:

• Constant Field Values

TYPE_PARAMETER_TAG

private static final byte TYPE_PARAMETER_TAG

See Also:

• Constant Field Values

TYPE_PARAMETER_BOUND_TAG

private static final byte TYPE_PARAMETER_BOUND_TAG

See Also:

• Constant Field Values

METHOD_PARAMETER_TYPE_TAG

private static final byte METHOD_PARAMETER_TYPE_TAG

See Also:

• Constant Field Values

THROWS_TYPE_TAG

private static final byte THROWS_TYPE_TAG

See Also:

• Constant Field Values

RECORD_COMPONENT_TAG

private static final byte RECORD_COMPONENT_TAG

See Also:

• Constant Field Values

AVALUE_BYTE

private static final int AVALUE_BYTE

See Also:

• Constant Field Values

AVALUE_SHORT

private static final int AVALUE_SHORT

See Also:

• Constant Field Values

AVALUE_INT

private static final int AVALUE_INT

See Also:

• Constant Field Values

AVALUE_CHAR

private static final int AVALUE_CHAR

See Also:

• Constant Field Values

AVALUE_FLOAT

private static final int AVALUE_FLOAT

See Also:

• Constant Field Values

AVALUE_DOUBLE

private static final int AVALUE_DOUBLE

See Also:

• Constant Field Values

AVALUE_LONG

private static final int AVALUE_LONG

See Also:

• Constant Field Values

AVALUE_BOOLEAN

private static final int AVALUE_BOOLEAN

See Also:

• Constant Field Values

AVALUE_STRING

private static final int AVALUE_STRING

See Also:

• Constant Field Values

AVALUE_CLASS

private static final int AVALUE_CLASS

See Also:

• Constant Field Values

AVALUE_ENUM

private static final int AVALUE_ENUM

See Also:

• Constant Field Values

AVALUE_ARRAY

private static final int AVALUE_ARRAY

See Also:

• Constant Field Values

AVALUE_NESTED

private static final int AVALUE_NESTED

See Also:

• Constant Field Values

HAS_ENCLOSING_METHOD

private static final int HAS_ENCLOSING_METHOD

See Also:

• Constant Field Values

NO_ENCLOSING_METHOD

private static final int NO_ENCLOSING_METHOD

See Also:

• Constant Field Values

NO_NESTING

private static final int NO_NESTING

See Also:

• Constant Field Values

HAS_NESTING

private static final int HAS_NESTING

See Also:

• Constant Field Values

out

private final OutputStream out

version

private final int version

names

private NameTable names

nameTable

private HashMap<DotName,Integer> nameTable

sortedNameTable

private TreeMap<String,DotName> sortedNameTable

annotationTable

private IndexWriterV2.ReferenceTable<AnnotationInstance> annotationTable

typeTable

private IndexWriterV2.ReferenceTable<Type> typeTable

typeListTable

private IndexWriterV2.ReferenceTable<Type[]> typeListTable

Constructor Details

IndexWriterV2

IndexWriterV2(OutputStream out,
 int version)

Constructs an IndexWriter using the specified stream

Parameters:

out - a stream to write an index to

version - the index file version

Method Details

write

int write(Index index)
   throws IOException

Writes the specified index to the associated output stream. This may be called multiple times in order to write multiple indexes.

Specified by:

write in class IndexWriterImpl

Parameters:

index - the index to write to the stream

Returns:

the number of bytes written to the stream

Throws:

IOException - if any i/o error occurs

writeUsersTable

private void writeUsersTable(PackedDataOutputStream stream,
 Map<DotName, ClassInfo[]> users)
                      throws IOException

Throws:

IOException

writeUsersSet

private void writeUsersSet(PackedDataOutputStream stream,
 DotName user,
 ClassInfo[] uses)
                    throws IOException

Throws:

IOException

writeStringTable

private void writeStringTable(PackedDataOutputStream stream)
                       throws IOException

Throws:

IOException

writeByteTable

private void writeByteTable(PackedDataOutputStream stream)
                     throws IOException

Throws:

IOException

writeTypeTable

private void writeTypeTable(PackedDataOutputStream stream)
                     throws IOException

Throws:

IOException

writeTypeListTable

private void writeTypeListTable(PackedDataOutputStream stream)
                         throws IOException

Throws:

IOException

writeTypeListEntry

private void writeTypeListEntry(PackedDataOutputStream stream,
 Type[] types)
                         throws IOException

Throws:

IOException

writeMethodTable

private void writeMethodTable(PackedDataOutputStream stream)
                       throws IOException

Throws:

IOException

writeFieldTable

private void writeFieldTable(PackedDataOutputStream stream)
                      throws IOException

Throws:

IOException

writeRecordComponentTable

private void writeRecordComponentTable(PackedDataOutputStream stream)
                                throws IOException

Throws:

IOException

writeFieldEntry

private void writeFieldEntry(PackedDataOutputStream stream,
 FieldInternal field)
                      throws IOException

Throws:

IOException

writeRecordComponentEntry

private void writeRecordComponentEntry(PackedDataOutputStream stream,
 RecordComponentInternal recordComponent)
                                throws IOException

Throws:

IOException

writeMethodEntry

private void writeMethodEntry(PackedDataOutputStream stream,
 MethodInternal method)
                       throws IOException

Throws:

IOException

writeAnnotation

private void writeAnnotation(PackedDataOutputStream stream,
 AnnotationInstance instance)
                      throws IOException

Throws:

IOException

writeAnnotationTarget

private void writeAnnotationTarget(PackedDataOutputStream stream,
 AnnotationTarget target)
                            throws IOException

Throws:

IOException

writeTypeTarget

private void writeTypeTarget(PackedDataOutputStream stream,
 TypeTarget typeTarget)
                      throws IOException

Throws:

IOException

writeTypeTargetFields

private void writeTypeTargetFields(PackedDataOutputStream stream,
 byte tag,
 TypeTarget target)
                            throws IOException

Throws:

IOException

writeNameTable

private void writeNameTable(PackedDataOutputStream stream)
                     throws IOException

Throws:

IOException

positionOf

private int positionOf(String string)

positionOf

private int positionOf(byte[] bytes)

positionOf

private int positionOf(MethodInternal method)

positionOf

private int positionOf(FieldInternal field)

positionOf

private int positionOf(RecordComponentInternal recordComponent)

positionOf

private int positionOf(DotName className)

positionOf

private int positionOf(Type type)

positionOf

private int positionOf(Type[] types)

positionOf

private int positionOf(AnnotationInstance instance)

markWritten

private boolean markWritten(Type[] types)

markWritten

private boolean markWritten(AnnotationInstance annotation)

writeClasses

private void writeClasses(PackedDataOutputStream stream,
 Index index)
                   throws IOException

Throws:

IOException

writeModules

private void writeModules(PackedDataOutputStream stream,
 Index index)
                   throws IOException

Throws:

IOException

writeClassEntry

private void writeClassEntry(PackedDataOutputStream stream,
 ClassInfo clazz)
                      throws IOException

Throws:

IOException

writeModuleEntry

private void writeModuleEntry(PackedDataOutputStream stream,
 ModuleInfo module)
                       throws IOException

Throws:

IOException

writeDotNames

private void writeDotNames(PackedDataOutputStream stream,
 List<DotName> names)
                    throws IOException

Throws:

IOException

writeAnnotationValues

private void writeAnnotationValues(PackedDataOutputStream stream,
 Collection<AnnotationValue> values)
                            throws IOException

Throws:

IOException

writeAnnotationValue

private void writeAnnotationValue(PackedDataOutputStream stream,
 AnnotationValue value)
                           throws IOException

Throws:

IOException

writeReference

private void writeReference(PackedDataOutputStream stream,
 Type type,
 boolean nullable)
                     throws IOException

Throws:

IOException

writeAnnotations

private void writeAnnotations(PackedDataOutputStream stream,
 AnnotationInstance[] annotations)
                       throws IOException

Throws:

IOException

writeAnnotations

private void writeAnnotations(PackedDataOutputStream stream,
 Collection<AnnotationInstance> annotations)
                       throws IOException

Throws:

IOException

writeReferenceOrFull

private void writeReferenceOrFull(PackedDataOutputStream stream,
 AnnotationInstance annotation)
                           throws IOException

Throws:

IOException

writeReferenceOrFull

private void writeReferenceOrFull(PackedDataOutputStream stream,
 Type[] types)
                           throws IOException

Throws:

IOException

writeTypeEntry

private void writeTypeEntry(PackedDataOutputStream stream,
 Type type)
                     throws IOException

Throws:

IOException

buildTables

private void buildTables(Index index)

addClass

private void addClass(ClassInfo clazz)

addModule

private void addModule(ModuleInfo module)

addAnnotation

private void addAnnotation(AnnotationInstance instance)

addAnnotationTarget

private void addAnnotationTarget(AnnotationTarget target)

addFieldList

private void addFieldList(FieldInternal[] fields)

deepIntern

private void deepIntern(FieldInternal field)

addMethodList

private void addMethodList(MethodInternal[] methods)

deepIntern

private void deepIntern(MethodInternal method)

addRecordComponentList

private void addRecordComponentList(RecordComponentInternal[] recordComponents)

deepIntern

private void deepIntern(RecordComponentInternal recordComponent)

addEnclosingMethod

private void addEnclosingMethod(ClassInfo.EnclosingMethodInfo enclosingMethod)

addTypeList

private void addTypeList(Type[] types)

addType

private void addType(Type type)

buildAValueEntries

private void buildAValueEntries(AnnotationValue value)

addNullableString

private String addNullableString(String name)

addString

private String addString(String name)

addClassNames

private void addClassNames(List<DotName> names)

addClassName

private void addClassName(DotName name)