XmlDocumentJsonHandler (net.markenwerk:utils-json-handler-xml 2.0.1 API)

java.lang.Object
- net.markenwerk.utils.json.handler.IdleJsonHandler<Document>
- - net.markenwerk.utils.json.common.handler.xml.XmlDocumentJsonHandler

All Implemented Interfaces:

JsonHandler<Document>
```
public final class XmlDocumentJsonHandler
extends IdleJsonHandler<Document>
```
A XmlDocumentJsonHandler is a JsonHandler that creates a XML Document that represents the same data as the handled JSON document using the following rules:
- A JSON array is represented as a tag with name array.
- A JSON object is represented as a tag with name object.
- A JSON object entry is represented as a tag with name entry.
- The name of a JSON object entry is represented as an attribute of the entry tag with name name.
- A JSON null is represented as a tag with name null.
- A JSON boolean is represented as a tag with name boolean.
- The value of the JSON boolean represented as an attribute of the boolean tag with name value .
- A JSON number is represented as a tag with name number.
- The value of the JSON number represented as an attribute of the number tag with name value.
- A JSON string is represented as a tag with name string.
- The value of the JSON string represented as an attribute of the string tag with name value .
Example:
Input JSON document:
```
 {
     "nullValue": null,
     "booleanValue": true,
     "longValue": -10000,
     "doubleValue": 42.23,
     "stringValue": "foobar",
     "arrayValue": [],
     "objectValue": {}
 }
 
```
Output XML document:
```
 
 <?xml version="1.0" encoding="UTF-8"?>
 <object>
    <entry name="nullValue">
       <null />
    </entry>
    <entry name="booleanValue">
       <boolean value="true" />
    </entry>
    <entry name="longValue">
       <number value="-10000"/>
    </entry>
    <entry name="doubleValue">
       <number value="42.23" />
    </entry>
    <entry name="stringValue">
       <string value="foobar">
    </entry>
    <entry name="arrayValue">
       <array />
    </entry>
    <entry name="objectValue">
       <object />
    </entry>
 </object>
 
 
```
Since:

1.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors
Constructor and Description
`XmlDocumentJsonHandler()` Creates a new `XmlDocumentJsonHandler` using a @link `default` `DocumentBuilder` created by a `default` `DocumentBuilderFactory`.
`XmlDocumentJsonHandler(DocumentBuilder documentBuilder)` Create a new `XmlDocumentJsonHandler` using the given `DocumentBuilder` to create a new XML `Document`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Document`	`getResult()` Returns the calculated result.
`void`	`onArrayBegin()` Called when the parsing of a JSON array started.
`void`	`onArrayEnd()` Called when the parsing of a JSON array ended.
`void`	`onBoolean(boolean value)` Called when the parsing of a JSON object encountered a JSON boolean.
`void`	`onDocumentBegin()` Called when the parsing of a JSON document started.
`void`	`onDocumentEnd()` Called when the parsing of a JSON document ended.
`void`	`onDouble(double value)` Called when the parsing of a JSON object encountered a JSON number, that represents a decimal value.
`void`	`onLong(long value)` Called when the parsing of a JSON object encountered a JSON number, that represents an integer value.
`void`	`onName(String name)` Called when the parsing of a JSON object encountered the name for the next JSON value.
`void`	`onNext()` Called when the parsing of a JSON array or JSON object encountered another element.
`void`	`onNull()` Called when the parsing of a JSON object encountered a JSON null.
`void`	`onObjectBegin()` Called when the parsing of a JSON object started.
`void`	`onObjectEnd()` Called when the parsing of a JSON object ended.
`void`	`onString(String value)` Called when the parsing of a JSON object encountered a JSON string.

Methods inherited from class net.markenwerk.utils.json.handler.IdleJsonHandler
checkDouble, checkName, checkString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - XmlDocumentJsonHandler
```
public XmlDocumentJsonHandler()
```
    Creates a new XmlDocumentJsonHandler using a @link default DocumentBuilder created by a default DocumentBuilderFactory.
  - XmlDocumentJsonHandler
```
public XmlDocumentJsonHandler(DocumentBuilder documentBuilder)
                       throws IllegalArgumentException
```
    Create a new XmlDocumentJsonHandler using the given DocumentBuilder to create a new XML Document.
    
    Parameters:
    
    documentBuilder - The DocumentBuilder to be used.
    
    Throws:
    
    IllegalArgumentException - If the given DocumentBuilder is null.
- Method Detail
  - onDocumentBegin
```
public void onDocumentBegin()
                     throws JsonException
```
    Description copied from interface: JsonHandler
    
    Called when the parsing of a JSON document started.
    Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).
    
    Specified by:
    
    onDocumentBegin in interface JsonHandler<Document>
    
    Overrides:
    
    onDocumentBegin in class IdleJsonHandler<Document>
    
    Throws:
    
    JsonException - If the handling failed.
  - onDocumentEnd
```
public void onDocumentEnd()
                   throws JsonException
```
    Description copied from interface: JsonHandler
    
    Called when the parsing of a JSON document ended.
    Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).
    
    Specified by:
    
    onDocumentEnd in interface JsonHandler<Document>
    
    Overrides:
    
    onDocumentEnd in class IdleJsonHandler<Document>
    
    Throws:
    
    JsonException - If the handling failed.
  - onArrayBegin
```
public void onArrayBegin()
                  throws JsonException
```
    Description copied from interface: JsonHandler
    
    Called when the parsing of a JSON array started. A corresponding call for the end must eventually be called.
    Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).
    
    Specified by:
    
    onArrayBegin in interface JsonHandler<Document>
    
    Overrides:
    
    onArrayBegin in class IdleJsonHandler<Document>
    
    Throws:
    
    JsonException - If the handling failed.
  - onArrayEnd
```
public void onArrayEnd()
                throws JsonException
