java.lang.Object
- org.apache.lucene.search.DocIdSetIterator
- - org.apache.lucene.index.PostingsEnum
  - - org.apache.lucene.codecs.lucene50.Lucene50PostingsReader.EverythingEnum

Enclosing class:: Lucene50PostingsReader

final class Lucene50PostingsReader.EverythingEnum
extends PostingsEnum

Field Summary

Fields
Modifier and Type	Field	Description
`private int`	`accum`
`private int`	`doc`
`private int`	`docBufferUpto`
`private int[]`	`docDeltaBuffer`
`private int`	`docFreq`
`(package private) IndexInput`	`docIn`
`private long`	`docTermStartFP`
`private int`	`docUpto`
`private byte[]`	`encoded`
`private int`	`endOffset`
`private int`	`freq`
`private int[]`	`freqBuffer`
`(package private) boolean`	`indexHasOffsets`
`(package private) boolean`	`indexHasPayloads`
`private long`	`lastPosBlockFP`
`private int`	`lastStartOffset`
`private boolean`	`needsOffsets`
`private boolean`	`needsPayloads`
`private int`	`nextSkipDoc`
`private int[]`	`offsetLengthBuffer`
`private int[]`	`offsetStartDeltaBuffer`
`(package private) IndexInput`	`payIn`
`(package private) BytesRef`	`payload`
`private byte[]`	`payloadBytes`
`private int`	`payloadByteUpto`
`private int`	`payloadLength`
`private int[]`	`payloadLengthBuffer`
`private long`	`payPendingFP`
`private long`	`payTermStartFP`
`private int`	`posBufferUpto`
`private int[]`	`posDeltaBuffer`
`(package private) IndexInput`	`posIn`
`private int`	`position`
`private int`	`posPendingCount`
`private long`	`posPendingFP`
`private long`	`posTermStartFP`
`private int`	`singletonDocID`
`private long`	`skipOffset`
`private boolean`	`skipped`
`private Lucene50SkipReader`	`skipper`
`(package private) IndexInput`	`startDocIn`
`private int`	`startOffset`
`private long`	`totalTermFreq`

Fields inherited from class org.apache.lucene.index.PostingsEnum
ALL, FREQS, NONE, OFFSETS, PAYLOADS, POSITIONS

Fields inherited from class org.apache.lucene.search.DocIdSetIterator
NO_MORE_DOCS

Constructor Summary

Constructors
Constructor Description

EverythingEnum(FieldInfo fieldInfo)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`advance(int target)`	Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself.
`boolean`	`canReuse(IndexInput docIn, FieldInfo fieldInfo)`
`long`	`cost()`	Returns the estimated cost of this `DocIdSetIterator`.
`int`	`docID()`	Returns the following: `-1` if `DocIdSetIterator.nextDoc()` or `DocIdSetIterator.advance(int)` were not called yet.
`int`	`endOffset()`	Returns end offset for the current position, or -1 if offsets were not indexed.
`int`	`freq()`	Returns term frequency in the current document, or 1 if the field was indexed with `IndexOptions.DOCS`.
`BytesRef`	`getPayload()`	Returns the payload at this position, or null if no payload was indexed.
`int`	`nextDoc()`	Advances to the next document in the set and returns the doc it is currently on, or `DocIdSetIterator.NO_MORE_DOCS` if there are no more docs in the set. NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.
`int`	`nextPosition()`	Returns the next position, or -1 if positions were not indexed.
`private void`	`refillDocs()`
`private void`	`refillPositions()`
`Lucene50PostingsReader.EverythingEnum`	`reset(Lucene50PostingsFormat.IntBlockTermState termState, int flags)`
`private void`	`skipPositions()`
`int`	`startOffset()`	Returns start offset for the current position, or -1 if offsets were not indexed.

Methods inherited from class org.apache.lucene.index.PostingsEnum
featureRequested

Methods inherited from class org.apache.lucene.search.DocIdSetIterator
all, empty, range, slowAdvance

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - encoded
```
private final byte[] encoded
```
  - docDeltaBuffer
```
private final int[] docDeltaBuffer
```
  - freqBuffer
