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
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
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.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment
isFragment
-
-
-
-
Constructor Detail
-
HighlightField
public HighlightField(StreamInput in) throws java.io.IOException
- Throws:
java.io.IOException
-
HighlightField
public HighlightField(java.lang.String name, Text[] fragments)
-
-
Method Detail
-
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
public Text[] fragments()
The highlighted fragments.null
if failed to highlight (for example, the field is not stored).
-
getFragments
public Text[] 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
public void writeTo(StreamOutput out) throws java.io.IOException
Description copied from interface:Writeable
Write this into the StreamOutput.
-
fromXContent
public static HighlightField fromXContent(XContentParser parser) throws java.io.IOException
- 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
-
-