SMILA (incubation) API documentation

org.eclipse.smila.search.highlighting.transformer
Enum ComplexHLResultAggregation.TextHandling

java.lang.Object
  extended by java.lang.Enum<ComplexHLResultAggregation.TextHandling>
      extended by org.eclipse.smila.search.highlighting.transformer.ComplexHLResultAggregation.TextHandling
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ComplexHLResultAggregation.TextHandling>
Enclosing class:
ComplexHLResultAggregation

public static enum ComplexHLResultAggregation.TextHandling
extends java.lang.Enum<ComplexHLResultAggregation.TextHandling>

Enum TextHandling.


Enum Constant Summary
ReturnFullText
          Return the full text.
ReturnNoText
          Return no text.
ReturnSnipplet
          Return text snipplet.
 
Method Summary
static ComplexHLResultAggregation.TextHandling valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ComplexHLResultAggregation.TextHandling[] 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

ReturnFullText

public static final ComplexHLResultAggregation.TextHandling ReturnFullText
Return the full text.


ReturnNoText

public static final ComplexHLResultAggregation.TextHandling ReturnNoText
Return no text.


ReturnSnipplet

public static final ComplexHLResultAggregation.TextHandling ReturnSnipplet
Return text snipplet.

Method Detail

values

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

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

valueOf

public static ComplexHLResultAggregation.TextHandling valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

SMILA (incubation) API documentation