com.ibm.json.xml
Class XMLToJSONTransformer
- java.lang.Object
com.ibm.json.xml.XMLToJSONTransformer
- public class XMLToJSONTransformer
- extends java.lang.Object
in JSON (in non-compact form) becomes
Constructor Summary
Constructor and Description |
---|
XMLToJSONTransformer()
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
transform(java.io.File xmlFile)
Method to take an XML file and return a String of the JSON format.
|
|
transform(java.io.File xmlFile,boolean verbose)
Method to take an XML file and return a String of the JSON format.
|
|
transform(java.io.InputStream xmlStream)
Method to take an input stream to an XML document and return a String of the JSON format.
|
|
transform(java.io.InputStream xmlStream,boolean verbose)
Method to take an input stream to an XML document and return a String of the JSON format.
|
|
transform(java.io.InputStream XMLStream,java.io.OutputStream JSONStream)
Method to do the transform from an XML input stream to a JSON stream.
|
|
transform(java.io.InputStream XMLStream,java.io.OutputStream JSONStream,boolean verbose)
Method to do the transform from an XML input stream to a JSON stream.
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail
XMLToJSONTransformer
- public XMLToJSONTransformer()
Method Detail
transform
- public static void transform(java.io.InputStream XMLStream,
- java.io.OutputStream JSONStream)
- throws org.xml.sax.SAXException
- java.io.IOException
Method to do the transform from an XML input stream to a JSON stream.
Neither input nor output streams are closed. Closure is left up to the caller. Same as calling transform(inStream, outStream, false); (Default is compact form)
Parameters:
XMLStream
- The XML stream to convert to JSON JSONStream
- The stream to write out JSON to. The contents written to this stream are always in UTF-8 format. Throws:
org.xml.sax.SAXException
- Thrown is a parse error occurs. java.io.IOException
- Thrown if an IO error occurs. transform
- public static void transform(java.io.InputStream XMLStream,
- java.io.OutputStream JSONStream,
- boolean verbose)
- throws org.xml.sax.SAXException
- java.io.IOException
Method to do the transform from an XML input stream to a JSON stream.
Neither input nor output streams are closed. Closure is left up to the caller.
Parameters:
XMLStream
- The XML stream to convert to JSON JSONStream
- The stream to write out JSON to. The contents written to this stream are always in UTF-8 format. verbose
- Flag to denote whether or not to render the JSON text in verbose (indented easy to read), or compact (not so easy to read, but smaller), format. Throws:
org.xml.sax.SAXException
- Thrown if a parse error occurs. java.io.IOException
- Thrown if an IO error occurs. transform
- public static java.lang.String transform( java.io.InputStream xmlStream)
- throws org.xml.sax.SAXException
- java.io.IOException
Method to take an input stream to an XML document and return a String of the JSON format.
Note that the xmlStream is not closed when read is complete. This is left up to the caller, who may wish to do more with it.
This is the same as transform(xmlStream,false)
Parameters:
xmlStream
- The InputStream to an XML document to transform to JSON. Returns:
A string of the JSON representation of the XML file
Throws:
org.xml.sax.SAXException
- Thrown if an error occurs during parse. java.io.IOException
- Thrown if an IOError occurs. transform
- public static java.lang.String transform( java.io.InputStream xmlStream,
- boolean verbose)
- throws org.xml.sax.SAXException
- java.io.IOException
Method to take an input stream to an XML document and return a String of the JSON format. Note that the xmlStream is not closed when read is complete. This is left up to the caller, who may wish to do more with it.
Parameters:
xmlStream
- The InputStream to an XML document to transform to JSON. verbose
- Boolean flag denoting whther or not to write the JSON in verbose (formatted), or compact form (no whitespace) Returns:
A string of the JSON representation of the XML file
Throws:
org.xml.sax.SAXException
- Thrown if an error occurs during parse. java.io.IOException
- Thrown if an IOError occurs. transform
- public static java.lang.String transform( java.io.File xmlFile,
- boolean verbose)
- throws org.xml.sax.SAXException
- java.io.IOException
Method to take an XML file and return a String of the JSON format.
Parameters:
xmlFile
- The XML file to transform to JSON. verbose
- Boolean flag denoting whther or not to write the JSON in verbose (formatted), or compact form (no whitespace) Returns:
A string of the JSON representation of the XML file
Throws:
org.xml.sax.SAXException
- Thrown if an error occurs during parse. java.io.IOException
- Thrown if an IOError occurs. transform
- public static java.lang.String transform( java.io.File xmlFile)
- throws org.xml.sax.SAXException
- java.io.IOException
Method to take an XML file and return a String of the JSON format.
This is the same as transform(xmlStream,false)
Parameters:
xmlFile
- The XML file to convert to JSON. Returns:
A string of the JSON representation of the XML file
Throws:
org.xml.sax.SAXException
- Thrown if an error occurs during parse. java.io.IOException
- Thrown if an IOError occurs.