Package org.apache.lucene.search.suggest
Class Sort.ByteSequencesReader
- java.lang.Object
-
- org.apache.lucene.search.suggest.Sort.ByteSequencesReader
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
- Enclosing class:
- Sort
public static class Sort.ByteSequencesReader extends Object implements Closeable
Utility class to read length-prefixed byte[] entries from an input. Complementary toSort.ByteSequencesWriter
.
-
-
Constructor Summary
Constructors Constructor Description ByteSequencesReader(DataInput is)
Constructs a ByteSequencesReader from the provided DataInputByteSequencesReader(File file)
Constructs a ByteSequencesReader from the provided File
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
byte[]
read()
Reads the next entry and returns it if successful.boolean
read(BytesRef ref)
Reads the next entry into the providedBytesRef
.
-
-
-
Constructor Detail
-
ByteSequencesReader
public ByteSequencesReader(File file) throws IOException
Constructs a ByteSequencesReader from the provided File- Throws:
IOException
-
ByteSequencesReader
public ByteSequencesReader(DataInput is)
Constructs a ByteSequencesReader from the provided DataInput
-
-
Method Detail
-
read
public boolean read(BytesRef ref) throws IOException
Reads the next entry into the providedBytesRef
. The internal storage is resized if needed.- Returns:
- Returns
false
if EOF occurred when trying to read the header of the next sequence. Returnstrue
otherwise. - Throws:
EOFException
- if the file ends before the full sequence is read.IOException
-
read
public byte[] read() throws IOException
Reads the next entry and returns it if successful.- Returns:
- Returns
null
if EOF occurred before the next entry could be read. - Throws:
EOFException
- if the file ends before the full sequence is read.IOException
- See Also:
read(BytesRef)
-
close
public void close() throws IOException
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
-
-