Package org.elasticsearch.common.document

Class DocumentField

java.lang.Object
org.elasticsearch.common.document.DocumentField
All Implemented Interfaces:
java.lang.Iterable<java.lang.Object>, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment
public class DocumentField
extends java.lang.Object
implements Writeable, org.elasticsearch.common.xcontent.ToXContentFragment, java.lang.Iterable<java.lang.Object>
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
    DocumentField​(java.lang.String name, java.util.List<java.lang.Object> values)  
    DocumentField​(StreamInput in)  

  • Method Summary

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

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

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

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

    isFragment

  • Constructor Details

    • DocumentField

      public DocumentField​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

    • DocumentField

      public DocumentField​(java.lang.String name, java.util.List<java.lang.Object> values)

  • Method Details

    • getName

      public java.lang.String getName()
      The name of the field.

    • getValue

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

    • getValues

      public java.util.List<java.lang.Object> getValues()
      The field values.

    • iterator

      public java.util.Iterator<java.lang.Object> iterator()
      Specified by:
      iterator in interface java.lang.Iterable<java.lang.Object>

    • 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

    • 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

    • fromXContent

      public static DocumentField fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException
      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

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object