DocValueFieldsContext.FieldAndFormat (server 6.8.23 API)

java.lang.Object
- org.elasticsearch.search.fetch.subphase.DocValueFieldsContext.FieldAndFormat

All Implemented Interfaces:

Writeable

Enclosing class:

DocValueFieldsContext
```
public static final class DocValueFieldsContext.FieldAndFormat
extends java.lang.Object
implements Writeable
```
Wrapper around a field name and the format that should be used to display values of this field.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
  Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields
Modifier and Type Field Description

java.lang.String field
The name of the field.

java.lang.String format
The format of the field, or null if defaults should be used.

Constructor Summary

Constructors
Constructor	Description
`FieldAndFormat(java.lang.String field, java.lang.String format)`	Sole constructor.
`FieldAndFormat(StreamInput in)`	Serialization constructor.

Method Summary

Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object obj)`
`static DocValueFieldsContext.FieldAndFormat`	`fromXContent(XContentParser parser)`	Parse a `DocValueFieldsContext.FieldAndFormat` from some `XContent`.
`int`	`hashCode()`
`void`	`writeTo(StreamOutput out)`	Write this into the StreamOutput.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail
- field
```
public final java.lang.String field
```
  The name of the field.
- format
```
public final java.lang.String format
```
  The format of the field, or null if defaults should be used.

Constructor Detail

FieldAndFormat

public FieldAndFormat(java.lang.String field,
                      @Nullable
                      java.lang.String format)

Sole constructor.

FieldAndFormat

public FieldAndFormat(StreamInput in)
               throws java.io.IOException

Serialization constructor.

Throws:: java.io.IOException

Method Detail
- fromXContent
```
public static DocValueFieldsContext.FieldAndFormat fromXContent(XContentParser parser)
                                                         throws java.io.IOException
```
  Parse a DocValueFieldsContext.FieldAndFormat from some XContent.
  
  Throws:
  
  java.io.IOException
- writeTo
```
public void writeTo(StreamOutput out)
             throws java.io.IOException
```
  Description copied from interface: Writeable
  
  Write this into the StreamOutput.
  
  Specified by:
  
  writeTo in interface Writeable
  
  Throws:
  
  java.io.IOException
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class java.lang.Object
- equals
```
public boolean equals(java.lang.Object obj)
```
  Overrides:
  
  equals in class java.lang.Object