JSONConfig (JSONUtil 1.2 API)

java.lang.Object
- org.kopitubruk.util.json.JSONConfig

All Implemented Interfaces:

Serializable, Cloneable
```
public class JSONConfig
extends Object
implements Serializable, Cloneable
```
A configuration object for JSONUtil to control various encoding options.
It is possible to change the defaults by using the JSONConfigDefaults class. See that class for details.
These are the names of the boolean flags and their normal defaults if you don't change them. See the setters for these for descriptions of what they do.
Validation related options.
- validatePropertyNames = true
- detectDataStructureLoops = true
- escapeBadIdentifierCodePoints = false
Safe alternate encoding options.
- encodeNumericStringsAsNumbers = false
- escapeNonAscii = false
- unEscapeWherePossible = false
- escapeSurrogates = false
Allow generation of certain types of non-standard JSON.

This could cause problems for some things that take JSON. Defaults are for standard JSON. Be careful about changing these. They should work fine if the JSON is interpreted by a standard Javascript eval(), except ECMAScript 6 code points if your interpreter doesn't support those. Going non-default on any of these tends not to work in strict JSON parsers such as JQuery.
- quoteIdentifier = true
- useECMA6 = false
- allowReservedWordsInIdentifiers = false
You can change the locale being used for error messages and log messages and possibly by JSONAble objects for encoding.
You can create number formats associated with specific numeric types if you want your numbers encoded in a certain way.
Author:

Bill Davidson

See Also:

JSONConfigDefaults, Serialized Form

Constructor Summary

Constructors
Constructor and Description

JSONConfig()
Create a JSONConfig

JSONConfig(Locale locale)
Create a JSONConfig with the given locale.

Constructors
Constructor and Description
`JSONConfig()` Create a JSONConfig
`JSONConfig(Locale locale)` Create a JSONConfig with the given locale.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addNumberFormat(Class<? extends Number> numericClass, NumberFormat fmt)` Add a number format for a particular type that extends Number.
`void`	`addNumberFormat(Number numericType, NumberFormat fmt)` Add a number format for a particular type that extends Number.
`void`	`clearNumberFormats()` Clear all number formats.
`JSONConfig`	`clone()` Return a clone of this object.
`Locale`	`getLocale()` Get the locale.
`NumberFormat`	`getNumberFormat(Class<? extends Number> numericClass)` Get the number format for the given class.
`NumberFormat`	`getNumberFormat(Number num)` Get the number format for the class of th given numeric type.
`boolean`	`isAllowReservedWordsInIdentifiers()` Get the allowReservedWordsInIdentifiers policy.
`boolean`	`isDetectDataStructureLoops()` Return true if data structure loops will be detected.
`boolean`	`isEncodeNumericStringsAsNumbers()` If true, then strings will be checked for number patterns and if they look like numbers, then they won't be quoted.
`boolean`	`isEscapeBadIdentifierCodePoints()` Find out if bad identifier code points will be escaped.
`boolean`	`isEscapeNonAscii()` Check if non-ascii characters are to be encoded as Unicode escapes.
`boolean`	`isEscapeSurrogates()` Return the escape surrogates policy.
`boolean`	`isQuoteIdentifier()` Find out what the identifier quote policy is.
`boolean`	`isUnEscapeWherePossible()` The unEscape policy.
`boolean`	`isUseECMA6()` Find out if ECMAScript 6 code point escapes are enabled.
`boolean`	`isValidatePropertyNames()` Check if property names will be validated.
`void`	`removeNumberFormat(Class<? extends Number> numericClass)` Remove the requested class from the number formats that this config knows about.
`void`	`removeNumberFormat(Number num)` Remove the requested class from the number formats that this config knows about.
`void`	`setAllowReservedWordsInIdentifiers(boolean allowReservedWordsInIdentifiers)` If true then reserved words will be allowed in identifiers even when identifier validation is enabled.
`void`	`setDetectDataStructureLoops(boolean detectDataStructureLoops)` Enable or disable data structure loop detection.
`void`	`setEncodeNumericStringsAsNumbers(boolean encodeNumericStringsAsNumbers)` If true, then strings will be checked for number patterns and if they look like numbers, then they won't be quoted.
`void`	`setEscapeBadIdentifierCodePoints(boolean escapeBadIdentifierCodePoints)` If true, then any bad code points in identifiers will be escaped.
`void`	`setEscapeNonAscii(boolean escapeNonAscii)` If you want non-ascii characters encoded as Unicode escapes, you can do that by setting this to true.
`void`	`setEscapeSurrogates(boolean escapeSurrogates)` If true then all surrogates will be escaped.
`void`	`setLocale(Locale locale)` Set the locale.
`void`	`setQuoteIdentifier(boolean quoteIdentifier)` Control whether identifiers are quoted or not.
`void`	`setUnEscapeWherePossible(boolean unEscapeWherePossible)` If true then where possible, undo inline escapes in strings.
`void`	`setUseECMA6(boolean useECMA6)` If you set this to true, then when the JSONUtil generates Unicode escapes, it will use ECMAScript 6 code point escapes if they are shorter than code unit escapes.
`void`	`setValidatePropertyNames(boolean validatePropertyNames)` If true, then property names will be validated.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JSONConfig
```
public JSONConfig()
```
    Create a JSONConfig
  - JSONConfig
```
public JSONConfig(Locale locale)
```
    Create a JSONConfig with the given locale.
    
    Parameters:
    
    locale - the locale to set.
- Method Detail
  - clone
```
public JSONConfig clone()
```
    Return a clone of this object.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    a clone of this object.
  - getLocale
```
public Locale getLocale()
```
    Get the locale.
    
    Returns:
    
    the locale
  - setLocale
```
public void setLocale(Locale locale)
```
    Set the locale. This can be used for error messages or JSONAble's that can use a locale.
    
    Parameters:
    
    locale - the locale to set
  - addNumberFormat
```
public void addNumberFormat(Class<? extends Number> numericClass,
                            NumberFormat fmt)
