Package name.martingeisse.grumpyjson.builtin.helper_types

Class FieldMustBeNullConverter

java.lang.Object

name.martingeisse.grumpyjson.builtin.helper_types.FieldMustBeNullConverter

All Implemented Interfaces:

JsonDeserializer, JsonSerializer<FieldMustBeNull>

public final class FieldMustBeNullConverter
extends Object
implements JsonSerializer<FieldMustBeNull>, JsonDeserializer

The converter for FieldMustBeNull.

This converter is registered by default, and only needs to be manually registered if it gets removed, such as by calling JsonRegistries.clear().

Constructor Summary

Constructors

Constructor	Description
FieldMustBeNullConverter()	Constructor

Method Summary

Modifier and Type	Method	Description
FieldMustBeNull	deserialize(JsonElement json, Type type)	Converts a value from JSON.
JsonElement	serialize(FieldMustBeNull value)	Converts a value to JSON.
boolean	supportsClassForSerialization(Class<?> clazz)	Checks if this serializer supports the specified class.
boolean	supportsTypeForDeserialization(Type type)	Checks if this deserializer supports the specified type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface name.martingeisse.grumpyjson.deserialize.JsonDeserializer

deserializeAbsent

Methods inherited from interface name.martingeisse.grumpyjson.serialize.JsonSerializer

serializeOptional

Constructor Details

FieldMustBeNullConverter

public FieldMustBeNullConverter()

Constructor

Method Details

supportsTypeForDeserialization

public boolean supportsTypeForDeserialization(Type type)

Description copied from interface: JsonDeserializer

Checks if this deserializer supports the specified type.

Specified by:

supportsTypeForDeserialization in interface JsonDeserializer

Parameters:

type - the type to check

Returns:

true if supported, false if not

deserialize

public FieldMustBeNull deserialize(JsonElement json,
 Type type)
                            throws JsonDeserializationException

Description copied from interface: JsonDeserializer

Converts a value from JSON.

This method must not be called with a type for which JsonDeserializer.supportsTypeForDeserialization(Type) returns false. Calling it with such types anyway results in undefined behavior.

Specified by:

deserialize in interface JsonDeserializer

Parameters:

json - the JSON

type - the type to deserialize

Returns:

the deserialized value

Throws:

JsonDeserializationException - if the JSON does not match the expected structure

supportsClassForSerialization

public boolean supportsClassForSerialization(Class<?> clazz)

Description copied from interface: JsonSerializer

Checks if this serializer supports the specified class.

Specified by:

supportsClassForSerialization in interface JsonSerializer<FieldMustBeNull>

Parameters:

clazz - the class to check

Returns:

true if supported, false if not

serialize

public JsonElement serialize(FieldMustBeNull value)
                      throws JsonSerializationException

Description copied from interface: JsonSerializer

Converts a value to JSON.

This method must not be called with values for whose class JsonSerializer.supportsClassForSerialization(Class) returns false. Calling it with such values anyway results in undefined behavior.

This method is not supported for values that can vanish during serialization, such as OptionalField -- JsonSerializer.serializeOptional(Object) should be called instead. If this method is called with such values anyway, it should always fail, even when the value does not vanish, to capture bugs early. Examples where this happens: - in a list of OptionalFields. While we could simply remove vanishing elements, doing so is just a weird way of filtering the list before serialization, which can be done the usual way. Moreover, there is no useful interpretation of a list-of-OptionalField during deserialization since all elements found in the JSON are known to be present, and vanishing elements cannot be found. - when turning a top-level OptionalField to JSON - when nesting two OptionalFields

Specified by:

serialize in interface JsonSerializer<FieldMustBeNull>

Parameters:

value - the value to convert to JSON

Returns:

the generated JSON

Throws:

JsonSerializationException - if the value is in an inconsistent state, or in a state that cannot be converted to JSON