org.apache.lucene.search.suggest.fst

Class Sort.ByteSequencesReader

java.lang.Object

org.apache.lucene.search.suggest.fst.Sort.ByteSequencesReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Enclosing class:

Sort

public static class Sort.ByteSequencesReader
extends java.lang.Object
implements java.io.Closeable

Utility class to read length-prefixed byte[] entries from an input. Complementary to Sort.ByteSequencesWriter.

Constructor Summary

Constructors

Constructor and Description
ByteSequencesReader(java.io.DataInput is)
ByteSequencesReader(java.io.File file)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the provided DataInput if it is Closeable.
byte[]	read() Reads the next entry and returns it if successful.
boolean	read(org.apache.lucene.util.BytesRef ref) Reads the next entry into the provided BytesRef.

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteSequencesReader

public ByteSequencesReader(java.io.File file)
                    throws java.io.IOException

Throws:

java.io.IOException

ByteSequencesReader

public ByteSequencesReader(java.io.DataInput is)

Method Detail

read

public boolean read(org.apache.lucene.util.BytesRef ref)
             throws java.io.IOException

Reads the next entry into the provided BytesRef. The internal storage is resized if needed.

Returns:

Returns false if EOF occurred when trying to read the header of the next sequence. Returns true otherwise.

Throws:

java.io.EOFException - if the file ends before the full sequence is read.

java.io.IOException

read

public byte[] read()
            throws java.io.IOException

Reads the next entry and returns it if successful.

Returns:

Returns null if EOF occurred before the next entry could be read.

Throws:

java.io.EOFException - if the file ends before the full sequence is read.

java.io.IOException

See Also:

read(BytesRef)

close

public void close()
           throws java.io.IOException

Closes the provided DataInput if it is Closeable.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException