Package org.elasticsearch.xpack.esql.plan.logical

Record Class HighlightOptions.EnumOption

java.lang.Object
java.lang.Record
org.elasticsearch.xpack.esql.plan.logical.HighlightOptions.EnumOption
Enclosing class:
HighlightOptions
public static record HighlightOptions.EnumOption(String name, List<String> allowed, boolean caseInsensitive) extends Record
A string-valued enum option together with its allowed values and case-sensitivity. Shared by Highlight.postAnalysisVerification(org.elasticsearch.xpack.esql.common.Failures) and HighlightOptions.from(org.elasticsearch.xpack.esql.core.expression.MapExpression, org.elasticsearch.xpack.esql.core.expression.FoldContext) so the two paths can never disagree on the allowed set or whether matching is case-insensitive.

  • Constructor Details

    • EnumOption

      public EnumOption(String name, List<String> allowed, boolean caseInsensitive)
      Creates an instance of a EnumOption record class.
      Parameters:
      name - the value for the name record component
      allowed - the value for the allowed record component
      caseInsensitive - the value for the caseInsensitive record component

  • Method Details

    • normalize

      public String normalize(String raw)

    • isValid

      public boolean isValid(String raw)

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • allowed

      public List<String> allowed()
      Returns the value of the allowed record component.
      Returns:
      the value of the allowed record component

    • caseInsensitive

      public boolean caseInsensitive()
      Returns the value of the caseInsensitive record component.
      Returns:
      the value of the caseInsensitive record component