org.apache.lucene.util

Class OfflineSorter.ByteSequencesReader

java.lang.Object

org.apache.lucene.util.OfflineSorter.ByteSequencesReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, BytesRefIterator

Enclosing class:

OfflineSorter

public static class OfflineSorter.ByteSequencesReader
extends java.lang.Object
implements BytesRefIterator, java.io.Closeable

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

Field Summary

Fields

Modifier and Type	Field and Description
protected long	end
protected ChecksumIndexInput	in
protected java.lang.String	name

Fields inherited from interface org.apache.lucene.util.BytesRefIterator

EMPTY

Constructor Summary

Constructors

Constructor and Description
ByteSequencesReader(ChecksumIndexInput in, java.lang.String name) Constructs a ByteSequencesReader from the provided IndexInput

Method Summary

Modifier and Type	Method and Description
void	close() Closes the provided IndexInput.
BytesRef	next() 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

Field Detail

name

protected final java.lang.String name

in

protected final ChecksumIndexInput in

end

protected final long end

Constructor Detail

ByteSequencesReader

public ByteSequencesReader(ChecksumIndexInput in,
                           java.lang.String name)

Constructs a ByteSequencesReader from the provided IndexInput

Method Detail

next

public BytesRef next()
              throws java.io.IOException

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

Specified by:

next in interface BytesRefIterator

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 - If there is a low-level I/O error.

close

public void close()
           throws java.io.IOException

Closes the provided IndexInput.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException