Module org.apache.lucene.core

Package org.apache.lucene.index

Class PrefixCodedTerms.TermIterator

java.lang.Object

org.apache.lucene.index.FieldTermIterator

org.apache.lucene.index.PrefixCodedTerms.TermIterator

All Implemented Interfaces:

BytesRefIterator

Enclosing class:

PrefixCodedTerms

public static class PrefixCodedTerms.TermIterator
extends FieldTermIterator

An iterator over the list of terms stored in a PrefixCodedTerms.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final BytesRefBuilder	builder
(package private) final BytesRef	bytes
(package private) final long	delGen
(package private) final long	end
(package private) String	field
(package private) final ByteBuffersDataInput	input

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

EMPTY

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TermIterator(long delGen, ByteBuffersDataInput input)

Method Summary

Modifier and Type	Method	Description
long	delGen()	Del gen of the current term.
String	field()	Returns current field.
BytesRef	next()	Increments the iteration to the next BytesRef in the iterator.
private void	readTermBytes(int prefix, int suffix)

Methods inherited from class java.lang.Object

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

Field Details

input

final ByteBuffersDataInput input

builder

final BytesRefBuilder builder

bytes

final BytesRef bytes

end

final long end

delGen

final long delGen

field

String field

Constructor Details

TermIterator

private TermIterator(long delGen,
 ByteBuffersDataInput input)

Method Details

next

public BytesRef next()

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.

Returns:

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

readTermBytes

private void readTermBytes(int prefix,
 int suffix)
                    throws IOException

Throws:

IOException

field

public String field()

Returns current field. This method should not be called after iteration is done. Note that you may use == to detect a change in field.

Specified by:

field in class FieldTermIterator

delGen

public long delGen()

Del gen of the current term.

Specified by:

delGen in class FieldTermIterator