Method DocsAndPositions
DocsAndPositions(IBits, DocsAndPositionsEnum)
Get DocsAndPositionsEnum for the current term.
Do not call this when the enum is unpositioned. This
method will return null if positions were not
indexed.
Declaration
public DocsAndPositionsEnum DocsAndPositions(IBits liveDocs, DocsAndPositionsEnum reuse)Parameters
| Type | Name | Description |
|---|---|---|
| IBits | liveDocs | Unset bits are documents that should not be returned |
| DocsAndPositionsEnum | reuse | Pass a prior DocsAndPositionsEnum for possible reuse |
Returns
| Type | Description |
|---|---|
| DocsAndPositionsEnum |
See Also
DocsAndPositions(IBits, DocsAndPositionsEnum, DocsAndPositionsFlags)
Get DocsAndPositionsEnum for the current term,
with control over whether offsets and payloads are
required. Some codecs may be able to optimize their
implementation when offsets and/or payloads are not required.
Do not call this when the enum is unpositioned. This
will return null if positions were not indexed.
Declaration
public abstract DocsAndPositionsEnum DocsAndPositions(IBits liveDocs, DocsAndPositionsEnum reuse, DocsAndPositionsFlags flags)Parameters
| Type | Name | Description |
|---|---|---|
| IBits | liveDocs | Unset bits are documents that should not be returned |
| DocsAndPositionsEnum | reuse | Pass a prior DocsAndPositionsEnum for possible reuse |
| DocsAndPositionsFlags | flags | Specifies which optional per-position values you require; see DocsAndPositionsFlags. |
Returns
| Type | Description |
|---|---|
| DocsAndPositionsEnum |
