Package org.apache.lucene.codecs

Class FieldsProducer

java.lang.Object

org.apache.lucene.index.Fields

org.apache.lucene.codecs.FieldsProducer

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<String>

Direct Known Subclasses:

BlockTreeTermsReader

public abstract class FieldsProducer
extends Fields
implements Closeable

Abstract API that produces terms, doc, freq, prox, offset and payloads postings.

Field Summary

Fields inherited from class org.apache.lucene.index.Fields

EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FieldsProducer()	Sole constructor.

Method Summary

Modifier and Type	Method	Description
abstract void	close()
abstract long	ramBytesUsed()	Returns approximate RAM bytes used

Methods inherited from class org.apache.lucene.index.Fields

getUniqueTermCount, iterator, size, terms

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

FieldsProducer

protected FieldsProducer()

Sole constructor. (For invocation by subclass constructors, typically implicit.)

Method Details

close

public abstract void close()
                    throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

ramBytesUsed

public abstract long ramBytesUsed()

Returns approximate RAM bytes used