Module org.apache.lucene.suggest

Package org.apache.lucene.search.suggest.fst

Class ExternalRefSorter.ByteSequenceIterator

java.lang.Object

org.apache.lucene.search.suggest.fst.ExternalRefSorter.ByteSequenceIterator

All Implemented Interfaces:

Closeable, AutoCloseable, BytesRefIterator

Enclosing class:

ExternalRefSorter

public static class ExternalRefSorter.ByteSequenceIterator
extends Object
implements BytesRefIterator, Closeable

Iterates over BytesRefs in a file, closes the reader when the iterator is exhausted.

Field Summary

Fields

Modifier and Type	Field	Description
private final OfflineSorter.ByteSequencesReader	reader

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

EMPTY

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ByteSequenceIterator(OfflineSorter.ByteSequencesReader reader)

Method Summary

Modifier and Type	Method	Description
void	close()
BytesRef	next()	Increments the iteration to the next BytesRef in the iterator.

Methods inherited from class java.lang.Object

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

Field Details

reader

private final OfflineSorter.ByteSequencesReader reader

Constructor Details

ByteSequenceIterator

private ByteSequenceIterator(OfflineSorter.ByteSequencesReader reader)

Method Details

next

public BytesRef next()
              throws IOException

Description copied from interface: BytesRefIterator

Increments the iteration to the next BytesRef in the iterator. Returns the resulting BytesRef or null if the end of the iterator is reached. The returned BytesRef may be re-used across calls to next. After this method returns null, do not call it again: the results are undefined.

Specified by:

next in interface BytesRefIterator

Returns:

the next BytesRef in the iterator or null if the end of the iterator is reached.

Throws:

IOException - If there is a low-level I/O error.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException