HighlighterUnifiedOptionsStep (Red Hat JBoss Enterprise Application Platform 8.0.0.GA public API)

All Superinterfaces:

HighlighterFinalStep, HighlighterOptionsStep<HighlighterUnifiedOptionsStep>

All Known Implementing Classes:

HighlighterUnifiedOptionsStepImpl
```
public interface HighlighterUnifiedOptionsStep
extends HighlighterOptionsStep<HighlighterUnifiedOptionsStep>
```
The step in a unified highlighter definition where options can be set. Refer to your particular backend documentation for more detailed information on the exposed settings.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`HighlighterBoundaryScannerTypeStep<?,? extends HighlighterUnifiedOptionsStep>`	`boundaryScanner()`	Specify how the text should be broken up into highlighting snippets.
`HighlighterUnifiedOptionsStep`	`boundaryScanner(Consumer<? super HighlighterBoundaryScannerTypeStep<?,?>> boundaryScannerContributor)`	Specify how the text should be broken up into highlighting snippets.

Methods inherited from interface org.hibernate.search.engine.search.highlighter.dsl.HighlighterFinalStep
toHighlighter

Methods inherited from interface org.hibernate.search.engine.search.highlighter.dsl.HighlighterOptionsStep
encoder, fragmentSize, noMatchSize, numberOfFragments, orderByScore, tag

- Method Detail
  - boundaryScanner
```
HighlighterBoundaryScannerTypeStep<?,? extends HighlighterUnifiedOptionsStep> boundaryScanner()
```
    Specify how the text should be broken up into highlighting snippets.
    By default, a sentence boundary scanner is used.
    
    Returns:
    
    The next step in a highlighter definition exposing boundary scanner specific options.
  - boundaryScanner
```
HighlighterUnifiedOptionsStep boundaryScanner(Consumer<? super HighlighterBoundaryScannerTypeStep<?,?>> boundaryScannerContributor)
```
    Specify how the text should be broken up into highlighting snippets.
    By default, a sentence boundary scanner is used.
    
    Parameters:
    
    boundaryScannerContributor - A consumer that will configure a boundary scanner for this highlighter. Should generally be a lambda expression.
    
    Returns:
    
    The next step in a highlighter definition.