Class DocumentField
java.lang.Object
org.elasticsearch.common.document.DocumentField
- All Implemented Interfaces:
java.lang.Iterable<java.lang.Object>
,Writeable
,ToXContent
,ToXContentFragment
public class DocumentField extends java.lang.Object implements Writeable, ToXContentFragment, java.lang.Iterable<java.lang.Object>
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
-
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(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()
boolean
isMetadataField()
java.util.Iterator<java.lang.Object>
iterator()
java.lang.String
toString()
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.
-
Constructor Details
-
DocumentField
- 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. -
isMetadataField
public boolean isMetadataField()- Returns:
- The field is a metadata field
-
iterator
public java.util.Iterator<java.lang.Object> iterator()- Specified by:
iterator
in interfacejava.lang.Iterable<java.lang.Object>
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
fromXContent
- Throws:
java.io.IOException
-
equals
public boolean equals(java.lang.Object o)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-