public final class IndexReader extends Object
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 and Description |
---|
IndexReader(InputStream input)
Constructs a new IndedReader using the passed stream.
|
Modifier and Type | Method and Description |
---|---|
int |
getDataVersion()
Returns the version of the data contract stored in the index that was read.
|
int |
getIndexVersion()
Returns the index file version.
|
Index |
read()
Read the index at the associated stream of this reader.
|
public IndexReader(InputStream input)
input
- a stream which points to a jandex index filepublic Index read() throws IOException
IOException
- if an I/O error occursIllegalArgumentException
- if the stream does not point to Jandex index dataUnsupportedVersion
- if the index data is tagged with a version not known to this readerpublic int getDataVersion() throws IOException
IOException
- If the index could not be readpublic int getIndexVersion() throws IOException
getDataVersion()
should be used instead of this method,
since applications are typically interested in the underlying contract of the data stored, and not the internal
implementation details of a Jandex index.IOException
- If the index could not be readCopyright © 2018 JBoss by Red Hat. All rights reserved.