Interface JsonXMLConfig
-
- All Known Implementing Classes:
JsonXMLConfigImpl
public interface JsonXMLConfig
Json XML factory configuration interface.
A
JsonXMLConfig
instance can be used to configure either ofJsonXMLInputFactory
orJsonXMLOutputFactory
.Default values are defined by static
DEFAULT
instance.- See Also:
JsonXMLInputFactory
,JsonXMLOutputFactory
-
-
Field Summary
Fields Modifier and Type Field Description static JsonXMLConfig
DEFAULT
Default configuration:
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getCustomRegex()
Format output ignoring scientific numbersString
getCustomReplaceRegex()
String
getCustomReplaceSequence()
char
getNamespaceSeparator()
Namespace prefix separator.QName
getVirtualRoot()
JSON documents may have have multiple root properties.boolean
isAutoArray()
Trigger arrays automatically?boolean
isAutoPrimitive()
Convert element text to number/boolean/null primitives automatically?boolean
isMultiplePI()
Whether to use theJsonXMLStreamConstants.MULTIPLE_PI_TARGET
processing instruction to indicate an array start.boolean
isNamespaceDeclarations()
Whether to write namespace declarations.boolean
isPreserverNamespacesForJson()
Preserves the namespace declarations in the JSON output in XML to JSON transformations.boolean
isPrettyPrint()
Format output for better readability?boolean
isProcessNCNames()
Builds valid XML NCNames when building XML element names in XML to JSON transformations.boolean
isReadWriteXmlNil()
boolean
isRepairingNamespaces()
Repair namespaces when writing+>boolean
isWriteNullForEmptyElements()
Used in XML->JSON conversion.
-
-
-
Field Detail
-
DEFAULT
static final JsonXMLConfig DEFAULT
Default configuration:
- autoArray -
false
- autoPrimitive -
false
- multiplePI -
true
- namespaceDeclarations -
true
- namespaceSeparator -
':'
- prettyPrint -
false
- virtualRoot -
null
- autoArray -
-
-
Method Detail
-
isAutoArray
boolean isAutoArray()
Trigger arrays automatically?
- Returns:
- auto array flag
- See Also:
JsonXMLOutputFactory.PROP_AUTO_ARRAY
-
isAutoPrimitive
boolean isAutoPrimitive()
Convert element text to number/boolean/null primitives automatically?
- Returns:
- auto primitive flag
- See Also:
JsonXMLOutputFactory.PROP_AUTO_ARRAY
-
isMultiplePI
boolean isMultiplePI()
Whether to use the
IfJsonXMLStreamConstants.MULTIPLE_PI_TARGET
processing instruction to indicate an array start. Iftrue
, a PI is used to inform the writer to begin an array, passing the name of following multiple elements as data. The writer will close arrays automatically.true
, this reader will insert a PI with the field name as PI data.Note that the element given in the PI may occur zero times, indicating an "empty array".
- Returns:
- multiple PI flag
- See Also:
JsonXMLInputFactory.PROP_MULTIPLE_PI
,JsonXMLOutputFactory.PROP_MULTIPLE_PI
-
isNamespaceDeclarations
boolean isNamespaceDeclarations()
Whether to write namespace declarations.
- Returns:
- namespace declarations flag
- See Also:
JsonXMLOutputFactory.PROP_NAMESPACE_DECLARATIONS
-
getNamespaceSeparator
char getNamespaceSeparator()
Namespace prefix separator.
- Returns:
- namespace separator
- See Also:
JsonXMLInputFactory.PROP_NAMESPACE_SEPARATOR
,JsonXMLOutputFactory.PROP_NAMESPACE_SEPARATOR
-
isPrettyPrint
boolean isPrettyPrint()
Format output for better readability?
- Returns:
- pretty print flag
- See Also:
JsonXMLOutputFactory.PROP_PRETTY_PRINT
-
getVirtualRoot
QName getVirtualRoot()
JSON documents may have have multiple root properties. However, XML requires a single root element. This property specifies the root as a "virtual" element, which will be removed from the stream when writing and added to the stream when reading.
- Returns:
- virtual root
- See Also:
JsonXMLInputFactory.PROP_VIRTUAL_ROOT
,JsonXMLOutputFactory.PROP_VIRTUAL_ROOT
-
isRepairingNamespaces
boolean isRepairingNamespaces()
Repair namespaces when writing+>
- Returns:
- namespace-repairing flag
- See Also:
XMLOutputFactory.IS_REPAIRING_NAMESPACES
-
getCustomRegex
String getCustomRegex()
Format output ignoring scientific numbers
- Returns:
- autoprimitive enabled with scientific Number Ignore flag
- See Also:
JsonXMLOutputFactory.PROP_CUSTOM_REGEX
-
getCustomReplaceRegex
String getCustomReplaceRegex()
-
getCustomReplaceSequence
String getCustomReplaceSequence()
-
isReadWriteXmlNil
boolean isReadWriteXmlNil()
-
isWriteNullForEmptyElements
boolean isWriteNullForEmptyElements()
Used in XML->JSON conversion. Decides whether to set null or "" for an empty XML element without nil attribute- Returns:
- true if null is written, false if "" is written
-
isPreserverNamespacesForJson
boolean isPreserverNamespacesForJson()
Preserves the namespace declarations in the JSON output in XML to JSON transformations.- Returns:
- preserveNamespacesForJson
-
isProcessNCNames
boolean isProcessNCNames()
Builds valid XML NCNames when building XML element names in XML to JSON transformations.- Returns:
- processNCNames
-
-