org.graalvm.shadowed.org.json

Class XMLParserConfiguration

java.lang.Object

org.graalvm.shadowed.org.json.ParserConfiguration

org.graalvm.shadowed.org.json.XMLParserConfiguration

public class XMLParserConfiguration
extends ParserConfiguration

Configuration object for the XML parser. The configuration is immutable.

Field Summary

Fields

Modifier and Type	Field and Description
static XMLParserConfiguration	KEEP_STRINGS Original configuration of the XML Parser except that values are kept as strings.
static XMLParserConfiguration	ORIGINAL Original Configuration of the XML Parser.

Fields inherited from class org.graalvm.shadowed.org.json.ParserConfiguration

DEFAULT_MAXIMUM_NESTING_DEPTH, keepStrings, maxNestingDepth, UNDEFINED_MAXIMUM_NESTING_DEPTH

Constructor Summary

Constructors

Constructor and Description
XMLParserConfiguration() Default parser configuration.

Method Summary

Modifier and Type	Method and Description
protected XMLParserConfiguration	clone() Provides a new instance of the same configuration.
String	getcDataTagName() The name of the key in a JSON Object that indicates a CDATA section.
Set<String>	getForceList() When parsing the XML into JSON, specifies that tags that will be converted to arrays in this configuration Set<String> to parse the provided tags' values as arrays
Map<String,XMLXsiTypeConverter<?>>	getXsiTypeMap() When parsing the XML into JSON, specifies that the values with attribute xsi:type will be converted to target type defined to client in this configuration Map<String, XMLXsiTypeConverter<?>> to parse values with attribute xsi:type="integer" as integer, xsi:type="string" as string
boolean	isConvertNilAttributeToNull() When parsing the XML into JSON, specifies if values with attribute xsi:nil="true" should be kept as attribute(false), or they should be converted to null(true)
XMLParserConfiguration	withcDataTagName(String newVal) The name of the key in a JSON Object that indicates a CDATA section.
XMLParserConfiguration	withConvertNilAttributeToNull(boolean newVal) When parsing the XML into JSON, specifies if values with attribute xsi:nil="true" should be kept as attribute(false), or they should be converted to null(true)
XMLParserConfiguration	withForceList(Set<String> forceList) When parsing the XML into JSON, specifies that tags that will be converted to arrays in this configuration Set<String> to parse the provided tags' values as arrays
XMLParserConfiguration	withKeepStrings(boolean newVal) When parsing the XML into JSON, specifies if values should be kept as strings (true), or if they should try to be guessed into JSON values (numeric, boolean, string)
XMLParserConfiguration	withMaxNestingDepth(int maxNestingDepth) Defines the maximum nesting depth that the parser will descend before throwing an exception when parsing the XML into JSON.
XMLParserConfiguration	withXsiTypeMap(Map<String,XMLXsiTypeConverter<?>> xsiTypeMap) When parsing the XML into JSON, specifies that the values with attribute xsi:type will be converted to target type defined to client in this configuration Map<String, XMLXsiTypeConverter<?>> to parse values with attribute xsi:type="integer" as integer, xsi:type="string" as string

Methods inherited from class org.graalvm.shadowed.org.json.ParserConfiguration

getMaxNestingDepth, isKeepStrings

Methods inherited from class java.lang.Object

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

Field Detail

ORIGINAL

public static final XMLParserConfiguration ORIGINAL

Original Configuration of the XML Parser.

KEEP_STRINGS

public static final XMLParserConfiguration KEEP_STRINGS

Original configuration of the XML Parser except that values are kept as strings.

Constructor Detail

XMLParserConfiguration

public XMLParserConfiguration()

Default parser configuration. Does not keep strings (tries to implicitly convert values), and the CDATA Tag Name is "content".

Method Detail

clone

protected XMLParserConfiguration clone()

Provides a new instance of the same configuration.

Overrides:

clone in class ParserConfiguration

withKeepStrings