```
private final int[] freqBuffer
```
  - posDeltaBuffer
```
private final int[] posDeltaBuffer
```
  - payloadLengthBuffer
```
private final int[] payloadLengthBuffer
```
  - offsetStartDeltaBuffer
```
private final int[] offsetStartDeltaBuffer
```
  - offsetLengthBuffer
```
private final int[] offsetLengthBuffer
```
  - payloadBytes
```
private byte[] payloadBytes
```
  - payloadByteUpto
```
private int payloadByteUpto
```
  - payloadLength
```
private int payloadLength
```
  - lastStartOffset
```
private int lastStartOffset
```
  - startOffset
```
private int startOffset
```
  - endOffset
```
private int endOffset
```
  - docBufferUpto
```
private int docBufferUpto
```
  - posBufferUpto
```
private int posBufferUpto
```
  - skipper
```
private Lucene50SkipReader skipper
```
  - skipped
```
private boolean skipped
```
  - startDocIn
```
final IndexInput startDocIn
```
  - docIn
```
IndexInput docIn
```
  - posIn
```
final IndexInput posIn
```
  - payIn
```
final IndexInput payIn
```
  - payload
```
final BytesRef payload
```
  - indexHasOffsets
```
final boolean indexHasOffsets
```
  - indexHasPayloads
```
final boolean indexHasPayloads
```
  - docFreq
```
private int docFreq
```
  - totalTermFreq
```
private long totalTermFreq
```
  - docUpto
```
private int docUpto
```
  - doc
```
private int doc
```
  - accum
```
private int accum
```
  - freq
```
private int freq
```
  - position
```
private int position
```
  - posPendingCount
```
private int posPendingCount
```
  - posPendingFP
```
private long posPendingFP
```
  - payPendingFP
```
private long payPendingFP
```
  - docTermStartFP
```
private long docTermStartFP
```
  - posTermStartFP
```
private long posTermStartFP
```
  - payTermStartFP
```
private long payTermStartFP
```
  - lastPosBlockFP
```
private long lastPosBlockFP
```
  - skipOffset
```
private long skipOffset
```
  - nextSkipDoc
```
private int nextSkipDoc
```
  - needsOffsets
```
private boolean needsOffsets
```
  - needsPayloads
```
private boolean needsPayloads
```
  - singletonDocID
```
private int singletonDocID
```
- Constructor Detail
  - EverythingEnum
```
public EverythingEnum(FieldInfo fieldInfo)
               throws java.io.IOException
```
    Throws:
    
    java.io.IOException
- Method Detail
  - canReuse
```
public boolean canReuse(IndexInput docIn,
                        FieldInfo fieldInfo)
```
  - reset
```
public Lucene50PostingsReader.EverythingEnum reset(Lucene50PostingsFormat.IntBlockTermState termState,
                                                   int flags)
                                            throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - freq
```
public int freq()
         throws java.io.IOException
```
    Description copied from class: PostingsEnum
    
    Returns term frequency in the current document, or 1 if the field was indexed with IndexOptions.DOCS. Do not call this before DocIdSetIterator.nextDoc() is first called, nor after DocIdSetIterator.nextDoc() returns DocIdSetIterator.NO_MORE_DOCS.
    NOTE: if the PostingsEnum was obtain with PostingsEnum.NONE, the result of this method is undefined.
    
    Specified by:
    
    freq in class PostingsEnum
    
    Throws:
    
    java.io.IOException
  - docID
```
public int docID()
```
    Description copied from class: DocIdSetIterator
    Returns the following:
    
    -1 if DocIdSetIterator.nextDoc() or DocIdSetIterator.advance(int) were not called yet.
    DocIdSetIterator.NO_MORE_DOCS if the iterator has exhausted.
    Otherwise it should return the doc ID it is currently on.
    Specified by:
    
    docID in class DocIdSetIterator
  - refillDocs
```
private void refillDocs()
                 throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - refillPositions
```
private void refillPositions()
                      throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - nextDoc
```
public int nextDoc()
            throws java.io.IOException
