Package org.elasticsearch.search.fetch.subphase

Class FieldAndFormat

java.lang.Object
org.elasticsearch.search.fetch.subphase.FieldAndFormat
All Implemented Interfaces:
Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public final class FieldAndFormat
extends java.lang.Object
implements Writeable, org.elasticsearch.common.xcontent.ToXContentObject
Wrapper around a field name and the format that should be used to display values of this field.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

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

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

  • Field Summary

    Fields
    Modifier and Type Field Description
    java.lang.String field
    The name of the field.
    java.lang.String format
    The format of the field, or null if defaults should be used.
    java.lang.Boolean includeUnmapped
    Whether to include unmapped fields or not.

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor Description
    FieldAndFormat​(java.lang.String field, java.lang.String format)  
    FieldAndFormat​(java.lang.String field, java.lang.String format, java.lang.Boolean includeUnmapped)  
    FieldAndFormat​(StreamInput in)
    Serialization constructor.

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object o)  
    static FieldAndFormat fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)
    Parse a FieldAndFormat from some XContent.
    int hashCode()  
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    void writeTo​(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

    isFragment

  • Field Details

    • field

      public final java.lang.String field
      The name of the field.

    • format

      public final java.lang.String format
      The format of the field, or null if defaults should be used.

    • includeUnmapped

      public final java.lang.Boolean includeUnmapped
      Whether to include unmapped fields or not.

  • Constructor Details

    • FieldAndFormat

      public FieldAndFormat​(java.lang.String field, @Nullable java.lang.String format)

    • FieldAndFormat

      public FieldAndFormat​(java.lang.String field, @Nullable java.lang.String format, @Nullable java.lang.Boolean includeUnmapped)

    • FieldAndFormat

      public FieldAndFormat​(StreamInput in) throws java.io.IOException
      Serialization constructor.
      Throws:
      java.io.IOException

  • Method Details

    • fromXContent

      public static FieldAndFormat fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException
      Parse a FieldAndFormat from some XContent.
      Throws:
      java.io.IOException

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      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

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object