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.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.xcontent.ToXContent
EMPTY, EMPTY_PARAMS
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal boolean
Text[]
The highlighted fragments.static HighlightField
fromXContent
(XContentParser parser) Text[]
The highlighted fragments.getName()
The name of the field highlighted.final int
hashCode()
name()
The name of the field highlighted.toString()
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.xcontent.ToXContentFragment
isFragment
-
Constructor Details
-
HighlightField
- Throws:
IOException
-
HighlightField
-
-
Method Details
-
name
The name of the field highlighted. -
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
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Throws:
IOException
-
fromXContent
- Throws:
IOException
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceToXContent
- Throws:
IOException
-
equals
-
hashCode
public final int hashCode()
-