```
    Add a number format for a particular type that extends Number. You can set one format per type that extends Number. All JSON conversions that use this config will use the given format for output of numbers of the given class.
    This could allow you to limit the number of digits printed for a float or a double for example, getting rid of excess digits caused by rounding problems in floating point numbers.
    
    Parameters:
    
    numericClass - The class.
    
    fmt - The number format.
  - addNumberFormat
```
public void addNumberFormat(Number numericType,
                            NumberFormat fmt)
```
    Add a number format for a particular type that extends Number. You can set one format per type that extends Number. All JSON conversions that use this config will use the given format for output of numbers of the given class.
    This could allow you to limit the number of digits printed for a float or a double for example, getting rid of excess digits caused by rounding problems in floating point numbers.
    
    Parameters:
    
    numericType - The object.
    
    fmt - The number format.
  - getNumberFormat
```
public NumberFormat getNumberFormat(Class<? extends Number> numericClass)
```
    Get the number format for the given class.
    
    Parameters:
    
    numericClass - A class.
    
    Returns:
    
    A number format or null if one has not been set.
  - getNumberFormat
```
public NumberFormat getNumberFormat(Number num)
```
    Get the number format for the class of th given numeric type.
    
    Parameters:
    
    num - An object that implements Number.
    
    Returns:
    
    A number format or null if one has not been set.
  - removeNumberFormat
```
public void removeNumberFormat(Class<? extends Number> numericClass)
```
    Remove the requested class from the number formats that this config knows about.
    
    Parameters:
    
    numericClass - The class.
  - removeNumberFormat
```
public void removeNumberFormat(Number num)
```
    Remove the requested class from the number formats that this config knows about.
    
    Parameters:
    
    num - An object that implements Number.
  - clearNumberFormats
```
public void clearNumberFormats()
```
    Clear all number formats.
  - isValidatePropertyNames
```
public boolean isValidatePropertyNames()
```
    Check if property names will be validated.
    
    Returns:
    
    true if property names are set to be validated.
  - setValidatePropertyNames
```
public void setValidatePropertyNames(boolean validatePropertyNames)
```
    If true, then property names will be validated. Default is true. Setting this to false will speed up generation of JSON but will not make sure that property names are valid. If execution speed of generating JSON is an issue for you, then you may want to do most of your development and testing with this set to true but switch to false when you release.
    When validation is enabled, only code points which are allowed in identifiers will be permitted as per the ECMAScript 5 or 6 standard as well as disallowing reserved words as per the JSON spec. It will also check for duplicate property names in the same object, which is possible because keys in maps are not required to be String objects and it's possible (though not likely) for two objects which are not equal to have the same result from a toString() method.
    
    Parameters:
    
    validatePropertyNames - Set to false to disable property name validation.
  - isDetectDataStructureLoops
```
public boolean isDetectDataStructureLoops()
```
    Return true if data structure loops will be detected.
    
    Returns:
    
    true if data structure loops will be detected.
  - setDetectDataStructureLoops
```
public void setDetectDataStructureLoops(boolean detectDataStructureLoops)
```
    Enable or disable data structure loop detection. Default is true. Do not change this in the middle of a toJSON call, which you could theoretically do from a JSONAble object. It could break the detection system and if you have a loop, you could get recursion until the stack overflows, which would be bad.
    
    Parameters:
    
    detectDataStructureLoops - If true then JSONUtil will attempt to detect loops in data structures.
  - isEscapeBadIdentifierCodePoints
```
public boolean isEscapeBadIdentifierCodePoints()
```
    Find out if bad identifier code points will be escaped.
    
    Returns:
    
    the the identifier escape policy.
  - setEscapeBadIdentifierCodePoints
```
public void setEscapeBadIdentifierCodePoints(boolean escapeBadIdentifierCodePoints)
```
    If true, then any bad code points in identifiers will be escaped. Default is false.
    
    Parameters:
    
    escapeBadIdentifierCodePoints - the escapeBadIdentifierCodePoints to set
  - isEncodeNumericStringsAsNumbers
```
public boolean isEncodeNumericStringsAsNumbers()
```
    If true, then strings will be checked for number patterns and if they look like numbers, then they won't be quoted.
    
    Returns:
    
    the isEncodeNumericStringsAsNumbers
  - setEncodeNumericStringsAsNumbers
```
public void setEncodeNumericStringsAsNumbers(boolean encodeNumericStringsAsNumbers)
```
    If true, then strings will be checked for number patterns and if they look like numbers, then they won't be quoted. Default is false.
    
    Parameters:
    
    encodeNumericStringsAsNumbers - the encodeNumericStringsAsNumbers to set
  - isEscapeNonAscii
```
public boolean isEscapeNonAscii()
```
    Check if non-ascii characters are to be encoded as Unicode escapes.
    
    Returns:
    
    true if non-ascii characters should be encoded with Unicode escapes.
  - setEscapeNonAscii
```
public void setEscapeNonAscii(boolean escapeNonAscii)
```
    If you want non-ascii characters encoded as Unicode escapes, you can do that by setting this to true. Default is false. One reason that you might want to do this is when debugging code that is working with code points for which you do not have a usable font.
    
    Parameters:
    
    escapeNonAscii - set to true if you want non-ascii to be Unicode escaped.
  - isUnEscapeWherePossible
```
public boolean isUnEscapeWherePossible()
```
    The unEscape policy.
    
    Returns:
    
    the unEscape policy.
  - setUnEscapeWherePossible
```
public void setUnEscapeWherePossible(boolean unEscapeWherePossible)
```
    If true then where possible, undo inline escapes in strings. Default is false. When false, escapes in strings are passed through unmodified, including hex escapes, octal escapes and ECMAScript 6 code point escapes, all of which are not allowed by the JSON standard. When true, then escapes are converted to UTF-16 before being put through the normal escape process so that unnecessary escapes are removed and escapes that are needed but aren't allowed in the JSON standard are converted to Unicode code unit escapes. This might be useful if you're reading your strings from a file or database that has old style escapes in it.
    Note that this does not apply to property names. It is only applied to string values.
    
    Parameters:
    
    unEscapeWherePossible - If true then where possible, undo inline escapes in strings.
  - isEscapeSurrogates
```
public boolean isEscapeSurrogates()
```
    Return the escape surrogates policy.
    
    Returns:
    
    the escape surrogates policy.
  - setEscapeSurrogates
```
public void setEscapeSurrogates(boolean escapeSurrogates)
```
    If true then all surrogates will be escaped.
    
    Parameters:
    
    escapeSurrogates - the escapeSurrogates to set
  - isQuoteIdentifier
```
public boolean isQuoteIdentifier()
```
    Find out what the identifier quote policy is.
    
    Returns:
    
    If true, then all identifiers will be quoted.
  - setQuoteIdentifier
```
public void setQuoteIdentifier(boolean quoteIdentifier)
```
    Control whether identifiers are quoted or not. By setting this to false, you save two characters per identifier, except for oddball identifiers that contain characters that must be quoted. Default is true, because that's what the ECMA JSON spec says to do. It might have issues in other things that read JSON and need 100% compliance with the spec. In particular, JQuery does NOT like it when you leave out the quotes. It wants the quotes according to the JSON spec. Javascript eval() tends to be just fine with having no quotes. Note that if you enable using keywords as identifiers and use a keyword as an identifier, that will force quotes anyway. If you use characters that require surrogate pairs, that will also force quotes.
    
    Parameters:
    
    quoteIdentifier - If true, then all identifiers will be quoted. If false, then only those that really need quotes will be quoted.
  - isUseECMA6
```
public boolean isUseECMA6()
```
    Find out if ECMAScript 6 code point escapes are enabled.
    
    Returns:
    
    The ECMAScript 6 policy.
  - setUseECMA6
```
public void setUseECMA6(boolean useECMA6)
```
    If you set this to true, then when the JSONUtil generates Unicode escapes, it will use ECMAScript 6 code point escapes if they are shorter than code unit escapes. This is not standard JSON and not yet widely supported by Javascript interpreters. It also allows identifiers to have letter numbers in addition to other letters. Default is false.
    
    Parameters:
    
    useECMA6 - If true, use EMCAScript 6 code point escapes and allow ECMAScript 6 identifier character set.
  - isAllowReservedWordsInIdentifiers
```
public boolean isAllowReservedWordsInIdentifiers()
```
    Get the allowReservedWordsInIdentifiers policy.
    
    Returns:
    
    the allowReservedWordsInIdentifiers policy.
  - setAllowReservedWordsInIdentifiers
```
public void setAllowReservedWordsInIdentifiers(boolean allowReservedWordsInIdentifiers)
```
    If true then reserved words will be allowed in identifiers even when identifier validation is enabled. Default is false.
    
    Parameters:
    
    allowReservedWordsInIdentifiers - the allowReservedWordsInIdentifiers to set

Class JSONConfig

Validation related options.

Safe alternate encoding options.

Allow generation of certain types of non-standard JSON.

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JSONConfig

JSONConfig

Method Detail

clone

getLocale

setLocale

addNumberFormat

addNumberFormat

getNumberFormat

getNumberFormat

removeNumberFormat

removeNumberFormat

clearNumberFormats

isValidatePropertyNames

setValidatePropertyNames

isDetectDataStructureLoops

setDetectDataStructureLoops

isEscapeBadIdentifierCodePoints

setEscapeBadIdentifierCodePoints

isEncodeNumericStringsAsNumbers

setEncodeNumericStringsAsNumbers

isEscapeNonAscii

setEscapeNonAscii

isUnEscapeWherePossible

setUnEscapeWherePossible

isEscapeSurrogates

setEscapeSurrogates

isQuoteIdentifier

setQuoteIdentifier

isUseECMA6

setUseECMA6

isAllowReservedWordsInIdentifiers

setAllowReservedWordsInIdentifiers