Constructor Detail

• public JsonXmlSerializer()

  Creates a new XMLSerializer with default options.
  

  • objectName: 'o'
  • arrayName: 'a'
  • elementName: 'e'
  • typeHinstEnabled: true
  • typeHinstCompatibility: true
  • namespaceLenient: false
  • expandableProperties: []
  • skipNamespaces: false
  • removeNameSpacePrefixFromElement: false
  • trimSpaces: false

Method Detail

• public void addNamespace(java.lang.String prefix, java.lang.String uri)

  Adds a namespace declaration to the root element.

  Parameters:

  prefix - namespace prefix

  uri - namespace uri

• public void addNamespace(java.lang.String prefix, java.lang.String uri, java.lang.String elementName)

  Adds a namespace declaration to an element.
  If the elementName param is null or blank, the namespace declaration will be added to the root element.

  Parameters:

  prefix - namespace prefix

  uri - namespace uri

  elementName - name of target element

• public void clearNamespaces()

  Removes all namespaces declarations (from root an elements).

• public void clearNamespaces(java.lang.String elementName)

  Removes all namespace declarations from an element.
  If the elementName param is null or blank, the declarations will be removed from the root element.

  Parameters:

  elementName - name of target element

• public java.lang.String getArrayName()

  Returns the name used for JSONArray.

• public java.lang.String getElementName()

  Returns the name used for JSONArray elements.

• public java.lang.String[] getExpandableProperties()

  Returns a list of properties to be expanded from child to parent.

• public java.lang.String getObjectName()

  Returns the name used for JSONArray.

• public java.lang.String getRootName()

  Returns the name used for the root element.

• public boolean isForceTopLevelObject()

• public boolean isNamespaceLenient()

  Returns wether this serializer is tolerant to namespaces without URIs or not.

• public boolean isRemoveNamespacePrefixFromElements()

  Returns wether this serializer will remove namespace prefix from elements or not.

• public boolean isSkipNamespaces()

  Returns wether this serializer will skip adding namespace declarations to elements or not.

• public boolean isSkipWhitespace()

  Returns wether this serializer will skip whitespace or not.

• public boolean isTrimSpaces()

  Returns wether this serializer will trim leading and trealing whitespace from values or not.

• public boolean isTypeHintsCompatibility()

  Returns true if types hints will have a 'json_' prefix or not.

• public boolean isTypeHintsEnabled()

  Returns true if JSON types will be included as attributes.

• public JsonNode read(java.lang.String xml)

  Creates a JSON value from a XML string.

  throws:

  IOException if the conversion from XML to JSON can't be made for I/O or format reasons.

  Parameters:

  xml - A well-formed xml document in a String

  Returns:

  a JSONNull, JSONObject or JSONArray

• public JsonNode readFromFile(java.io.File file)

  Creates a JSON value from a File.

  throws:

  IOException if the conversion from XML to JSON can't be made for I/O or format reasons.

  Parameters:

  file

  Returns:

  a JSONNull, JSONObject or JSONArray

• public JsonNode readFromFile(java.lang.String path)

  Creates a JSON value from a File.

  throws:

  Exception if the conversion from XML to JSON can't be made for I/O or format reasons.

  Parameters:

  path

  Returns:

  a JSONNull, JSONObject or JSONArray

• public JsonNode readFromStream(java.io.InputStream stream)

  Creates a JSON value from an input stream.

  throws:

  IOException if the conversion from XML to JSON can't be made for I/O or format reasons.

  Parameters:

  stream

  Returns:

  a JSONNull, JSONObject or JSONArray

• public void removeNamespace(java.lang.String prefix)

  Removes a namespace from the root element.

  Parameters:

  prefix - namespace prefix

• public void removeNamespace(java.lang.String prefix, java.lang.String elementName)

  Removes a namespace from the root element.
  If the elementName is null or blank, the namespace will be removed from the root element.

  Parameters:

  prefix - namespace prefix

  elementName - name of target element

• public void setArrayName(java.lang.String arrayName)

  Sets the name used for JSONArray.
  Default is 'a'.

• public void setElementName(java.lang.String elementName)

  Sets the name used for JSONArray elements.
  Default is 'e'.

• public void setExpandableProperties(java.lang.String[] expandableProperties)

  Sets the list of properties to be expanded from child to parent.

• public void setForceTopLevelObject(boolean forceTopLevelObject)

• public void setNamespace(java.lang.String prefix, java.lang.String uri)

  Sets the namespace declaration to the root element.
  Any previous values are discarded.

  Parameters:

  prefix - namespace prefix

  uri - namespace uri

• public void setNamespace(java.lang.String prefix, java.lang.String uri, java.lang.String elementName)

  Adds a namespace declaration to an element.
  Any previous values are discarded. If the elementName param is null or blank, the namespace declaration will be added to the root element.

  Parameters:

  prefix - namespace prefix

  uri - namespace uri

  elementName - name of target element

• public void setNamespaceLenient(boolean namespaceLenient)

  Sets wether this serializer is tolerant to namespaces without URIs or not.

• public void setObjectName(java.lang.String objectName)

  Sets the name used for JSONObject.
  Default is 'o'.

• public void setRemoveNamespacePrefixFromElements(boolean removeNamespacePrefixFromElements)

  Sets if this serializer will remove namespace prefix from elements when reading.

• public void setRootName(java.lang.String rootName)

  Sets the name used for the root element.

• public void setSkipNamespaces(boolean skipNamespaces)

  Sets if this serializer will skip adding namespace declarations to elements when reading.

• public void setSkipWhitespace(boolean skipWhitespace)

  Sets if this serializer will skip whitespace when reading.

• public void setTrimSpaces(boolean trimSpaces)

  Sets if this serializer will trim leading and trealing whitespace from values when reading.

• public void setTypeHintsCompatibility(boolean typeHintsCompatibility)

  Sets wether types hints will have a 'json_' prefix or not.

• public void setTypeHintsEnabled(boolean typeHintsEnabled)

  Sets wether JSON types will be included as attributes.

• public java.lang.String write(JsonNode json)

  Writes a JSON value into a XML string with UTF-8 encoding.
  

  throws:

  Exception if the conversion from JSON to XML can't be made for I/O reasons.

  Parameters:

  json - The JSON value to transform

  Returns:

  a String representation of a well-formed xml document.

• public java.lang.String write(JsonNode json, java.lang.String encoding)

  Writes a JSON value into a XML string with an specific encoding.
  If the encoding string is null it will use UTF-8.

  throws:

  Exception if the conversion from JSON to XML can't be made for I/O reasons or the encoding is not supported.

  Parameters:

  json - The JSON value to transform

  encoding - The xml encoding to use

  Returns:

  a String representation of a well-formed xml document.