Package org.hibernate.search.engine.search.highlighter.dsl

Enum HighlighterEncoder

java.lang.Object

java.lang.Enum<HighlighterEncoder>

org.hibernate.search.engine.search.highlighter.dsl.HighlighterEncoder

All Implemented Interfaces:

Serializable, Comparable<HighlighterEncoder>

public enum HighlighterEncoder
extends Enum<HighlighterEncoder>

Defines how to encode the output snippets.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT	Text will be returned as is with no encoding.
HTML	Simple HTML escaping will be applied before the highlight tags are inserted into the output.

Method Summary

Modifier and Type	Method	Description
static HighlighterEncoder	valueOf(String name)	Returns the enum constant of this type with the specified name.
static HighlighterEncoder[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEFAULT

public static final HighlighterEncoder DEFAULT

Text will be returned as is with no encoding.

HTML

public static final HighlighterEncoder HTML

Simple HTML escaping will be applied before the highlight tags are inserted into the output.

Method Detail

values

public static HighlighterEncoder[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HighlighterEncoder c : HighlighterEncoder.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HighlighterEncoder valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null