Package org.json

Class XML

  • public class XML
extends Object
    This provides static methods to convert an XML text into a JSONObject, and to covert a JSONObject into an XML text.
    Version:
    2016-08-10
    Author:
    JSON.org

    • Constructor Detail

      • XML

        public XML()

    • Method Detail

      • escape

        public static String escape​(String string)
        Replace special characters with XML escapes: 
        
 & (ampersand) is replaced by &
 < (less than) is replaced by <
 > (greater than) is replaced by >
 " (double quote) is replaced by "
 ' (single quote / apostrophe) is replaced by '
        Parameters:
        string - The string to be escaped.
        Returns:
        The escaped string.

      • unescape

        public static String unescape​(String string)
        Removes XML escapes from the string.
        Parameters:
        string - string to remove escapes from
        Returns:
        string with converted entities

      • noSpace

        public static void noSpace​(String string)
                    throws JSONException
        Throw an exception if the string contains whitespace. Whitespace is not allowed in tagNames and attributes.
        Parameters:
        string - A string.
        Throws:
        JSONException - Thrown if the string contains whitespace or is empty.

      • stringToValue

        public static Object stringToValue​(String string,
                                   XMLXsiTypeConverter<?> typeConverter)
        This method tries to convert the given string value to the target object
        Parameters:
        string - String to convert
        typeConverter - value converter to convert string to integer, boolean e.t.c
        Returns:
        JSON value of this string or the string

      • stringToValue

        public static Object stringToValue​(String string)
        This method is the same as JSONObject.stringToValue(String).
        Parameters:
        string - String to convert
        Returns:
        JSON value of this string or the string

      • toJSONObject

        public static JSONObject toJSONObject​(String string)
                               throws JSONException
        Convert a well-formed (but not necessarily valid) XML string into a JSONObject. Some information may be lost in this transformation because JSON is a data format and XML is a document format. XML uses elements, attributes, and content text, while JSON uses unordered collections of name/value pairs and arrays of values. JSON does not does not like to distinguish between elements and attributes. Sequences of similar elements are represented as JSONArrays. Content text may be placed in a "content" member. Comments, prologs, DTDs, and 
        
 &lt;[ [ ]]>
        are ignored.
        Parameters:
        string - The source string.
        Returns:
        A JSONObject containing the structured data from the XML string.
        Throws:
        JSONException - Thrown if there is an errors while parsing the string

      • toJSONObject

        public static JSONObject toJSONObject​(Reader reader)
                               throws JSONException
        Convert a well-formed (but not necessarily valid) XML into a JSONObject. Some information may be lost in this transformation because JSON is a data format and XML is a document format. XML uses elements, attributes, and content text, while JSON uses unordered collections of name/value pairs and arrays of values. JSON does not does not like to distinguish between elements and attributes. Sequences of similar elements are represented as JSONArrays. Content text may be placed in a "content" member. Comments, prologs, DTDs, and 
        
 &lt;[ [ ]]>
        are ignored.
        Parameters:
        reader - The XML source reader.
        Returns:
        A JSONObject containing the structured data from the XML string.
        Throws:
        JSONException - Thrown if there is an errors while parsing the string

      • toJSONObject

        public static JSONObject toJSONObject​(Reader reader,
                                      boolean keepStrings)
                               throws JSONException
        Convert a well-formed (but not necessarily valid) XML into a JSONObject. Some information may be lost in this transformation because JSON is a data format and XML is a document format. XML uses elements, attributes, and content text, while JSON uses unordered collections of name/value pairs and arrays of values. JSON does not does not like to distinguish between elements and attributes. Sequences of similar elements are represented as JSONArrays. Content text may be placed in a "content" member. Comments, prologs, DTDs, and 
        
 &lt;[ [ ]]>
        are ignored. All values are converted as strings, for 1, 01, 29.0 will not be coerced to numbers but will instead be the exact value as seen in the XML document.
        Parameters:
        reader - The XML source reader.
        keepStrings - If true, then values will not be coerced into boolean or numeric values and will instead be left as strings
        Returns:
        A JSONObject containing the structured data from the XML string.
        Throws:
        JSONException - Thrown if there is an errors while parsing the string

      • toJSONObject

        public static JSONObject toJSONObject​(Reader reader,
                                      XMLParserConfiguration config)
                               throws JSONException
        Convert a well-formed (but not necessarily valid) XML into a JSONObject. Some information may be lost in this transformation because JSON is a data format and XML is a document format. XML uses elements, attributes, and content text, while JSON uses unordered collections of name/value pairs and arrays of values. JSON does not does not like to distinguish between elements and attributes. Sequences of similar elements are represented as JSONArrays. Content text may be placed in a "content" member. Comments, prologs, DTDs, and 
        
 &lt;[ [ ]]>
        are ignored. All values are converted as strings, for 1, 01, 29.0 will not be coerced to numbers but will instead be the exact value as seen in the XML document.
        Parameters:
        reader - The XML source reader.
        config - Configuration options for the parser
        Returns:
        A JSONObject containing the structured data from the XML string.
        Throws:
        JSONException - Thrown if there is an errors while parsing the string

      • toJSONObject

        public static JSONObject toJSONObject​(String string,
                                      boolean keepStrings)
                               throws JSONException
        Convert a well-formed (but not necessarily valid) XML string into a JSONObject. Some information may be lost in this transformation because JSON is a data format and XML is a document format. XML uses elements, attributes, and content text, while JSON uses unordered collections of name/value pairs and arrays of values. JSON does not does not like to distinguish between elements and attributes. Sequences of similar elements are represented as JSONArrays. Content text may be placed in a "content" member. Comments, prologs, DTDs, and 
        
 &lt;[ [ ]]>
        are ignored. All values are converted as strings, for 1, 01, 29.0 will not be coerced to numbers but will instead be the exact value as seen in the XML document.
        Parameters:
        string - The source string.
        keepStrings - If true, then values will not be coerced into boolean or numeric values and will instead be left as strings
        Returns:
        A JSONObject containing the structured data from the XML string.
        Throws:
        JSONException - Thrown if there is an errors while parsing the string

      • toJSONObject

        public static JSONObject toJSONObject​(String string,
                                      XMLParserConfiguration config)
                               throws JSONException
        Convert a well-formed (but not necessarily valid) XML string into a JSONObject. Some information may be lost in this transformation because JSON is a data format and XML is a document format. XML uses elements, attributes, and content text, while JSON uses unordered collections of name/value pairs and arrays of values. JSON does not does not like to distinguish between elements and attributes. Sequences of similar elements are represented as JSONArrays. Content text may be placed in a "content" member. Comments, prologs, DTDs, and 
        
 &lt;[ [ ]]>
        are ignored. All values are converted as strings, for 1, 01, 29.0 will not be coerced to numbers but will instead be the exact value as seen in the XML document.
        Parameters:
        string - The source string.
        config - Configuration options for the parser.
        Returns:
        A JSONObject containing the structured data from the XML string.
        Throws:
        JSONException - Thrown if there is an errors while parsing the string

      • toString

        public static String toString​(Object object)
                       throws JSONException
        Convert a JSONObject into a well-formed, element-normal XML string.
        Parameters:
        object - A JSONObject.
        Returns:
        A string.
        Throws:
        JSONException - Thrown if there is an error parsing the string

      • toString

        public static String toString​(Object object,
                              String tagName)
        Convert a JSONObject into a well-formed, element-normal XML string.
        Parameters:
        object - A JSONObject.
        tagName - The optional name of the enclosing tag.
        Returns:
        A string.
        Throws:
        JSONException - Thrown if there is an error parsing the string

      • toString

        public static String toString​(Object object,
                              String tagName,
                              XMLParserConfiguration config)
                       throws JSONException
        Convert a JSONObject into a well-formed, element-normal XML string.
        Parameters:
        object - A JSONObject.
        tagName - The optional name of the enclosing tag.
        config - Configuration that can control output to XML.
        Returns:
        A string.
        Throws:
        JSONException - Thrown if there is an error parsing the string

      • toString

        public static String toString​(Object object,
                              int indentFactor)
        Convert a JSONObject into a well-formed, pretty printed element-normal XML string.
        Parameters:
        object - A JSONObject.
        indentFactor - The number of spaces to add to each level of indentation.
        Returns:
        A string.
        Throws:
        JSONException - Thrown if there is an error parsing the string

      • toString

        public static String toString​(Object object,
                              String tagName,
                              int indentFactor)
        Convert a JSONObject into a well-formed, pretty printed element-normal XML string.
        Parameters:
        object - A JSONObject.
        tagName - The optional name of the enclosing tag.
        indentFactor - The number of spaces to add to each level of indentation.
        Returns:
        A string.
        Throws:
        JSONException - Thrown if there is an error parsing the string

      • toString

        public static String toString​(Object object,
                              String tagName,
                              XMLParserConfiguration config,
                              int indentFactor)
                       throws JSONException
        Convert a JSONObject into a well-formed, pretty printed element-normal XML string.
        Parameters:
        object - A JSONObject.
        tagName - The optional name of the enclosing tag.
        config - Configuration that can control output to XML.
        indentFactor - The number of spaces to add to each level of indentation.
        Returns:
        A string.
        Throws:
        JSONException - Thrown if there is an error parsing the string