Class HighlightField
java.lang.Object
org.elasticsearch.search.fetch.subphase.highlight.HighlightField
- All Implemented Interfaces:
Writeable
,ToXContent
,ToXContentFragment
public class HighlightField extends java.lang.Object implements ToXContentFragment, Writeable
A field highlighted with its highlighted fragments.
-
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 HighlightField(java.lang.String name, Text[] fragments)
HighlightField(StreamInput in)
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object obj)
Text[]
fragments()
The highlighted fragments.static HighlightField
fromXContent(XContentParser parser)
Text[]
getFragments()
The highlighted fragments.java.lang.String
getName()
The name of the field highlighted.int
hashCode()
java.lang.String
name()
The name of the field highlighted.java.lang.String
toString()
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.
-
Constructor Details
-
HighlightField
- Throws:
java.io.IOException
-
HighlightField
-
-
Method Details
-
name
public java.lang.String name()The name of the field highlighted. -
getName
public java.lang.String getName()The name of the field highlighted. -
fragments
The highlighted fragments.null
if failed to highlight (for example, the field is not stored). -
getFragments
The highlighted fragments.null
if failed to highlight (for example, the field is not stored). -
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
fromXContent
- Throws:
java.io.IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
equals
public final boolean equals(java.lang.Object obj)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-