|
Java Annotation Indexer 1.0.0.Final-redhat-1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jboss.jandex.IndexReader
public final class IndexReader
Reads a Jandex index file and returns the saved index. See Indexer
for a thorough description of how the Index data is produced.
An IndexReader loads the stream passed to it's constructor and applies the appropriate buffering. The Jandex index format is designed for efficient reading and low final memory storage.
Thread-Safety
IndexReader is not thread-safe and can not be shared between concurrent threads. The resulting index, however, is.
Constructor Summary | |
---|---|
IndexReader(InputStream input)
Constructs a new IndedReader using the passed stream. |
Method Summary | |
---|---|
Index |
read()
Read the index at the associated stream of this reader. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public IndexReader(InputStream input)
input
- a stream which points to a jandex index fileMethod Detail |
---|
public Index read() throws IOException
IOException
- if an I/O error occurs
IllegalArgumentException
- if the stream does not point to Jandex index data
UnsupportedVersion
- if the index data is tagged with a version not known to this reader
|
Java Annotation Indexer 1.0.0.Final-redhat-1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |