com.vaadin.server

Class JsonCodec

java.lang.Object

com.vaadin.server.JsonCodec

All Implemented Interfaces:

Serializable

public class JsonCodec
extends Object
implements Serializable

Decoder for converting RPC parameters and other values from JSON in transfer between the client and the server and vice versa.

Since:

7.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JsonCodec.BeanProperty

Method Summary

Modifier and Type	Method and Description
static Object	decodeCustomType(Type targetType, JsonValue value, ConnectorTracker connectorTracker)
static Object	decodeInternalOrCustomType(Type targetType, JsonValue value, ConnectorTracker connectorTracker)
static Object	decodeInternalType(Type targetType, boolean restrictToInternalTypes, JsonValue encodedJsonValue, ConnectorTracker connectorTracker) Decodes a value that is of an internal type.
static EncodeResult	encode(Object value, JsonValue diffState, Type valueType, ConnectorTracker connectorTracker)
static Collection<JsonCodec.BeanProperty>	getProperties(Class<?> type)
static boolean	isInternalTransportType(String transportType)
static boolean	isInternalType(Type type)
static boolean	jsonEquals(JsonValue a, JsonValue b) Compares two json values for deep equality.
static <TYPE> void	setCustomSerializer(Class<TYPE> clazz, JSONSerializer<TYPE> jsonSerializer) Set a custom JSONSerializer for a specific Class.

Methods inherited from class java.lang.Object

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

Method Detail

isInternalTransportType

public static boolean isInternalTransportType(String transportType)

isInternalType

public static boolean isInternalType(Type type)

decodeInternalOrCustomType

public static Object decodeInternalOrCustomType(Type targetType,
                                                JsonValue value,
                                                ConnectorTracker connectorTracker)

decodeCustomType

public static Object decodeCustomType(Type targetType,
                                      JsonValue value,
                                      ConnectorTracker connectorTracker)

decodeInternalType

public static Object decodeInternalType(Type targetType,
                                        boolean restrictToInternalTypes,
                                        JsonValue encodedJsonValue,
                                        ConnectorTracker connectorTracker)

Decodes a value that is of an internal type.

Ensures the encoded value is of the same type as target type.

Allows restricting collections so that they must be declared using generics. If this is used then all objects in the collection are encoded using the declared type. Otherwise only internal types are allowed in collections.

Parameters:

targetType - The type that should be returned by this method

restrictToInternalTypes -

encodedJsonValue -

connectorTracker -

Returns:

setCustomSerializer

public static <TYPE> void setCustomSerializer(Class<TYPE> clazz,
                                              JSONSerializer<TYPE> jsonSerializer)

Set a custom JSONSerializer for a specific Class. Existence of custom serializers is checked after basic types (Strings, Booleans, Numbers, Characters), Collections and Maps, so setting custom serializers for these won't have any effect.

To remove a previously set serializer, call this method with the second parameter set to null.

Custom serializers should only be added from static initializers or other places that are guaranteed to run only once. Trying to add a serializer to a class that already has one will cause an exception.

Warning: removing existing custom serializers may lead into unexpected behavior in components that expect the customized data. The framework's custom serializers are loaded in the static initializer block of this class.

Parameters:

clazz - The target class.

jsonSerializer - Custom JSONSerializer to add. If null, remove custom serializer from class clazz.

Throws:

IllegalArgumentException - Thrown if parameter clazz is null.

IllegalStateException - Thrown if serializer for parameter clazz is already registered and parameter jsonSerializer is not null.

See Also:

DateSerializer

encode

public static EncodeResult encode(Object value,
                                  JsonValue diffState,
                                  Type valueType,
                                  ConnectorTracker connectorTracker)

getProperties

public static Collection<JsonCodec.BeanProperty> getProperties(Class<?> type)
                                                        throws IntrospectionException

Throws:

IntrospectionException

jsonEquals

public static boolean jsonEquals(JsonValue a,
                                 JsonValue b)

Compares two json values for deep equality. This is a helper for overcoming the fact that JsonValue#equals(Object) only does an identity check and JsonValue.jsEquals(JsonValue) is defined to use JavaScript semantics where arrays and objects are equals only based on identity.

Parameters:

a - the first json value to check, may not be null

b - the second json value to check, may not be null

Returns:

true if both json values are the same; false otherwise

Since:

7.4