```
    Description copied from class: DocIdSetIterator
    
    Advances to the next document in the set and returns the doc it is currently on, or DocIdSetIterator.NO_MORE_DOCS if there are no more docs in the set.
    NOTE: after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.
    
    Specified by:
    
    nextDoc in class DocIdSetIterator
    
    Throws:
    
    java.io.IOException
  - advance
```
public int advance(int target)
            throws java.io.IOException
```
    Description copied from class: DocIdSetIterator
    Advances to the first beyond the current whose document number is greater than or equal to target, and returns the document number itself. Exhausts the iterator and returns DocIdSetIterator.NO_MORE_DOCS if target is greater than the highest document number in the set.
    The behavior of this method is undefined when called with target ≤ current, or after the iterator has exhausted. Both cases may result in unpredicted behavior.
    When target > current it behaves as if written:
    int advance(int target) { int doc; while ((doc = nextDoc()) < target) { } return doc; }
    Some implementations are considerably more efficient than that.
    NOTE: this method may be called with DocIdSetIterator.NO_MORE_DOCS for efficiency by some Scorers. If your implementation cannot efficiently determine that it should exhaust, it is recommended that you check for that value in each call to this method.
    Specified by:
    
    advance in class DocIdSetIterator
    
    Throws:
    
    java.io.IOException
  - skipPositions
```
private void skipPositions()
                    throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - nextPosition
```
public int nextPosition()
                 throws java.io.IOException
```
    Description copied from class: PostingsEnum
    
    Returns the next position, or -1 if positions were not indexed. Calling this more than PostingsEnum.freq() times is undefined.
    
    Specified by:
    
    nextPosition in class PostingsEnum
    
    Throws:
    
    java.io.IOException
  - startOffset
```
public int startOffset()
```
    Description copied from class: PostingsEnum
    
    Returns start offset for the current position, or -1 if offsets were not indexed.
    
    Specified by:
    
    startOffset in class PostingsEnum
  - endOffset
```
public int endOffset()
```
    Description copied from class: PostingsEnum
    
    Returns end offset for the current position, or -1 if offsets were not indexed.
    
    Specified by:
    
    endOffset in class PostingsEnum
  - getPayload
```
public BytesRef getPayload()
```
    Description copied from class: PostingsEnum
    
    Returns the payload at this position, or null if no payload was indexed. You should not modify anything (neither members of the returned BytesRef nor bytes in the byte[]).
    
    Specified by:
    
    getPayload in class PostingsEnum
  - cost
```
public long cost()
```
    Description copied from class: DocIdSetIterator
    
    Returns the estimated cost of this DocIdSetIterator.
    This is generally an upper bound of the number of documents this iterator might match, but may be a rough heuristic, hardcoded value, or otherwise completely inaccurate.
    
    Specified by:
    
    cost in class DocIdSetIterator

Class Lucene50PostingsReader.EverythingEnum

Field Summary

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

Fields inherited from class org.apache.lucene.search.DocIdSetIterator

Constructor Summary

Method Summary

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

Methods inherited from class org.apache.lucene.search.DocIdSetIterator

Methods inherited from class java.lang.Object

Field Detail

encoded

docDeltaBuffer

freqBuffer

posDeltaBuffer

payloadLengthBuffer

offsetStartDeltaBuffer

offsetLengthBuffer

payloadBytes

payloadByteUpto

payloadLength

lastStartOffset

startOffset

endOffset

docBufferUpto

posBufferUpto

skipper

skipped

startDocIn

docIn

posIn

payIn

payload

indexHasOffsets

indexHasPayloads

docFreq

totalTermFreq

docUpto

doc

accum

freq

position

posPendingCount

posPendingFP

payPendingFP

docTermStartFP

posTermStartFP

payTermStartFP

lastPosBlockFP

skipOffset

nextSkipDoc

needsOffsets

needsPayloads

singletonDocID

Constructor Detail

EverythingEnum

Method Detail

canReuse

reset

freq

docID

refillDocs

refillPositions

nextDoc

advance

skipPositions

nextPosition

startOffset

endOffset

getPayload

cost