```
    Description copied from interface: JsonHandler
    
    Called when the parsing of a JSON array ended.
    Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).
    
    Specified by:
    
    onArrayEnd in interface JsonHandler<Document>
    
    Overrides:
    
    onArrayEnd in class IdleJsonHandler<Document>
    
    Throws:
    
    JsonException - If the handling failed.
  - onObjectBegin
```
public void onObjectBegin()
                   throws JsonException
```
    Description copied from interface: JsonHandler
    
    Called when the parsing of a JSON object started. A corresponding call for the end must eventually be called.
    Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).
    
    Specified by:
    
    onObjectBegin in interface JsonHandler<Document>
    
    Overrides:
    
    onObjectBegin in class IdleJsonHandler<Document>
    
    Throws:
    
    JsonException - If the handling failed.
  - onObjectEnd
```
public void onObjectEnd()
                 throws JsonException
```
    Description copied from interface: JsonHandler
    
    Called when the parsing of a JSON object ended.
    Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).
    
    Specified by:
    
    onObjectEnd in interface JsonHandler<Document>
    
    Overrides:
    
    onObjectEnd in class IdleJsonHandler<Document>
    
    Throws:
    
    JsonException - If the handling failed.
  - onName
```
public void onName(String name)
            throws JsonIndexException,
                   JsonException
```
    Description copied from interface: JsonHandler
    
    Called when the parsing of a JSON object encountered the name for the next JSON value.
    Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).
    
    Specified by:
    
    onName in interface JsonHandler<Document>
    
    Overrides:
    
    onName in class IdleJsonHandler<Document>
    
    Parameters:
    
    name - The name for the next JSON value.
    
    Throws:
    
    JsonIndexException - If the given value is null.
    
    JsonException - If the handling failed.
  - onNext
```
public void onNext()
            throws JsonException
```
    Description copied from interface: JsonHandler
    
    Called when the parsing of a JSON array or JSON object encountered another element.
    Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).
    
    Specified by:
    
    onNext in interface JsonHandler<Document>
    
    Overrides:
    
    onNext in class IdleJsonHandler<Document>
    
    Throws:
    
    JsonException - If the handling failed.
  - onNull
```
public void onNull()
            throws JsonException
```
    Description copied from interface: JsonHandler
    
    Called when the parsing of a JSON object encountered a JSON null.
    Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).
    
    Specified by:
    
    onNull in interface JsonHandler<Document>
    
    Overrides:
    
    onNull in class IdleJsonHandler<Document>
    
    Throws:
    
    JsonException - If the handling failed.
  - onBoolean
```
public void onBoolean(boolean value)
               throws JsonException
```
    Description copied from interface: JsonHandler
    
    Called when the parsing of a JSON object encountered a JSON boolean.
    Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).
    
    Specified by:
    
    onBoolean in interface JsonHandler<Document>
    
    Overrides:
    
    onBoolean in class IdleJsonHandler<Document>
    
    Parameters:
    
    value - The value of the JSON boolean.
    
    Throws:
    
    JsonException - If the handling failed.
  - onLong
```
public void onLong(long value)
            throws JsonException
```
    Description copied from interface: JsonHandler
    
    Called when the parsing of a JSON object encountered a JSON number, that represents an integer value.
    Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).
    
    Specified by:
    
    onLong in interface JsonHandler<Document>
    
    Overrides:
    
    onLong in class IdleJsonHandler<Document>
    
    Parameters:
    
    value - The value of the JSON number.
    
    Throws:
    
    JsonException - If the handling failed.
  - onDouble
```
public void onDouble(double value)
              throws JsonValueException,
                     JsonException
```
    Description copied from interface: JsonHandler
    
    Called when the parsing of a JSON object encountered a JSON number, that represents a decimal value.
    Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).
    
    Specified by:
    
    onDouble in interface JsonHandler<Document>
    
    Overrides:
    
    onDouble in class IdleJsonHandler<Document>
    
    Parameters:
    
    value - The value of the JSON number.
    
    Throws:
    
    JsonValueException - If the given value is not a number or infinite.
    
    JsonException - If the handling failed.
  - onString
```
public void onString(String value)
              throws JsonValueException,
                     JsonException
```
    Description copied from interface: JsonHandler
    
    Called when the parsing of a JSON object encountered a JSON string.
    Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).
    
    Specified by:
    
    onString in interface JsonHandler<Document>
    
    Overrides:
    
    onString in class IdleJsonHandler<Document>
    
    Parameters:
    
    value - The value of the JSON string.
    
    Throws:
    
    JsonValueException - If the given value is null.
    
    JsonException - If the handling failed.
  - getResult
```
public Document getResult()
                   throws JsonException
```
    Description copied from interface: JsonHandler
    
    Returns the calculated result.
    Implementers should catch any exception that isn't a JsonException and wrap them in an appropriate JsonException (e.g. a JsonHandlingException).
    
    Specified by:
    
    getResult in interface JsonHandler<Document>
    
    Overrides:
    
    getResult in class IdleJsonHandler<Document>
    
    Returns:
    
    The calculated result.
    
    Throws:
    
    JsonException - If the handling failed.

Class XmlDocumentJsonHandler

Constructor Summary

Method Summary

Methods inherited from class net.markenwerk.utils.json.handler.IdleJsonHandler

Methods inherited from class java.lang.Object

Constructor Detail

XmlDocumentJsonHandler

XmlDocumentJsonHandler

Method Detail

onDocumentBegin

onDocumentEnd

onArrayBegin

onArrayEnd

onObjectBegin

onObjectEnd

onName

onNext

onNull

onBoolean

onLong

onDouble

onString

getResult