Class EnumMapCodec<K extends Enum<K>, V>

java.lang.Object

com.hypixel.hytale.codec.codecs.map.EnumMapCodec<K,V>

All Implemented Interfaces:

Codec<Map<K,V>>, RawJsonCodec<Map<K,V>>, SchemaConvertable<Map<K,V>>, WrappedCodec<V>

public class EnumMapCodec<K extends Enum<K>, V>
extends Object
implements Codec<Map<K,V>>, WrappedCodec<V>

Since:

30/6/17.

Version:

1.0

Field Summary

Fields inherited from interface Codec

BASE64_PATTERN, BOOLEAN, BSON_DOCUMENT, BYTE, BYTE_ARRAY, DOUBLE, DOUBLE_ARRAY, DURATION, DURATION_SECONDS, FLOAT, FLOAT_ARRAY, INSTANT, INT_ARRAY, INTEGER, LOG_LEVEL, LONG, LONG_ARRAY, NULLABLE_BOOLEAN, PATH, SHORT, STRING, STRING_ARRAY, UUID_BINARY, UUID_STRING

Constructor Summary

Constructors

Constructor	Description
EnumMapCodec(Class<K> clazz, Codec<V> codec)
EnumMapCodec(Class<K> clazz, Codec<V> codec, boolean unmodifiable)
EnumMapCodec(Class<K> clazz, Codec<V> codec, Supplier<Map<K,V>> supplier)
EnumMapCodec(Class<K> clazz, Codec<V> codec, Supplier<Map<K,V>> supplier, boolean unmodifiable)
EnumMapCodec(Class<K> clazz, EnumCodec.EnumStyle enumStyle, Codec<V> codec, Supplier<Map<K,V>> supplier, boolean unmodifiable)

Method Summary

Modifier and Type	Method	Description
EnumMapCodec<K,V>	allowNullValues()	Accepts explicit null values, decoded as null map entries.
Map<K,V>	decode(org.bson.BsonValue bsonValue, ExtraInfo extraInfo)
Map<K,V>	decodeJson(RawJsonReader reader, ExtraInfo extraInfo)
EnumMapCodec<K,V>	documentKey(K key, String doc)
org.bson.BsonValue	encode(Map<K,V> map, ExtraInfo extraInfo)
Codec<V>	getChildCodec()
Schema	toSchema(SchemaContext context)	Returns a schema object that represents this codec as JSON Schema.

Methods inherited from class Object

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

Methods inherited from interface Codec

decode, encode

Methods inherited from interface RawJsonCodec

decodeJson

Methods inherited from interface SchemaConvertable

toSchema

Constructor Details

EnumMapCodec

public EnumMapCodec(@Nonnull
 Class<K> clazz,
 Codec<V> codec)

EnumMapCodec

public EnumMapCodec(@Nonnull
 Class<K> clazz,
 Codec<V> codec,
 boolean unmodifiable)

EnumMapCodec

public EnumMapCodec(@Nonnull
 Class<K> clazz,
 Codec<V> codec,
 Supplier<Map<K,V>> supplier)

EnumMapCodec

public EnumMapCodec(@Nonnull
 Class<K> clazz,
 Codec<V> codec,
 Supplier<Map<K,V>> supplier,
 boolean unmodifiable)

EnumMapCodec

public EnumMapCodec(@Nonnull
 Class<K> clazz,
 EnumCodec.EnumStyle enumStyle,
 Codec<V> codec,
 Supplier<Map<K,V>> supplier,
 boolean unmodifiable)

Method Details

documentKey

@Nonnull
public EnumMapCodec<K,V> documentKey(K key,
 String doc)

allowNullValues

@Nonnull
public EnumMapCodec<K,V> allowNullValues()

Accepts explicit null values, decoded as null map entries. Lets a child document remove an inherited entry when the consumer merges child over parent (a null entry marks the key for removal).

getChildCodec

public Codec<V> getChildCodec()

Specified by:

getChildCodec in interface WrappedCodec<K extends Enum<K>>

decode

public Map<K,V> decode(@Nonnull
 org.bson.BsonValue bsonValue,
 @Nonnull
 ExtraInfo extraInfo)

Specified by:

decode in interface Codec<K extends Enum<K>>

encode

@Nonnull
public org.bson.BsonValue encode(@Nonnull
 Map<K,V> map,
 ExtraInfo extraInfo)

Specified by:

encode in interface Codec<K extends Enum<K>>

decodeJson

public Map<K,V> decodeJson(@Nonnull
 RawJsonReader reader,
 @Nonnull
 ExtraInfo extraInfo)
                    throws IOException

Specified by:

decodeJson in interface Codec<K extends Enum<K>>

Specified by:

decodeJson in interface RawJsonCodec<K extends Enum<K>>

Throws:

IOException

toSchema

@Nonnull
public Schema toSchema(@Nonnull
 SchemaContext context)

Description copied from interface: SchemaConvertable

Returns a schema object that represents this codec as JSON Schema.

Specified by:

toSchema in interface SchemaConvertable<K extends Enum<K>>

Parameters:

context - A context to use to assist with creating the schema.

Returns:

the generated schema.