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

Enum HighlighterTagSchema

java.lang.Object

java.lang.Enum<HighlighterTagSchema>

org.hibernate.search.engine.search.highlighter.dsl.HighlighterTagSchema

All Implemented Interfaces:

Serializable, Comparable<HighlighterTagSchema>

public enum HighlighterTagSchema
extends Enum<HighlighterTagSchema>

Defines a set of predefined pre-/post- tags.

Enum Constant Summary

Enum Constants

Enum Constant	Description
STYLED	Defines pre tags as: <em class="hlt1">, <em class="hlt2">, <em class="hlt3">, <em class="hlt4">, <em class="hlt5">, <em class="hlt6">, <em class="hlt7">, <em class="hlt8">, <em class="hlt9">, <em class="hlt10"> and post tag as </em>

Method Summary

Modifier and Type	Method	Description
static HighlighterTagSchema	valueOf(String name)	Returns the enum constant of this type with the specified name.
static HighlighterTagSchema[]	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

STYLED

public static final HighlighterTagSchema STYLED

Defines pre tags as: <em class="hlt1">, <em class="hlt2">, <em class="hlt3">, <em class="hlt4">, <em class="hlt5">, <em class="hlt6">, <em class="hlt7">, <em class="hlt8">, <em class="hlt9">, <em class="hlt10"> and post tag as </em>

Method Detail

values

public static HighlighterTagSchema[] 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 (HighlighterTagSchema c : HighlighterTagSchema.values())
    System.out.println(c);

Returns:

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

valueOf

public static HighlighterTagSchema 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