Method Docs
Docs(IBits, DocsEnum)
Get DocsEnum for the current term. Do not
call this when the enum is unpositioned. This method
will not return null.
Declaration
public DocsEnum Docs(IBits liveDocs, DocsEnum reuse)Parameters
| Type | Name | Description |
|---|---|---|
| IBits | liveDocs | Unset bits are documents that should not be returned |
| DocsEnum | reuse | Pass a prior DocsEnum for possible reuse |
Returns
| Type | Description |
|---|---|
| DocsEnum |
Docs(IBits, DocsEnum, DocsFlags)
Get DocsEnum for the current term, with
control over whether freqs are required. Do not
call this when the enum is unpositioned. This method
will not return null.
Declaration
public abstract DocsEnum Docs(IBits liveDocs, DocsEnum reuse, DocsFlags flags)Parameters
| Type | Name | Description |
|---|---|---|
| IBits | liveDocs | Unset bits are documents that should not be returned |
| DocsEnum | reuse | Pass a prior DocsEnum for possible reuse |
| DocsFlags | flags | Specifies which optional per-document values you require; DocsFlags |
Returns
| Type | Description |
|---|---|
| DocsEnum |
