Package net.sf.json
Class JsonConfig
java.lang.Object
net.sf.json.JsonConfig
Utility class that helps configuring the serialization process.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
private int
Array conversion modeprivate org.apache.commons.collections.map.MultiKeyMap
private Map
private org.apache.commons.collections.map.MultiKeyMap
private Map
Map of attribute/classprivate Class
private CycleDetectionStrategy
private static final Class
private static final CycleDetectionStrategy
static final DefaultValueProcessorMatcher
private static final String[]
private static final JavaIdentifierTransformer
static final JsonBeanProcessorMatcher
static final JsonValueProcessorMatcher
static final NewBeanInstanceStrategy
static final PropertyExclusionClassMatcher
static final PropertyNameProcessorMatcher
private static final DefaultValueProcessor
private Map
private DefaultValueProcessorMatcher
private static final String[]
private Class
private List
private String[]
private Map
private boolean
private boolean
private boolean
private List
private boolean
private boolean
private boolean
private JavaIdentifierTransformer
private PropertyFilter
private Map
private PropertyNameProcessorMatcher
private boolean
private JsonBeanProcessorMatcher
private PropertyFilter
private Map
private PropertyNameProcessorMatcher
private JsonValueProcessorMatcher
private Map
static final int
static final int
static final int
private NewBeanInstanceStrategy
private PropertyExclusionClassMatcher
private PropertySetStrategy
private Class
Root class used when converting to an specific beanprivate boolean
private boolean
private Map
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addIgnoreFieldAnnotation
(Class annotationClass) Removes an annotation that marks a field to be skipped when building.
[Java -> JSON]void
addIgnoreFieldAnnotation
(String annotationClassName) Adds an annotation that marks a field to be skipped when building.
[Java -> JSON]void
addJsonEventListener
(JsonEventListener listener) Registers a listener for JSON events.
The events will be triggered only when using the static builders and if event triggering is enabled.
[Java -> JSON]void
Removes all registered PropertyNameProcessors.
[JSON -> Java]void
Removes all registered JsonBeanProcessors.
[Java -> JSON]void
Removes all registered listener for JSON Events.
[Java -> JSON]void
Removes all registered PropertyNameProcessors.
[Java -> JSON]void
Removes all registered JsonValueProcessors.
[Java -> JSON]void
Removes all property exclusions registered per class.
[Java -> JSON]void
Deprecated.use clearJavaPropertyNameProcessors() insteadcopy()
void
Disables event triggering when building.
[Java -> JSON]void
Enables event triggering when building.
[Java -> JSON]findDefaultValueProcessor
(Class target) Finds a DefaultValueProcessor registered to the target class.
Returns null if none is registered.
[Java -> JSON]findJavaPropertyNameProcessor
(Class beanClass) Finds a PropertyNameProcessor registered to the target class.
Returns null if none is registered.
[JSON -> Java]findJsonBeanProcessor
(Class target) Finds a JsonBeanProcessor registered to the target class.
Returns null if none is registered.
[Java -> JSON]findJsonPropertyNameProcessor
(Class beanClass) Finds a PropertyNameProcessor registered to the target class.
Returns null if none is registered.
[Java -> JSON]findJsonValueProcessor
(Class propertyType) Finds a JsonValueProcessor registered to the target type.
Returns null if none is registered.
[Java -> JSON]findJsonValueProcessor
(Class beanClass, Class propertyType, String key) Finds a JsonValueProcessor.
It will search the registered JsonValueProcessors in the following order: beanClass, key beanClass, type key type Returns null if none is registered.
[Java -> JSON]findJsonValueProcessor
(Class propertyType, String key) Finds a JsonValueProcessor.
It will search the registered JsonValueProcessors in the following order: key type Returns null if none is registered.
[Java -> JSON]findPropertyNameProcessor
(Class beanClass) Deprecated.use findJavaPropertyNameProcessor() insteadint
Returns the current array mode conversion.
[JSON -> Java]Returns the current attribute/class Map.
[JSON -> Java]Returns the current collection type used for collection transformations.
[JSON -> Java]Returns the configured CycleDetectionStrategy.
Default value is CycleDetectionStrategy.STRICT
[Java -> JSON]Returns the configured DefaultValueProcessorMatcher.
Default value is DefaultValueProcessorMatcher.DEFAULT
[Java -> JSON]Returns the current enclosed type for generic collection transformations.
[JSON -> Java]String[]
Returns the configured properties for exclusion.Returns a List of all annotations that mark a field to be skipped when building.
[Java -> JSON]Returns the configured JavaIdentifierTransformer.Returns the configured property filter when serializing to Java.
[JSON -> Java]Returns the configured PropertyNameProcessorMatcher.
Default value is PropertyNameProcessorMatcher.DEFAULT
[JSON -> Java]Returns the configured JsonBeanProcessorMatcher.
Default value is JsonBeanProcessorMatcher.DEFAULT
[JSON -> Java]Returns a list of registered listeners for JSON events.
[JSON -> Java]Returns the configured property filter when serializing to JSON.
[Java -> JSON]Returns the configured PropertyNameProcessorMatcher.
Default value is PropertyNameProcessorMatcher.DEFAULT
[Java -> JSON]Returns the configured JsonValueProcessorMatcher.
Default value is JsonValueProcessorMatcher.DEFAULT
[Java -> JSON]Returns a set of default excludes with user-defined excludes.
[Java -> JSON]getMergedExcludes
(Class target) Returns a set of default excludes with user-defined excludes.
Takes into account any additional excludes per matching class.Returns the configured NewBeanInstanceStrategy.
Default value is NewBeanInstanceStrategy.DEFAULT
[JSON -> Java]Returns the configured PropertyExclusionClassMatcher.
Default value is PropertyExclusionClassMatcher.DEFAULT
[JSON -> Java]Deprecated.use getJavaPropertyNameProcessorMatcher() insteadReturns the configured PropertySetStrategy.
Default value is PropertySetStrategy.DEFAULT
[JSON -> Java]Returns the current root Class.
[JSON -> Java]boolean
Returns true if non-String keys are allowed on JSONObject.
Default value is false
[Java -> JSON]boolean
Returns true if event triggering is enabled during building.
Default value is false
[Java -> JSON]boolean
Returns true if this Jettison convention will be handled when converting to Java.
Jettison assumes that "" (empty string) can be assigned to empty elements (objects), which clearly violates the JSON spec.
[JSON -> Java]boolean
Returns true if this jettison convention will be handled when converting to Java.
Jettison states the following JSON {'media':{'title':'hello'}} can be set as a single element JSONArray (media is the array).
[JSON -> Java]boolean
Returns true if default excludes will not be used.
Default value is false.
[Java -> JSON]boolean
Returns true if JPA Transient annotated methods should be ignored.
Default value is false.
[Java -> JSON]boolean
Returns true if public fields of a bean will be ignored.
Default value is true.
[Java -> JSON]boolean
Returns true if transient fields of a bean will be ignored.
Default value is false.
[Java -> JSON]boolean
boolean
Returns true if Javascript compatibility is turned on.
Default value is false.
[Java -> JSON]boolean
Returns true if map keys will not be transformed.
Default value is false.
[JSON -> Java]void
registerDefaultValueProcessor
(Class target, DefaultValueProcessor defaultValueProcessor) Registers a DefaultValueProcessor.
[Java -> JSON]void
registerJavaPropertyNameProcessor
(Class target, PropertyNameProcessor propertyNameProcessor) Registers a PropertyNameProcessor.
[JSON -> Java]void
registerJsonBeanProcessor
(Class target, JsonBeanProcessor jsonBeanProcessor) Registers a JsonBeanProcessor.
[Java -> JSON]void
registerJsonPropertyNameProcessor
(Class target, PropertyNameProcessor propertyNameProcessor) Registers a PropertyNameProcessor.
[Java -> JSON]void
registerJsonValueProcessor
(Class beanClass, Class propertyType, JsonValueProcessor jsonValueProcessor) Registers a JsonValueProcessor.
[Java -> JSON]void
registerJsonValueProcessor
(Class beanClass, String key, JsonValueProcessor jsonValueProcessor) Registers a JsonValueProcessor.
[Java -> JSON]void
registerJsonValueProcessor
(Class propertyType, JsonValueProcessor jsonValueProcessor) Registers a JsonValueProcessor.
[Java -> JSON]void
registerJsonValueProcessor
(String key, JsonValueProcessor jsonValueProcessor) Registers a JsonValueProcessor.
[Java -> JSON]void
registerPropertyExclusion
(Class target, String propertyName) Registers a exclusion for a target class.
[Java -> JSON]void
registerPropertyExclusions
(Class target, String[] properties) Registers exclusions for a target class.
[Java -> JSON]void
registerPropertyNameProcessor
(Class target, PropertyNameProcessor propertyNameProcessor) Deprecated.use registerJavaPropertyNameProcessor() insteadvoid
removeIgnoreFieldAnnotation
(Class annotationClass) Removes an annotation that marks a field to be skipped when building.
[Java -> JSON]void
removeIgnoreFieldAnnotation
(String annotationClassName) Adds an annotation that marks a field to be skipped when building.
[Java -> JSON]void
removeJsonEventListener
(JsonEventListener listener) Removes a listener for JSON events.
[Java -> JSON]void
reset()
Resets all values to its default state.void
setAllowNonStringKeys
(boolean allowNonStringKeys) Sets if non-String keys are allowed on JSONObject.
[Java -> JSON]void
setArrayMode
(int arrayMode) Sets the current array mode for conversion.
If the value is not MODE_LIST, MODE_OBJECT_ARRAY nor MODE_SET, then MODE_LIST will be used.
[JSON -> Java]void
setClassMap
(Map classMap) Sets the current attribute/Class Map
[JSON -> Java]void
setCollectionType
(Class collectionType) Sets the current collection type used for collection transformations.
[JSON -> Java]void
setCycleDetectionStrategy
(CycleDetectionStrategy cycleDetectionStrategy) Sets a CycleDetectionStrategy to use.
Will set default value (CycleDetectionStrategy.STRICT) if null.
[Java -> JSON]void
setDefaultValueProcessorMatcher
(DefaultValueProcessorMatcher defaultValueProcessorMatcher) Sets a DefaultValueProcessorMatcher to use.
Will set default value (DefaultValueProcessorMatcher.DEFAULT) if null.
[Java -> JSON]void
setEnclosedType
(Class enclosedType) Sets the current enclosed type for generic collection transformations.
[JSON -> Java]void
setExcludes
(String[] excludes) Sets the excludes to use.
Will set default value ([]) if null.
[Java -> JSON]void
setHandleJettisonEmptyElement
(boolean handleJettisonEmptyElement) Activate/Deactivate handling this jettison convention when converting to Java.
Jettison states that "" (empty string) can be assigned to empty elements (objects), which clearly violates the JSON spec.
[JSON -> Java]void
setHandleJettisonSingleElementArray
(boolean handleJettisonSingleElementArray) Activate/Deactivate handling this jettison convention when converting to Java.
* Jettison states the following JSON {'media':{'title':'hello'}} can be set as a single element JSONArray (media is the array).
[JSON -> Java]void
setIgnoreDefaultExcludes
(boolean ignoreDefaultExcludes) Sets if default excludes would be skipped when building.
[Java -> JSON]void
setIgnoreJPATransient
(boolean ignoreJPATransient) Sets if JPA Transient annotated methods would be skipped when building.
[Java -> JSON]void
setIgnorePublicFields
(boolean ignorePublicFields) Sets if public fields would be skipped when building.
[Java -> JSON]void
setIgnoreTransientFields
(boolean ignoreTransientFields) Sets if transient fields would be skipped when building.
[Java -> JSON]void
setIgnoreUnreadableProperty
(boolean ignoreUnreadableProperty) If true, properties found in JSON that have no corresponding Java setter/field/etc will not raise an exception.void
setJavaIdentifierTransformer
(JavaIdentifierTransformer javaIdentifierTransformer) Sets the JavaIdentifierTransformer to use.
Will set default value (JavaIdentifierTransformer.NOOP) if null.
[JSON -> Java]void
setJavaPropertyFilter
(PropertyFilter javaPropertyFilter) Sets a property filter used when serializing to Java.
[JSON -> Java]void
setJavaPropertyNameProcessorMatcher
(PropertyNameProcessorMatcher propertyNameProcessorMatcher) Sets a PropertyNameProcessorMatcher to use.
Will set default value (PropertyNameProcessorMatcher.DEFAULT) if null.
[JSON -> Java]void
setJavascriptCompliant
(boolean javascriptCompliant) Sets if Javascript compatibility is enabled when building.
[Java -> JSON]void
setJsonBeanProcessorMatcher
(JsonBeanProcessorMatcher jsonBeanProcessorMatcher) Sets a JsonBeanProcessorMatcher to use.
Will set default value (JsonBeanProcessorMatcher.DEFAULT) if null.
[Java -> JSON]void
setJsonPropertyFilter
(PropertyFilter jsonPropertyFilter) Sets a property filter used when serializing to JSON.
[Java -> JSON]void
setJsonPropertyNameProcessorMatcher
(PropertyNameProcessorMatcher propertyNameProcessorMatcher) Sets a PropertyNameProcessorMatcher to use.
Will set default value (PropertyNameProcessorMatcher.DEFAULT) if null.
[Java -> JSON]void
setJsonValueProcessorMatcher
(JsonValueProcessorMatcher jsonValueProcessorMatcher) Sets a JsonValueProcessorMatcher to use.
Will set default value (JsonValueProcessorMatcher.DEFAULT) if null.
[Java -> JSON]void
setNewBeanInstanceStrategy
(NewBeanInstanceStrategy newBeanInstanceStrategy) Sets the NewBeanInstanceStrategy to use.
Will set default value (NewBeanInstanceStrategy.DEFAULT) if null.
[JSON -> Java]void
setPropertyExclusionClassMatcher
(PropertyExclusionClassMatcher propertyExclusionClassMatcher) Sets a PropertyExclusionClassMatcher to use.
Will set default value (PropertyExclusionClassMatcher.DEFAULT) if null.
[Java -> JSON]void
setPropertyNameProcessorMatcher
(PropertyNameProcessorMatcher propertyNameProcessorMatcher) Deprecated.use setJavaPropertyNameProcessorMatcher() insteadvoid
setPropertySetStrategy
(PropertySetStrategy propertySetStrategy) Sets a PropertySetStrategy to use.
Will set default value (PropertySetStrategy.DEFAULT) if null.
[JSON -> Java]void
setRootClass
(Class rootClass) Sets the current root Class.
[JSON -> Java]void
setSkipJavaIdentifierTransformationInMapKeys
(boolean skipJavaIdentifierTransformationInMapKeys) Sets if property name as JavaIndetifier transformations would be skipped.
[JSON -> Java]void
unregisterDefaultValueProcessor
(Class target) Removes a DefaultValueProcessor.
[Java -> JSON]void
Removes a PropertyNameProcessor.
[JSON -> Java]void
unregisterJsonBeanProcessor
(Class target) Removes a JsonBeanProcessor.
[Java -> JSON]void
Removes a PropertyNameProcessor.
[Java -> JSON]void
unregisterJsonValueProcessor
(Class propertyType) Removes a JsonValueProcessor.
[Java -> JSON]void
unregisterJsonValueProcessor
(Class beanClass, Class propertyType) Removes a JsonValueProcessor.
[Java -> JSON]void
unregisterJsonValueProcessor
(Class beanClass, String key) Removes a JsonValueProcessor.
[Java -> JSON]void
Removes a JsonValueProcessor.
[Java -> JSON]void
unregisterPropertyExclusion
(Class target, String propertyName) Removes a property exclusion assigned to the target class.
[Java -> JSON]void
unregisterPropertyExclusions
(Class target) Removes all property exclusions assigned to the target class.
[Java -> JSON]void
unregisterPropertyNameProcessor
(Class target) Deprecated.use unregisterJavaPropertyNameProcessor() instead
-
Field Details
-
DEFAULT_DEFAULT_VALUE_PROCESSOR_MATCHER
-
DEFAULT_JSON_BEAN_PROCESSOR_MATCHER
-
DEFAULT_JSON_VALUE_PROCESSOR_MATCHER
-
DEFAULT_NEW_BEAN_INSTANCE_STRATEGY
-
DEFAULT_PROPERTY_EXCLUSION_CLASS_MATCHER
-
DEFAULT_PROPERTY_NAME_PROCESSOR_MATCHER
-
MODE_LIST
public static final int MODE_LIST- See Also:
-
MODE_OBJECT_ARRAY
public static final int MODE_OBJECT_ARRAY- See Also:
-
MODE_SET
public static final int MODE_SET- See Also:
-
DEFAULT_COLLECTION_TYPE
-
DEFAULT_CYCLE_DETECTION_STRATEGY
-
DEFAULT_EXCLUDES
-
DEFAULT_JAVA_IDENTIFIER_TRANSFORMER
-
DEFAULT_VALUE_PROCESSOR
-
EMPTY_EXCLUDES
-
arrayMode
private int arrayModeArray conversion mode -
beanKeyMap
private org.apache.commons.collections.map.MultiKeyMap beanKeyMap -
beanProcessorMap
-
beanTypeMap
private org.apache.commons.collections.map.MultiKeyMap beanTypeMap -
classMap
Map of attribute/class -
collectionType
-
cycleDetectionStrategy
-
defaultValueMap
-
defaultValueProcessorMatcher
-
enclosedType
-
eventListeners
-
excludes
-
exclusionMap
-
handleJettisonEmptyElement
private boolean handleJettisonEmptyElement -
handleJettisonSingleElementArray
private boolean handleJettisonSingleElementArray -
ignoreDefaultExcludes
private boolean ignoreDefaultExcludes -
ignoreTransientFields
private boolean ignoreTransientFields -
ignorePublicFields
private boolean ignorePublicFields -
ignoreUnreadableProperty
private boolean ignoreUnreadableProperty -
javascriptCompliant
private boolean javascriptCompliant -
javaIdentifierTransformer
-
javaPropertyFilter
-
javaPropertyNameProcessorMap
-
javaPropertyNameProcessorMatcher
-
jsonBeanProcessorMatcher
-
jsonPropertyFilter
-
jsonPropertyNameProcessorMap
-
jsonPropertyNameProcessorMatcher
-
jsonValueProcessorMatcher
-
keyMap
-
newBeanInstanceStrategy
-
propertyExclusionClassMatcher
-
propertySetStrategy
-
rootClass
Root class used when converting to an specific bean -
skipJavaIdentifierTransformationInMapKeys
private boolean skipJavaIdentifierTransformationInMapKeys -
triggerEvents
private boolean triggerEvents -
typeMap
-
ignoreFieldAnnotations
-
allowNonStringKeys
private boolean allowNonStringKeys
-
-
Constructor Details
-
JsonConfig
public JsonConfig()
-
-
Method Details
-
addJsonEventListener
Registers a listener for JSON events.
The events will be triggered only when using the static builders and if event triggering is enabled.
[Java -> JSON]- Parameters:
listener
- a listener for events- See Also:
-
clearJavaPropertyNameProcessors
public void clearJavaPropertyNameProcessors()Removes all registered PropertyNameProcessors.
[JSON -> Java] -
clearJsonBeanProcessors
public void clearJsonBeanProcessors()Removes all registered JsonBeanProcessors.
[Java -> JSON] -
clearJsonEventListeners
public void clearJsonEventListeners()Removes all registered listener for JSON Events.
[Java -> JSON] -
clearJsonPropertyNameProcessors
public void clearJsonPropertyNameProcessors()Removes all registered PropertyNameProcessors.
[Java -> JSON] -
clearJsonValueProcessors
public void clearJsonValueProcessors()Removes all registered JsonValueProcessors.
[Java -> JSON] -
clearPropertyExclusions
public void clearPropertyExclusions()Removes all property exclusions registered per class.
[Java -> JSON] -
clearPropertyNameProcessors
public void clearPropertyNameProcessors()Deprecated.use clearJavaPropertyNameProcessors() insteadRemoves all registered PropertyNameProcessors.
[JSON -> Java] -
copy
-
disableEventTriggering
public void disableEventTriggering()Disables event triggering when building.
[Java -> JSON] -
enableEventTriggering
public void enableEventTriggering()Enables event triggering when building.
[Java -> JSON] -
isIgnoreUnreadableProperty
public boolean isIgnoreUnreadableProperty() -
setIgnoreUnreadableProperty
public void setIgnoreUnreadableProperty(boolean ignoreUnreadableProperty) If true, properties found in JSON that have no corresponding Java setter/field/etc will not raise an exception. For example, given {"x":1, "y":2, "z":3} on the following Point class,JSONObject.toBean()
would fail unless this flag is set to true, because propety "x" in JSON has no corresponding Java counerpart.class Point { private int x,y; public int getX() { return x; } public int getY() { return y; } public void setX(int v) { x=v; } public void setY(int v) { y=v; } }
[JSON -> Java] -
findDefaultValueProcessor
Finds a DefaultValueProcessor registered to the target class.
Returns null if none is registered.
[Java -> JSON]- Parameters:
target
- a class used for searching a DefaultValueProcessor.
-
findJavaPropertyNameProcessor
Finds a PropertyNameProcessor registered to the target class.
Returns null if none is registered.
[JSON -> Java]- Parameters:
beanClass
- a class used for searching a PropertyNameProcessor.
-
findJsonBeanProcessor
Finds a JsonBeanProcessor registered to the target class.
Returns null if none is registered.
[Java -> JSON]- Parameters:
target
- a class used for searching a JsonBeanProcessor.
-
findJsonPropertyNameProcessor
Finds a PropertyNameProcessor registered to the target class.
Returns null if none is registered.
[Java -> JSON]- Parameters:
beanClass
- a class used for searching a PropertyNameProcessor.
-
findJsonValueProcessor
Finds a JsonValueProcessor registered to the target type.
Returns null if none is registered.
[Java -> JSON]- Parameters:
propertyType
- a class used for searching a JsonValueProcessor.
-
findJsonValueProcessor
Finds a JsonValueProcessor.
It will search the registered JsonValueProcessors in the following order:- beanClass, key
- beanClass, type
- key
- type
[Java -> JSON]- Parameters:
beanClass
- the class to which the property may belongpropertyType
- the type of the propertykey
- the name of the property which may belong to the target class
-
findJsonValueProcessor
Finds a JsonValueProcessor.
It will search the registered JsonValueProcessors in the following order:- key
- type
[Java -> JSON]- Parameters:
propertyType
- the type of the propertykey
- the name of the property which may belong to the target class
-
findPropertyNameProcessor
Deprecated.use findJavaPropertyNameProcessor() insteadFinds a PropertyNameProcessor registered to the target class.
Returns null if none is registered.
[JSON -> Java]- Parameters:
beanClass
- a class used for searching a PropertyNameProcessor.
-
getArrayMode
public int getArrayMode()Returns the current array mode conversion.
[JSON -> Java]- Returns:
- MODE_OBJECT_ARRAY, MODE_LIST or MODE_SET
-
getClassMap
Returns the current attribute/class Map.
[JSON -> Java]- Returns:
- a Map of classes, every key identifies a property or a regexp
-
getCollectionType
Returns the current collection type used for collection transformations.
[JSON -> Java]- Returns:
- the target collection class for conversion
-
getCycleDetectionStrategy
Returns the configured CycleDetectionStrategy.
Default value is CycleDetectionStrategy.STRICT
[Java -> JSON] -
getDefaultValueProcessorMatcher
Returns the configured DefaultValueProcessorMatcher.
Default value is DefaultValueProcessorMatcher.DEFAULT
[Java -> JSON] -
getEnclosedType
Returns the current enclosed type for generic collection transformations.
[JSON -> Java]- Returns:
- the target type for conversion
-
getExcludes
Returns the configured properties for exclusion.
[Java -> JSON] -
getJavaIdentifierTransformer
Returns the configured JavaIdentifierTransformer.
Default value is JavaIdentifierTransformer.NOOP
[JSON -> Java] -
getJavaPropertyFilter
Returns the configured property filter when serializing to Java.
[JSON -> Java] -
getJavaPropertyNameProcessorMatcher
Returns the configured PropertyNameProcessorMatcher.
Default value is PropertyNameProcessorMatcher.DEFAULT
[JSON -> Java] -
getJsonBeanProcessorMatcher
Returns the configured JsonBeanProcessorMatcher.
Default value is JsonBeanProcessorMatcher.DEFAULT
[JSON -> Java] -
getJsonEventListeners
Returns a list of registered listeners for JSON events.
[JSON -> Java] -
getJsonPropertyFilter
Returns the configured property filter when serializing to JSON.
[Java -> JSON] -
getJsonPropertyNameProcessorMatcher
Returns the configured PropertyNameProcessorMatcher.
Default value is PropertyNameProcessorMatcher.DEFAULT
[Java -> JSON] -
getJsonValueProcessorMatcher
Returns the configured JsonValueProcessorMatcher.
Default value is JsonValueProcessorMatcher.DEFAULT
[Java -> JSON] -
getMergedExcludes
Returns a set of default excludes with user-defined excludes.
[Java -> JSON] -
getMergedExcludes
Returns a set of default excludes with user-defined excludes.
Takes into account any additional excludes per matching class. [Java -> JSON] -
getNewBeanInstanceStrategy
Returns the configured NewBeanInstanceStrategy.
Default value is NewBeanInstanceStrategy.DEFAULT
[JSON -> Java] -
getPropertyExclusionClassMatcher
Returns the configured PropertyExclusionClassMatcher.
Default value is PropertyExclusionClassMatcher.DEFAULT
[JSON -> Java] -
getPropertyNameProcessorMatcher
Deprecated.use getJavaPropertyNameProcessorMatcher() insteadReturns the configured PropertyNameProcessorMatcher.
Default value is PropertyNameProcessorMatcher.DEFAULT
[JSON -> Java] -
getPropertySetStrategy
Returns the configured PropertySetStrategy.
Default value is PropertySetStrategy.DEFAULT
[JSON -> Java] -
getRootClass
Returns the current root Class.
[JSON -> Java]- Returns:
- the target class for conversion
-
isAllowNonStringKeys
public boolean isAllowNonStringKeys()Returns true if non-String keys are allowed on JSONObject.
Default value is false
[Java -> JSON] -
isEventTriggeringEnabled
public boolean isEventTriggeringEnabled()Returns true if event triggering is enabled during building.
Default value is false
[Java -> JSON] -
isHandleJettisonEmptyElement
public boolean isHandleJettisonEmptyElement()Returns true if this Jettison convention will be handled when converting to Java.
Jettison assumes that "" (empty string) can be assigned to empty elements (objects), which clearly violates the JSON spec.
[JSON -> Java] -
isHandleJettisonSingleElementArray
public boolean isHandleJettisonSingleElementArray()Returns true if this jettison convention will be handled when converting to Java.
Jettison states the following JSON {'media':{'title':'hello'}} can be set as a single element JSONArray (media is the array).
[JSON -> Java] -
isIgnoreDefaultExcludes
public boolean isIgnoreDefaultExcludes()Returns true if default excludes will not be used.
Default value is false.
[Java -> JSON] -
isIgnoreJPATransient
public boolean isIgnoreJPATransient()Returns true if JPA Transient annotated methods should be ignored.
Default value is false.
[Java -> JSON] -
isIgnoreTransientFields
public boolean isIgnoreTransientFields()Returns true if transient fields of a bean will be ignored.
Default value is false.
[Java -> JSON] -
isIgnorePublicFields
public boolean isIgnorePublicFields()Returns true if public fields of a bean will be ignored.
Default value is true.
[Java -> JSON] -
isJavascriptCompliant
public boolean isJavascriptCompliant()Returns true if Javascript compatibility is turned on.
Default value is false.
[Java -> JSON] -
isSkipJavaIdentifierTransformationInMapKeys
public boolean isSkipJavaIdentifierTransformationInMapKeys()Returns true if map keys will not be transformed.
Default value is false.
[JSON -> Java] -
registerDefaultValueProcessor
public void registerDefaultValueProcessor(Class target, DefaultValueProcessor defaultValueProcessor) Registers a DefaultValueProcessor.
[Java -> JSON]- Parameters:
target
- the class to use as keydefaultValueProcessor
- the processor to register
-
registerJavaPropertyNameProcessor
public void registerJavaPropertyNameProcessor(Class target, PropertyNameProcessor propertyNameProcessor) Registers a PropertyNameProcessor.
[JSON -> Java]- Parameters:
target
- the class to use as keypropertyNameProcessor
- the processor to register
-
registerJsonBeanProcessor
Registers a JsonBeanProcessor.
[Java -> JSON]- Parameters:
target
- the class to use as keyjsonBeanProcessor
- the processor to register
-
registerJsonPropertyNameProcessor
public void registerJsonPropertyNameProcessor(Class target, PropertyNameProcessor propertyNameProcessor) Registers a PropertyNameProcessor.
[Java -> JSON]- Parameters:
target
- the class to use as keypropertyNameProcessor
- the processor to register
-
registerJsonValueProcessor
public void registerJsonValueProcessor(Class beanClass, Class propertyType, JsonValueProcessor jsonValueProcessor) Registers a JsonValueProcessor.
[Java -> JSON]- Parameters:
beanClass
- the class to use as keypropertyType
- the property type to use as keyjsonValueProcessor
- the processor to register
-
registerJsonValueProcessor
Registers a JsonValueProcessor.
[Java -> JSON]- Parameters:
propertyType
- the property type to use as keyjsonValueProcessor
- the processor to register
-
registerJsonValueProcessor
public void registerJsonValueProcessor(Class beanClass, String key, JsonValueProcessor jsonValueProcessor) Registers a JsonValueProcessor.
[Java -> JSON]- Parameters:
beanClass
- the class to use as keykey
- the property name to use as keyjsonValueProcessor
- the processor to register
-
registerJsonValueProcessor
Registers a JsonValueProcessor.
[Java -> JSON]- Parameters:
key
- the property name to use as keyjsonValueProcessor
- the processor to register
-
registerPropertyExclusion
Registers a exclusion for a target class.
[Java -> JSON]- Parameters:
target
- the class to use as keypropertyName
- the property to be excluded
-
registerPropertyExclusions
Registers exclusions for a target class.
[Java -> JSON]- Parameters:
target
- the class to use as keyproperties
- the properties to be excluded
-
registerPropertyNameProcessor
public void registerPropertyNameProcessor(Class target, PropertyNameProcessor propertyNameProcessor) Deprecated.use registerJavaPropertyNameProcessor() insteadRegisters a PropertyNameProcessor.
[JSON -> Java]- Parameters:
target
- the class to use as keypropertyNameProcessor
- the processor to register
-
removeJsonEventListener
Removes a listener for JSON events.
[Java -> JSON]- Parameters:
listener
- a listener for events- See Also:
-
reset
public void reset()Resets all values to its default state. -
setAllowNonStringKeys
public void setAllowNonStringKeys(boolean allowNonStringKeys) Sets if non-String keys are allowed on JSONObject.
[Java -> JSON] -
setArrayMode
public void setArrayMode(int arrayMode) Sets the current array mode for conversion.
If the value is not MODE_LIST, MODE_OBJECT_ARRAY nor MODE_SET, then MODE_LIST will be used.
[JSON -> Java]- Parameters:
arrayMode
- array mode for conversion
-
setClassMap
Sets the current attribute/Class Map
[JSON -> Java]- Parameters:
classMap
- a Map of classes, every key identifies a property or a regexp
-
setCollectionType
Sets the current collection type used for collection transformations.
[JSON -> Java]- Parameters:
collectionType
- the target collection class for conversion
-
setCycleDetectionStrategy
Sets a CycleDetectionStrategy to use.
Will set default value (CycleDetectionStrategy.STRICT) if null.
[Java -> JSON] -
setDefaultValueProcessorMatcher
public void setDefaultValueProcessorMatcher(DefaultValueProcessorMatcher defaultValueProcessorMatcher) Sets a DefaultValueProcessorMatcher to use.
Will set default value (DefaultValueProcessorMatcher.DEFAULT) if null.
[Java -> JSON] -
setEnclosedType
Sets the current enclosed type for generic collection transformations.
[JSON -> Java]- Parameters:
enclosedType
- the target type for conversion
-
setExcludes
Sets the excludes to use.
Will set default value ([]) if null.
[Java -> JSON] -
setHandleJettisonEmptyElement
public void setHandleJettisonEmptyElement(boolean handleJettisonEmptyElement) Activate/Deactivate handling this jettison convention when converting to Java.
Jettison states that "" (empty string) can be assigned to empty elements (objects), which clearly violates the JSON spec.
[JSON -> Java] -
setHandleJettisonSingleElementArray
public void setHandleJettisonSingleElementArray(boolean handleJettisonSingleElementArray) Activate/Deactivate handling this jettison convention when converting to Java.
* Jettison states the following JSON {'media':{'title':'hello'}} can be set as a single element JSONArray (media is the array).
[JSON -> Java] -
setIgnoreDefaultExcludes
public void setIgnoreDefaultExcludes(boolean ignoreDefaultExcludes) Sets if default excludes would be skipped when building.
[Java -> JSON] -
setIgnoreJPATransient
public void setIgnoreJPATransient(boolean ignoreJPATransient) Sets if JPA Transient annotated methods would be skipped when building.
[Java -> JSON] -
addIgnoreFieldAnnotation
Adds an annotation that marks a field to be skipped when building.
[Java -> JSON] -
removeIgnoreFieldAnnotation
Adds an annotation that marks a field to be skipped when building.
[Java -> JSON] -
addIgnoreFieldAnnotation
Removes an annotation that marks a field to be skipped when building.
[Java -> JSON] -
removeIgnoreFieldAnnotation
Removes an annotation that marks a field to be skipped when building.
[Java -> JSON] -
getIgnoreFieldAnnotations
Returns a List of all annotations that mark a field to be skipped when building.
[Java -> JSON] -
setIgnoreTransientFields
public void setIgnoreTransientFields(boolean ignoreTransientFields) Sets if transient fields would be skipped when building.
[Java -> JSON] -
setIgnorePublicFields
public void setIgnorePublicFields(boolean ignorePublicFields) Sets if public fields would be skipped when building.
[Java -> JSON] -
setJavascriptCompliant
public void setJavascriptCompliant(boolean javascriptCompliant) Sets if Javascript compatibility is enabled when building.
[Java -> JSON] -
setJavaIdentifierTransformer
Sets the JavaIdentifierTransformer to use.
Will set default value (JavaIdentifierTransformer.NOOP) if null.
[JSON -> Java] -
setJavaPropertyFilter
Sets a property filter used when serializing to Java.
[JSON -> Java]- Parameters:
javaPropertyFilter
- the property filter
-
setJavaPropertyNameProcessorMatcher
public void setJavaPropertyNameProcessorMatcher(PropertyNameProcessorMatcher propertyNameProcessorMatcher) Sets a PropertyNameProcessorMatcher to use.
Will set default value (PropertyNameProcessorMatcher.DEFAULT) if null.
[JSON -> Java] -
setJsonBeanProcessorMatcher
Sets a JsonBeanProcessorMatcher to use.
Will set default value (JsonBeanProcessorMatcher.DEFAULT) if null.
[Java -> JSON] -
setJsonPropertyFilter
Sets a property filter used when serializing to JSON.
[Java -> JSON]- Parameters:
jsonPropertyFilter
- the property filter
-
setJsonPropertyNameProcessorMatcher
public void setJsonPropertyNameProcessorMatcher(PropertyNameProcessorMatcher propertyNameProcessorMatcher) Sets a PropertyNameProcessorMatcher to use.
Will set default value (PropertyNameProcessorMatcher.DEFAULT) if null.
[Java -> JSON] -
setJsonValueProcessorMatcher
Sets a JsonValueProcessorMatcher to use.
Will set default value (JsonValueProcessorMatcher.DEFAULT) if null.
[Java -> JSON] -
setNewBeanInstanceStrategy
Sets the NewBeanInstanceStrategy to use.
Will set default value (NewBeanInstanceStrategy.DEFAULT) if null.
[JSON -> Java] -
setPropertyExclusionClassMatcher
public void setPropertyExclusionClassMatcher(PropertyExclusionClassMatcher propertyExclusionClassMatcher) Sets a PropertyExclusionClassMatcher to use.
Will set default value (PropertyExclusionClassMatcher.DEFAULT) if null.
[Java -> JSON] -
setPropertyNameProcessorMatcher
public void setPropertyNameProcessorMatcher(PropertyNameProcessorMatcher propertyNameProcessorMatcher) Deprecated.use setJavaPropertyNameProcessorMatcher() insteadSets a PropertyNameProcessorMatcher to use.
Will set default value (PropertyNameProcessorMatcher.DEFAULT) if null.
[JSON -> Java] -
setPropertySetStrategy
Sets a PropertySetStrategy to use.
Will set default value (PropertySetStrategy.DEFAULT) if null.
[JSON -> Java] -
setRootClass
Sets the current root Class.
[JSON -> Java]- Parameters:
rootClass
- the target class for conversion
-
setSkipJavaIdentifierTransformationInMapKeys
public void setSkipJavaIdentifierTransformationInMapKeys(boolean skipJavaIdentifierTransformationInMapKeys) Sets if property name as JavaIndetifier transformations would be skipped.
[JSON -> Java] -
unregisterDefaultValueProcessor
Removes a DefaultValueProcessor.
[Java -> JSON]- Parameters:
target
- a class used for searching a DefaultValueProcessor.
-
unregisterJavaPropertyNameProcessor
Removes a PropertyNameProcessor.
[JSON -> Java]- Parameters:
target
- a class used for searching a PropertyNameProcessor.
-
unregisterJsonBeanProcessor
Removes a JsonBeanProcessor.
[Java -> JSON]- Parameters:
target
- a class used for searching a JsonBeanProcessor.
-
unregisterJsonPropertyNameProcessor
Removes a PropertyNameProcessor.
[Java -> JSON]- Parameters:
target
- a class used for searching a PropertyNameProcessor.
-
unregisterJsonValueProcessor
Removes a JsonValueProcessor.
[Java -> JSON]- Parameters:
propertyType
- a class used for searching a JsonValueProcessor.
-
unregisterJsonValueProcessor
Removes a JsonValueProcessor.
[Java -> JSON]- Parameters:
beanClass
- the class to which the property may belongpropertyType
- the type of the property
-
unregisterJsonValueProcessor
Removes a JsonValueProcessor.
[Java -> JSON]- Parameters:
beanClass
- the class to which the property may belongkey
- the name of the property which may belong to the target class
-
unregisterJsonValueProcessor
Removes a JsonValueProcessor.
[Java -> JSON]- Parameters:
key
- the name of the property which may belong to the target class
-
unregisterPropertyExclusion
Removes a property exclusion assigned to the target class.
[Java -> JSON]- Parameters:
target
- a class used for searching property exclusions.propertyName
- the name of the property to be removed from the exclusion list.
-
unregisterPropertyExclusions
Removes all property exclusions assigned to the target class.
[Java -> JSON]- Parameters:
target
- a class used for searching property exclusions.
-
unregisterPropertyNameProcessor
Deprecated.use unregisterJavaPropertyNameProcessor() insteadRemoves a PropertyNameProcessor.
[JSON -> Java]- Parameters:
target
- a class used for searching a PropertyNameProcessor.
-