com.atlassian.confluence.search.v2

Class DefaultHighlightParams

java.lang.Object

com.atlassian.confluence.search.v2.DefaultHighlightParams

All Implemented Interfaces:

HightlightParams

public class DefaultHighlightParams
extends Object
implements HightlightParams

Since:

5.10

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ENCODER
static String	NONE_ENCODER

Constructor Summary

Constructors

Constructor and Description
DefaultHighlightParams() Deprecated. since 5.10.5 Use the other constructors
DefaultHighlightParams(SearchQuery query) Constructs a parameter object used for highlighting
DefaultHighlightParams(String encoder) Deprecated. since 5.10.5 Use the other constructors
DefaultHighlightParams(String encoder, SearchQuery query) Constructs a parameter object used for highlighting

Method Summary

Modifier and Type	Method and Description
String	getEncoder() The encoding required for highlight result.
String	getPostTag()
String	getPreTag()
SearchQuery	getQuery()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_ENCODER

public static final String DEFAULT_ENCODER

See Also:

Constant Field Values

NONE_ENCODER

public static final String NONE_ENCODER

See Also:

Constant Field Values

Constructor Detail

DefaultHighlightParams

@Deprecated
public DefaultHighlightParams()

Deprecated. since 5.10.5 Use the other constructors

This will use the default query, which will not highlight query terms.

DefaultHighlightParams

public DefaultHighlightParams(SearchQuery query)

Constructs a parameter object used for highlighting

Parameters:

query - the query used to highlight query terms in the search result

DefaultHighlightParams

@Deprecated
public DefaultHighlightParams(String encoder)

Deprecated. since 5.10.5 Use the other constructors

This will use the default query, which will not highlight query terms.

DefaultHighlightParams

public DefaultHighlightParams(String encoder,
                              SearchQuery query)

Constructs a parameter object used for highlighting

Parameters:

encoder - the encoder to use

query - the query used to highlight query terms in the search result

Since:

5.10.5

Method Detail

getPreTag

public String getPreTag()

Specified by:

getPreTag in interface HightlightParams

getPostTag

public String getPostTag()

Specified by:

getPostTag in interface HightlightParams

getEncoder

public String getEncoder()

Description copied from interface: HightlightParams

The encoding required for highlight result. Use NoOpEncoder to bypass encoding.

Specified by:

getEncoder in interface HightlightParams

Returns:

"html" if html encoding is required. "none" for bypassing encoding.

getQuery

public SearchQuery getQuery()

Specified by:

getQuery in interface HightlightParams