Class HighlightField
java.lang.Object
org.elasticsearch.search.fetch.subphase.highlight.HighlightField
- All Implemented Interfaces:
Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentFragment
public class HighlightField extends java.lang.Object implements org.elasticsearch.common.xcontent.ToXContentFragment, Writeable
A field highlighted with its highlighted fragments.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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(org.elasticsearch.common.xcontent.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()
org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.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 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
public static HighlightField fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- 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
-