org.jboss.jandex

Class Indexer

java.lang.Object

org.jboss.jandex.Indexer

public final class Indexer
extends Object

Analyzes and indexes the annotation and key structural information of a set of classes. The indexer will purposefully skip any class that is not Java 5 or later. It will also do a basic/quick structural scan on any class it determines does not have annotations.

The Indexer operates on input streams that point to class file data. Input streams do not need to be buffered, as the indexer already does this. There is also no limit to the number of class file streams the indexer can process, other than available memory.

The Indexer attempts to minimize the final memory state of the index, but to do this it must maintain additional in-process state (intern tables etc) until the index is complete.

Numerous optimizations are taken during indexing to attempt to minimize the CPU and I/O cost, however, the Java class file format was not designed for partial searching, which ultimately limits the efficiency of processing them.

Thread-Safety This class is not thread-safe can not be shared between threads. The index it produces however is thread-safe.

Author:

Jason T. Greene

Constructor Summary

Constructors

Constructor and Description
Indexer()

Method Summary

Modifier and Type	Method and Description
Index	complete() Completes, finalizes, and returns the index after zero or more calls to index().
void	index(InputStream stream) Analyze and index the class file data present in given input stream.
ClassInfo	index$$bridge(InputStream stream)
void	indexClass(Class<?> clazz) Analyze and index the class file data of given clazz.
ClassInfo	indexClass$$bridge(Class<?> clazz)
ClassSummary	indexWithSummary(InputStream stream) Analyze and index the class file data present in given input stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

Indexer

public Indexer()

Method Detail

indexClass

public void indexClass(Class<?> clazz)
                throws IOException

Analyze and index the class file data of given clazz. Each call adds information to the final complete index.

Parameters:

clazz - a previously-loaded class

Throws:

IOException - if the class file data is corrupt or the underlying stream fails

IllegalArgumentException - if clazz is null

indexClass$$bridge

public ClassInfo indexClass$$bridge(Class<?> clazz)
                             throws IOException

Throws:

IOException

index

public void index(InputStream stream)
           throws IOException

Analyze and index the class file data present in given input stream. Each call adds information to the final complete index. Closing the input stream is the caller's responsibility.

Parameters:

stream - the class bytecode to index, must not be null

Throws:

IOException - if the class file data is corrupt or the stream fails

IllegalArgumentException - if stream is null

index$$bridge

public ClassInfo index$$bridge(InputStream stream)
                        throws IOException

Throws:

IOException

indexWithSummary

public ClassSummary indexWithSummary(InputStream stream)
                              throws IOException

Analyze and index the class file data present in given input stream. Each call adds information to the final complete index. Closing the input stream is the caller's responsibility.

For reporting progress in batch indexers, this variant of index returns a summary of the just-indexed class.

Parameters:

stream - the class bytecode to index, must not be null

Returns:

a summary of the just-indexed class

Throws:

IOException - if the class file data is corrupt or the stream fails

IllegalArgumentException - if stream is null

complete

public Index complete()

Completes, finalizes, and returns the index after zero or more calls to index(). Future calls to index() will result in a new index.

Returns:

the master index for all scanned class streams