HighlightField (elasticsearch-extend 3.2 API)

java.lang.Object
- org.elasticsearch.search.fetch.subphase.highlight.HighlightField

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment
```
public class HighlightField
extends 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(String name, Text[] fragments)

HighlightField(StreamInput in)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`Text[]`	`fragments()`	The highlighted fragments.
`static HighlightField`	`fromXContent(XContentParser parser)`
`Text[]`	`getFragments()`	The highlighted fragments.
`String`	`getName()`	The name of the field highlighted.
`int`	`hashCode()`
`String`	`name()`	The name of the field highlighted.
`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 IOException

Throws:: IOException

HighlightField

public HighlightField(String name,
                      Text[] fragments)

Method Detail
- name
```
public String name()
```
  The name of the field highlighted.
- getName
```
public 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 String toString()
```
  Overrides:
  
  toString in class Object
- writeTo
```
public void writeTo(StreamOutput out)
             throws IOException
```
  Description copied from interface: Writeable
  
  Write this into the StreamOutput.
  
  Specified by:
  
  writeTo in interface Writeable
  
  Throws:
  
  IOException
- fromXContent
```
public static HighlightField fromXContent(XContentParser parser)
                                   throws IOException
```
  Throws:
  
  IOException
- toXContent
```
public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException
```
  Specified by:
  
  toXContent in interface ToXContent
  
  Throws:
  
  IOException
- equals
```
public final boolean equals(Object obj)
```
  Overrides:
  
  equals in class Object
- hashCode
```
public final int hashCode()
```
  Overrides:
  
  hashCode in class Object