Package org.hibernate.search.backend.elasticsearch.types.codec.impl

Class ElasticsearchBooleanFieldCodec

java.lang.Object

org.hibernate.search.backend.elasticsearch.types.codec.impl.ElasticsearchBooleanFieldCodec

All Implemented Interfaces:

ElasticsearchFieldCodec<Boolean>

public class ElasticsearchBooleanFieldCodec
extends Object
implements ElasticsearchFieldCodec<Boolean>

Field Summary

Fields

Modifier and Type	Field	Description
static ElasticsearchBooleanFieldCodec	INSTANCE

Method Summary

Modifier and Type	Method	Description
Boolean	decode(com.google.gson.JsonElement element)
Boolean	decodeAggregationKey(com.google.gson.JsonElement key, com.google.gson.JsonElement keyAsString)	Decodes the key returned by a term aggregation.
com.google.gson.JsonElement	encode(Boolean value)
boolean	isCompatibleWith(ElasticsearchFieldCodec<?> other)	Determine whether another codec is compatible with this one, i.e.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.search.backend.elasticsearch.types.codec.impl.ElasticsearchFieldCodec

encodeForAggregation, encodeForMissing

Field Detail

INSTANCE

public static final ElasticsearchBooleanFieldCodec INSTANCE

Method Detail

encode

public com.google.gson.JsonElement encode(Boolean value)

Specified by:

encode in interface ElasticsearchFieldCodec<Boolean>

decode

public Boolean decode(com.google.gson.JsonElement element)

Specified by:

decode in interface ElasticsearchFieldCodec<Boolean>

decodeAggregationKey

public Boolean decodeAggregationKey(com.google.gson.JsonElement key,
                                    com.google.gson.JsonElement keyAsString)

Description copied from interface: ElasticsearchFieldCodec

Decodes the key returned by a term aggregation.

Specified by:

decodeAggregationKey in interface ElasticsearchFieldCodec<Boolean>

Parameters:

key - The "key" property returned by the aggregation. May be a number, a string, ... depending on the field type.

keyAsString - The "key_as_string" property returned by the term aggregation. Either null or a JsonPrimitive containing a string.

Returns:

The decoded term.

isCompatibleWith

public boolean isCompatibleWith(ElasticsearchFieldCodec<?> other)

Description copied from interface: ElasticsearchFieldCodec

Determine whether another codec is compatible with this one, i.e. whether it will encode/decode the information to/from the document in a compatible way.

Specified by:

isCompatibleWith in interface ElasticsearchFieldCodec<Boolean>

Parameters:

other - Another ElasticsearchFieldCodec, never null.

Returns:

true if the given codec is compatible. false otherwise, or when in doubt.