Module org.elasticsearch.server
Class HighlightField
java.lang.Object
org.elasticsearch.search.fetch.subphase.highlight.HighlightField
- All Implemented Interfaces:
Writeable,ToXContent,ToXContentFragment
A field highlighted with its highlighted fragments.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested 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.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal booleanText[]The highlighted fragments.static HighlightFieldfromXContent(XContentParser parser) final inthashCode()name()The name of the field highlighted.toString()toXContent(XContentBuilder builder, ToXContent.Params params) voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Constructor Details
-
HighlightField
- Throws:
IOException
-
HighlightField
-
-
Method Details
-
name
The name of the field highlighted. -
fragments
The highlighted fragments.nullif failed to highlight (for example, the field is not stored). -
toString
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
fromXContent
- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-
equals
-
hashCode
public final int hashCode()
-