Package org.jboss.jandex
Class IndexWriter
- java.lang.Object
-
- org.jboss.jandex.IndexWriter
-
public final class IndexWriter extends Object
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 onIndexer
.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.
-
-
Constructor Summary
Constructors Constructor Description IndexWriter(OutputStream out)
Constructs an IndexWriter using the specified stream
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description int
write(Index index)
Writes the specified index to the associated output stream.int
write(Index index, byte version)
Deprecated.int
write(Index index, int version)
Writes the specified index to the associated output stream.
-
-
-
Constructor Detail
-
IndexWriter
public IndexWriter(OutputStream out)
Constructs an IndexWriter using the specified stream- Parameters:
out
- a stream to write an index to
-
-
Method Detail
-
write
public 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. The default version of index file is used.- Parameters:
index
- the index to write to the stream- Returns:
- the number of bytes written to the stream
- Throws:
IOException
- if the underlying stream fails
-
write
@Deprecated public int write(Index index, byte version) throws IOException
Deprecated.Writes the specified index to the associated output stream. This may be called multiple times in order to write multiple indexes.- Parameters:
index
- the index to write to the streamversion
- the index file version- Returns:
- the number of bytes written to the stream
- Throws:
IOException
- if any i/o error occurs
-
write
public int write(Index index, int version) throws IOException
Writes the specified index to the associated output stream. This may be called multiple times in order to write multiple indexes.- Parameters:
index
- the index to write to the streamversion
- the index file version- Returns:
- the number of bytes written to the stream
- Throws:
IOException
- if any i/o error occurs
-
-