jodd.json

Class JoddJson

java.lang.Object

jodd.json.JoddJson

public class JoddJson
extends java.lang.Object

Jodd JSON module.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CLASS_METADATA_NAME

Constructor Summary

Constructors

Constructor and Description
JoddJson()

Method Summary

Modifier and Type	Method and Description
static JoddJson	defaults() Returns the module instance.
JsonAnnotationManager	getAnnotationManager() Returns JsonAnnotationManager.
java.lang.String	getClassMetadataName()
java.lang.String[]	getExcludedTypeNames()
java.lang.Class[]	getExcludedTypes()
java.lang.Class<? extends java.lang.annotation.Annotation>	getJsonAnnotation() Returns the annotation used for marking the properties.
TypeJsonSerializerMap	getTypeSerializers() Returns type serializer map
boolean	isDeepSerialization()
boolean	isSerializationSubclassAware()
boolean	isStrictStringEncoding()
boolean	isUseAltPathsByParser()
JoddJson	setAnnotationManager(JsonAnnotationManager annotationManager) Sets new JsonAnnotationManager.
void	setClassMetadataName(java.lang.String classMetadataName) Specifies if 'class' metadata is used and its value.
void	setDeepSerialization(boolean deepSerialization) Defines default behavior of a JsonSerializer.
void	setExcludedTypeNames(java.lang.String... excludedTypeNames) Defines a list of excluded types names for serialization.
void	setExcludedTypes(java.lang.Class... excludedTypes) Defines list of excluded types for serialization.
void	setJsonAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> jsonAnnotation) Defines new custom JSON annotation for marking the JSON properties that are going to be serialized.
void	setSerializationSubclassAware(boolean serializationSubclassAware) When set searches for first annotated class or interface and use it's data.
void	setStrictStringEncoding(boolean strictStringEncoding) Sets the strict JSON encoding.
JoddJson	setTypeSerializers(TypeJsonSerializerMap typeSerializers) Defines new type serializer map.
void	setUseAltPathsByParser(boolean useAltPathsByParser) Defines if parser will use extended paths information and path matching.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CLASS_METADATA_NAME

public static final java.lang.String DEFAULT_CLASS_METADATA_NAME

See Also:

Constant Field Values

Constructor Detail

JoddJson

public JoddJson()

Method Detail

defaults

public static JoddJson defaults()

Returns the module instance.

getTypeSerializers

public TypeJsonSerializerMap getTypeSerializers()

Returns type serializer map

setTypeSerializers

public JoddJson setTypeSerializers(TypeJsonSerializerMap typeSerializers)

Defines new type serializer map.

getAnnotationManager

public JsonAnnotationManager getAnnotationManager()

Returns JsonAnnotationManager.

setAnnotationManager

public JoddJson setAnnotationManager(JsonAnnotationManager annotationManager)

Sets new JsonAnnotationManager.

getJsonAnnotation

public java.lang.Class<? extends java.lang.annotation.Annotation> getJsonAnnotation()

Returns the annotation used for marking the properties.

setJsonAnnotation

public void setJsonAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> jsonAnnotation)

Defines new custom JSON annotation for marking the JSON properties that are going to be serialized.

getClassMetadataName

public java.lang.String getClassMetadataName()

See Also:

setClassMetadataName(String)

setClassMetadataName

public void setClassMetadataName(java.lang.String classMetadataName)

Specifies if 'class' metadata is used and its value. When set, class metadata is used by JsonSerializer and all objects will have additional field with the class type in the resulting JSON. JsonParser will also consider this flag to build correct object type. If null, class information is not used.

isDeepSerialization

public boolean isDeepSerialization()

setDeepSerialization

public void setDeepSerialization(boolean deepSerialization)

Defines default behavior of a JsonSerializer. If set to true, objects will be serialized deep, so all collections and arrays will get serialized.

isUseAltPathsByParser

public boolean isUseAltPathsByParser()

See Also:

setUseAltPathsByParser(boolean)

setUseAltPathsByParser

public void setUseAltPathsByParser(boolean useAltPathsByParser)

Defines if parser will use extended paths information and path matching.

getExcludedTypes

public java.lang.Class[] getExcludedTypes()

See Also:

setExcludedTypes(Class[])

setExcludedTypes

public void setExcludedTypes(java.lang.Class... excludedTypes)

Defines list of excluded types for serialization.

getExcludedTypeNames

public java.lang.String[] getExcludedTypeNames()

See Also:

setExcludedTypeNames(String...)

setExcludedTypeNames

public void setExcludedTypeNames(java.lang.String... excludedTypeNames)

Defines a list of excluded types names for serialization. Type name can contain wildcards (* and ?).

isSerializationSubclassAware

public boolean isSerializationSubclassAware()

See Also:

setSerializationSubclassAware(boolean)

setSerializationSubclassAware

public void setSerializationSubclassAware(boolean serializationSubclassAware)

When set searches for first annotated class or interface and use it's data.

isStrictStringEncoding

public boolean isStrictStringEncoding()

See Also:

setStrictStringEncoding(boolean)

setStrictStringEncoding

public void setStrictStringEncoding(boolean strictStringEncoding)

Sets the strict JSON encoding. JSON specification specifies that certain characters should be escaped (see: http://json.org/). However, in the real world, not all needs to be escaped: especially the 'solidus' character (/). If this one is escaped, many things can go wrong, from URLs to Base64 encodings. This flag controls the behavior of strict encoding. By default, the strict encoding is set to false.