Package org.elasticsearch.search.fetch.subphase.highlight

Enum HighlightBuilder.Order

java.lang.Object
java.lang.Enum<HighlightBuilder.Order>
org.elasticsearch.search.fetch.subphase.highlight.HighlightBuilder.Order
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<HighlightBuilder.Order>, java.lang.constant.Constable, Writeable
Enclosing class:
HighlightBuilder
public static enum HighlightBuilder.Order
extends java.lang.Enum<HighlightBuilder.Order>
implements Writeable

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    Writeable.Reader<V>, Writeable.Writer<V>

  • Enum Constant Summary

    Enum Constants
    Enum Constant Description
    NONE  
    SCORE  

  • Method Summary

    Modifier and Type Method Description
    static HighlightBuilder.Order fromString​(java.lang.String order)  
    static HighlightBuilder.Order readFromStream​(StreamInput in)  
    java.lang.String toString()  
    static HighlightBuilder.Order valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static HighlightBuilder.Order[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.
    void writeTo​(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

  • Method Details

    • values

      public static HighlightBuilder.Order[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static HighlightBuilder.Order 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

    • readFromStream

      public static HighlightBuilder.Order readFromStream​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

    • writeTo

      public void writeTo​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      java.io.IOException

    • fromString

      public static HighlightBuilder.Order fromString​(java.lang.String order)

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Enum<HighlightBuilder.Order>