Package org.jboss.jandex

Class IndexReader

java.lang.Object
org.jboss.jandex.IndexReader
public final class IndexReader extends Object
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.
Author:
Jason T. Greene

  • Constructor Details

    • IndexReader

      public IndexReader(InputStream input)
      Constructs a new IndedReader using the passed stream. The stream is not read from until the read method is called.
      Parameters:
      input - a stream which points to a jandex index file

  • Method Details

    • read

      public Index read() throws IOException
      Read the index at the associated stream of this reader. This method can be called multiple times if the stream contains multiple index files.
      Returns:
      the Index contained in the stream
      Throws:
      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

    • getIndexVersion

      public int getIndexVersion() throws IOException
      Returns the index file version. This version number marks the internal storage format and also implies the version of data contract of the index. It is incremented whenever more information are added to the index format, so it may be used to determine whether an index file contains necessary information.
      Returns:
      the index file version
      Throws:
      IOException - If the index could not be read