public XMLParserConfiguration withKeepStrings(boolean newVal)

When parsing the XML into JSON, specifies if values should be kept as strings (true), or if they should try to be guessed into JSON values (numeric, boolean, string)

Overrides:

withKeepStrings in class ParserConfiguration

Parameters:

newVal - new value to use for the keepStrings configuration option.

Returns:

The existing configuration will not be modified. A new configuration is returned.

getcDataTagName

public String getcDataTagName()

The name of the key in a JSON Object that indicates a CDATA section. Historically this has been the value "content" but can be changed. Use null to indicate no CDATA processing.

Returns:

The cDataTagName configuration value.

withcDataTagName

public XMLParserConfiguration withcDataTagName(String newVal)

The name of the key in a JSON Object that indicates a CDATA section. Historically this has been the value "content" but can be changed. Use null to indicate no CDATA processing.

Parameters:

newVal - new value to use for the cDataTagName configuration option.

Returns:

The existing configuration will not be modified. A new configuration is returned.

isConvertNilAttributeToNull

public boolean isConvertNilAttributeToNull()

When parsing the XML into JSON, specifies if values with attribute xsi:nil="true" should be kept as attribute(false), or they should be converted to null(true)

Returns:

The convertNilAttributeToNull configuration value.

withConvertNilAttributeToNull

public XMLParserConfiguration withConvertNilAttributeToNull(boolean newVal)

When parsing the XML into JSON, specifies if values with attribute xsi:nil="true" should be kept as attribute(false), or they should be converted to null(true)

Parameters:

newVal - new value to use for the convertNilAttributeToNull configuration option.

Returns:

The existing configuration will not be modified. A new configuration is returned.

getXsiTypeMap

public Map<String,XMLXsiTypeConverter<?>> getXsiTypeMap()

When parsing the XML into JSON, specifies that the values with attribute xsi:type will be converted to target type defined to client in this configuration Map<String, XMLXsiTypeConverter<?>> to parse values with attribute xsi:type="integer" as integer, xsi:type="string" as string

Returns:

xsiTypeMap unmodifiable configuration map.

withXsiTypeMap

public XMLParserConfiguration withXsiTypeMap(Map<String,XMLXsiTypeConverter<?>> xsiTypeMap)

When parsing the XML into JSON, specifies that the values with attribute xsi:type will be converted to target type defined to client in this configuration Map<String, XMLXsiTypeConverter<?>> to parse values with attribute xsi:type="integer" as integer, xsi:type="string" as string

Parameters:

xsiTypeMap - new HashMap<String, XMLXsiTypeConverter<?>>() to parse values with attribute xsi:type="integer" as integer, xsi:type="string" as string

Returns:

The existing configuration will not be modified. A new configuration is returned.

getForceList

public Set<String> getForceList()

When parsing the XML into JSON, specifies that tags that will be converted to arrays in this configuration Set<String> to parse the provided tags' values as arrays

Returns:

forceList unmodifiable configuration set.

withForceList

public XMLParserConfiguration withForceList(Set<String> forceList)

When parsing the XML into JSON, specifies that tags that will be converted to arrays in this configuration Set<String> to parse the provided tags' values as arrays

Parameters:

forceList - new HashSet<String>() to parse the provided tags' values as arrays

Returns:

The existing configuration will not be modified. A new configuration is returned.

withMaxNestingDepth

public XMLParserConfiguration withMaxNestingDepth(int maxNestingDepth)

Defines the maximum nesting depth that the parser will descend before throwing an exception when parsing the XML into JSON. The default max nesting depth is 512, which means the parser will throw a JsonException if the maximum depth is reached. Using any negative value as a parameter is equivalent to setting no limit to the nesting depth, which means the parses will go as deep as the maximum call stack size allows.

Overrides:

withMaxNestingDepth in class ParserConfiguration

Parameters:

maxNestingDepth - the maximum nesting depth allowed to the XML parser

Returns:

The existing configuration will not be modified. A new configuration is returned.