Package org.elasticsearch.common.document

Class DocumentField

org.elasticsearch.common.document.DocumentField
All Implemented Interfaces:
<>, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment
public class DocumentField extends implements <>
A single field name and values part of SearchHit and GetResult.
See Also:
SearchHit, GetResult

  • 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 inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
     name, <> values)
     
    DocumentField​(StreamInput in)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     o)
     
    static DocumentField
    fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)
     
    getName()
    The name of the field.
    <V> V
    getValue()
    The first value of the hit.
    <>
    getValues()
    The field values.
    int
    hashCode()
     
    <>
    iterator()
     
    toString()
     
    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.

    , , , , , , ,

    Methods inherited from interface java.lang.

    ,

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

    isFragment

  • Constructor Details

    • DocumentField

      public DocumentField​(StreamInput in) throws
      Throws:

    • DocumentField

      public DocumentField​( name, <> values)

  • Method Details

    • getName

      public  getName()
      The name of the field.

    • getValue

      public <V> V getValue()
      The first value of the hit.

    • getValues

      public <> getValues()
      The field values.

    • iterator

      public <> iterator()
      Specified by:
       in interface <>

    • writeTo

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

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:

    • fromXContent

      public static DocumentField fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) throws
      Throws:

    • equals

      public boolean equals​( o)
      Overrides:
       in class 

    • hashCode

      public int hashCode()
      Overrides:
       in class 

    • toString

      public  toString()
      Overrides:
       in class