Package com.atlassian.confluence.api.model.search

Class SearchOptions.Excerpt

java.lang.Object

com.atlassian.confluence.api.model.BaseApiEnum

com.atlassian.confluence.api.model.search.SearchOptions.Excerpt

All Implemented Interfaces:

ApiEnum

Enclosing class:

SearchOptions

public static class SearchOptions.Excerpt
extends BaseApiEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final List<SearchOptions.Excerpt>	BUILT_IN
static final SearchOptions.Excerpt	HIGHLIGHT	An excerpt that shows the matched text strings highlighted
static final SearchOptions.Excerpt	HIGHLIGHT_UNESCAPED	An excerpt is highlighted but NOT HTML escaped.
static final SearchOptions.Excerpt	INDEXED	An excerpt that displays a small initial segment of the indexed content
static final SearchOptions.Excerpt	INDEXED_UNESCAPED	An Excerpt that displays a small initial segment of the indexed content, but NOT HTML escaped
static final SearchOptions.Excerpt	NONE	An excerpt of the result is not required

Fields inherited from class com.atlassian.confluence.api.model.BaseApiEnum

value

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Excerpt(String value)

Method Summary

Methods inherited from class com.atlassian.confluence.api.model.BaseApiEnum

equals, getValue, hashCode, in, serialise, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

HIGHLIGHT

public static final SearchOptions.Excerpt HIGHLIGHT

An excerpt that shows the matched text strings highlighted

INDEXED

public static final SearchOptions.Excerpt INDEXED

An excerpt that displays a small initial segment of the indexed content

NONE

public static final SearchOptions.Excerpt NONE

An excerpt of the result is not required

HIGHLIGHT_UNESCAPED

public static final SearchOptions.Excerpt HIGHLIGHT_UNESCAPED

An excerpt is highlighted but NOT HTML escaped.

INDEXED_UNESCAPED

public static final SearchOptions.Excerpt INDEXED_UNESCAPED

An Excerpt that displays a small initial segment of the indexed content, but NOT HTML escaped

BUILT_IN

public static final List<SearchOptions.Excerpt> BUILT_IN

Constructor Details

Excerpt

protected Excerpt(String value)