xal.tools.coding.json

Class JSONCoder

java.lang.Object

xal.tools.coding.json.JSONCoder

All Implemented Interfaces:

Coder

public class JSONCoder
extends java.lang.Object
implements Coder

encode and decode objects with JSON

Method Summary

Modifier and Type	Method and Description
java.lang.Object	decode(java.lang.String archive) Decode the JSON string
static java.lang.Object	defaultDecode(java.lang.String archive) Decode the JSON string using the default coder
static java.lang.String	defaultEncode(java.lang.Object value) Encode the object as a JSON string using the default encoder
java.lang.String	encode(java.lang.Object value) Encode the object as a JSON string
protected ConversionAdaptor<?,?>	getConversionAdaptor(java.lang.String valueType) Get the conversion adaptor for the given value
static java.util.List<java.lang.String>	getDefaultTypes() Get a list of types (including JSON standard types plus default extensions) which are supported for coding and decoding
java.util.List<java.lang.String>	getExtendedTypes() Get a list of types which extend beyond the JSON standard types
static JSONCoder	getInstance() get a new JSON Coder only if you need to customize it, otherwise use the static methods to encode/decode
static java.util.List<java.lang.String>	getStandardTypes() Get a list of the standard types encoded directly into JSON
java.util.List<java.lang.String>	getSupportedTypes() Get a list of all types which are supported for coding and decoding
static boolean	isStandardType(java.lang.String type) Determine whether the specified type is a standard JSON type
<CustomType,RepresentationType> void	registerType(java.lang.Class<CustomType> type, ConversionAdaptor<CustomType,RepresentationType> adaptor) Register the custom type by class and its associated adaptor

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static JSONCoder getInstance()

get a new JSON Coder only if you need to customize it, otherwise use the static methods to encode/decode

getDefaultTypes

public static java.util.List<java.lang.String> getDefaultTypes()

Get a list of types (including JSON standard types plus default extensions) which are supported for coding and decoding

getStandardTypes

public static java.util.List<java.lang.String> getStandardTypes()

Get a list of the standard types encoded directly into JSON

isStandardType

public static boolean isStandardType(java.lang.String type)

Determine whether the specified type is a standard JSON type

getSupportedTypes

public java.util.List<java.lang.String> getSupportedTypes()

Get a list of all types which are supported for coding and decoding

Specified by:

getSupportedTypes in interface Coder

getExtendedTypes

public java.util.List<java.lang.String> getExtendedTypes()

Get a list of types which extend beyond the JSON standard types

registerType

public <CustomType,RepresentationType> void registerType(java.lang.Class<CustomType> type,
                                                         ConversionAdaptor<CustomType,RepresentationType> adaptor)

Register the custom type by class and its associated adaptor

Specified by:

registerType in interface Coder

Parameters:

type - type to identify and process for encoding and decoding

adaptor - translator between the custom type and representation JSON constructs

getConversionAdaptor

protected ConversionAdaptor<?,?> getConversionAdaptor(java.lang.String valueType)

Get the conversion adaptor for the given value

defaultDecode

public static java.lang.Object defaultDecode(java.lang.String archive)

Decode the JSON string using the default coder

Parameters:

archive - JSON string representation of an object

Returns:

an object with the data described in the archive

decode

public java.lang.Object decode(java.lang.String archive)

Decode the JSON string

Specified by:

decode in interface Coder

Parameters:

archive - JSON string representation of an object

Returns:

an object with the data described in the archive

defaultEncode

public static java.lang.String defaultEncode(java.lang.Object value)

Encode the object as a JSON string using the default encoder

Parameters:

value - the object to encode

Returns:

a JSON string representing the value

encode

public java.lang.String encode(java.lang.Object value)

Encode the object as a JSON string

Specified by:

encode in interface Coder

Parameters:

value - the object to encode

Returns:

a JSON string representing the value