## Uses of Class
org.apache.lucene.search.uhighlight.OffsetsEnum

- Packages that use OffsetsEnum
  Package | Description
  --- | ---
  org.apache.lucene.search.uhighlight | The UnifiedHighlighter -- a flexible highlighter that can get offsets from postings, term vectors, or analysis.

- - ### Uses of OffsetsEnum in org.apache.lucene.search.uhighlight

    Subclasses of OffsetsEnum in org.apache.lucene.search.uhighlight
    Modifier and Type | Class | Description
    --- | --- | ---
    `static class` | `OffsetsEnum.MultiOffsetsEnum` | A view over several OffsetsEnum instances, merging them in-place
    `static class` | `OffsetsEnum.OfMatchesIterator` | Based on a `MatchesIterator`; does not look at submatches.
    `static class` | `OffsetsEnum.OfMatchesIteratorWithSubs` | Based on a `MatchesIterator` with submatches.
    `static class` | `OffsetsEnum.OfPostings` | Based on a `PostingsEnum` -- the typical/standard OE impl.

    Fields in org.apache.lucene.search.uhighlight declared as OffsetsEnum
    Modifier and Type | Field | Description
    --- | --- | ---
    `static OffsetsEnum` | OffsetsEnum.`EMPTY` | Empty enumeration

    Methods in org.apache.lucene.search.uhighlight that return OffsetsEnum
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected OffsetsEnum` | FieldOffsetStrategy.`createOffsetsEnumFromReader​(LeafReader leafReader, int doc)` |
    `abstract OffsetsEnum` | FieldOffsetStrategy.`getOffsetsEnum​(LeafReader reader, int docId, String content)` | The primary method -- return offsets for highlightable words in the specified document.
    `OffsetsEnum` | MemoryIndexOffsetStrategy.`getOffsetsEnum​(LeafReader reader, int docId, String content)` |
    `OffsetsEnum` | NoOpOffsetStrategy.`getOffsetsEnum​(LeafReader reader, int docId, String content)` |
    `OffsetsEnum` | PostingsOffsetStrategy.`getOffsetsEnum​(LeafReader reader, int docId, String content)` |
    `OffsetsEnum` | PostingsWithTermVectorsOffsetStrategy.`getOffsetsEnum​(LeafReader leafReader, int docId, String content)` |
    `OffsetsEnum` | TermVectorOffsetStrategy.`getOffsetsEnum​(LeafReader reader, int docId, String content)` |
    `OffsetsEnum` | TokenStreamOffsetStrategy.`getOffsetsEnum​(LeafReader reader, int docId, String content)` |

    Methods in org.apache.lucene.search.uhighlight with parameters of type OffsetsEnum
    Modifier and Type | Method | Description
    --- | --- | ---
    `int` | OffsetsEnum.`compareTo​(OffsetsEnum other)` |
    `protected Passage[]` | FieldHighlighter.`highlightOffsetsEnums​(OffsetsEnum off)` |

    Method parameters in org.apache.lucene.search.uhighlight with type arguments of type OffsetsEnum
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected void` | FieldOffsetStrategy.`createOffsetsEnumsForAutomata​(Terms termsIndex, int doc, List<OffsetsEnum> results)` |
    `void` | PhraseHelper.`createOffsetsEnumsForSpans​(LeafReader leafReader, int docId, List<OffsetsEnum> results)` | Given the internal SpanQueries, produce a number of OffsetsEnum into the `results` param.
    `protected void` | FieldOffsetStrategy.`createOffsetsEnumsForTerms​(BytesRef[] sourceTerms, Terms termsIndex, int doc, List<OffsetsEnum> results)` |
    `protected void` | FieldOffsetStrategy.`createOffsetsEnumsWeightMatcher​(LeafReader _leafReader, int docId, List<OffsetsEnum> results)` |

    Constructor parameters in org.apache.lucene.search.uhighlight with type arguments of type OffsetsEnum
    Constructor | Description
    --- | ---
    `MultiOffsetsEnum​(List<OffsetsEnum> inner)` |