public abstract class

TermEnum

extends Object
implements Closeable
java.lang.Object
   ↳ org.apache.lucene.index.TermEnum
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Abstract class for enumerating terms.

Term enumerations are always ordered by Term.compareTo(). Each term in the enumeration is greater than all that precede it.

Summary

Public Constructors
TermEnum()
Public Methods
abstract void close()
Closes the enumeration to further activity, freeing resources.
abstract int docFreq()
Returns the docFreq of the current Term in the enumeration.
abstract boolean next()
Increments the enumeration to the next element.
abstract Term term()
Returns the current Term in the enumeration.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.io.Closeable

Public Constructors

public TermEnum ()

Public Methods

public abstract void close ()

Closes the enumeration to further activity, freeing resources.

Throws
IOException

public abstract int docFreq ()

Returns the docFreq of the current Term in the enumeration.

public abstract boolean next ()

Increments the enumeration to the next element. True if one exists.

Throws
IOException

public abstract Term term ()

Returns the current Term in the enumeration.