XMLUtilities

java.lang.Object
- com.iizix.XMLUtilities

```
public class XMLUtilities
extends Object
```
Helper class containing utility methods used when processing XML documents.

Author:

Christopher Mindus

Field Summary

Fields
Modifier and Type Field and Description

static String XML_FILE_ENCODING
The encoding (UTF-8 or ISO-8859-1).

Fields
Modifier and Type	Field and Description
`static String`	`XML_FILE_ENCODING` The encoding (UTF-8 or ISO-8859-1).

Constructor Summary

Constructors
Constructor and Description

XMLUtilities()

Constructors
Constructor and Description
`XMLUtilities()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Document`	`createDocument()` Creates a new empty Document from the document builder factory.
`static Transformer`	`createLoader(URL schemaURL)` Creates a transformer from an XSL schema used to load multiple XML files to be validated.
`static String`	`getAttributeString(NamedNodeMap namedNodeMap, String name)` Gets an attribute from a node attribute list.
`static String`	`getAttributeString(NamedNodeMap namedNodeMap, String name, String defaultValue)` Gets an attribute from a node attribute list.
`static String`	`getAttributeString(Node node, String name)` Gets an attribute from a node.
`static String`	`getAttributeString(Node node, String name, String defaultValue)` Gets an attribute from a node.
`static Element`	`getFirstElement(Element parent, String name)` Gets the first Element with the specified name.
`static JAXBContext`	`getJAXBContext()` Gets the JAXBContext for the "com.iizix" Core.
`static Marshaller`	`getMarshaller()` Gets the "com.iizix" Core JAXB marshaller.
`static String`	`getNodeString(Node node)` Gets a Node as a String.
`static Unmarshaller`	`getUnmarshaller()` Gets the "com.iizix" Core JAXB unmarshaller.
`static String`	`getXMLDocument(Document document)` Gets a Document as a String.
`static void`	`list(Document doc)` Lists a Document.
`static void`	`list(Node node, int indent)` Lists a Node and it's tree.
`static Object`	`loadObject(Element parent)` Loads a serializable "com.iizix" Core Object into an Element.
`static Document`	`loadXMLDocument(File file)` Loads an XML document from a file into a `Document` without schema validation.
`static Document`	`loadXMLDocument(InputStream in)` Loads an XML document from a file into a `Document` without schema validation.
`static Document`	`loadXMLDocument(String data)` Loads an XML document from a String into a `Document`.
`static Document`	`loadXMLDocument(URL url)` Loads an XML document from a file into a `Document` without schema validation.
`static DocumentBuilder`	`newDocumentBuilderWithoutSchema()` Create a new XML parser without schema, namespace aware for W3C XML Schema 1.0.
`static void`	`saveObject(Element parent, Object obj)` Saves a serializable "com.iizix" Core Object into an Element.
`static void`	`saveXMLDocument(Document document, File file)` Saves a Document to a File.
`static void`	`saveXMLDocument(Document document, OutputStream output)` Saves a Document to an output stream.
`static void`	`saveXMLDocument(Document document, Writer writer)` Saves a Document to a writer.

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

- Field Detail
  - XML_FILE_ENCODING
```
public static final String XML_FILE_ENCODING
```
    The encoding (UTF-8 or ISO-8859-1).
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - XMLUtilities
```
public XMLUtilities()
```
- Method Detail
  - newDocumentBuilderWithoutSchema
```
public static DocumentBuilder newDocumentBuilderWithoutSchema()
```
    Create a new XML parser without schema, namespace aware for W3C XML Schema 1.0. The error handler does not accept warnings or errors and throws the exception.
    
    Returns:
    
    A new Document Builder that can parse XML.
  - createDocument
```
public static Document createDocument()
```
    Creates a new empty Document from the document builder factory.
    
    Returns:
    
    The new Document.
  - createLoader
```
public static Transformer createLoader(URL schemaURL)
                                throws IOException
```
    Creates a transformer from an XSL schema used to load multiple XML files to be validated.
    
    Parameters:
    
    schemaURL - The schema URL for the XSL schema.
    
    Returns:
    
    The XML transformer to use.
    
    Throws:
    
    IOException - For failures in creating the transformer for the URL.
  - loadXMLDocument
```
public static Document loadXMLDocument(String data)
                                throws IOException,
                                       SAXException
```
    Loads an XML document from a String into a Document.
    
    Parameters:
    
    data - The String.
    
    Returns:
    
    the loaded document.
    
    Throws:
    
    IOException - for file errors.
    
    SAXException - a SAX exception when loading/parsing the XML file.
  - loadXMLDocument
```
public static Document loadXMLDocument(File file)
                                throws IOException,
                                       SAXException
```
    Loads an XML document from a file into a Document without schema validation.
    
    Parameters:
    
    file - The file to load.
    
    Returns:
    
    the loaded document.
    
    Throws:
    
    IOException - for file errors.
    
    SAXException - a SAX exception when loading/parsing the XML file.
  - loadXMLDocument
```
public static Document loadXMLDocument(URL url)
                                throws IOException,
                                       SAXException
```
    Loads an XML document from a file into a Document without schema validation.
    
    Parameters:
    
    url - The file to load.
    
    Returns:
    
    the loaded document.
    
    Throws:
    
    IOException - for file errors.
    
    SAXException - a SAX exception when loading/parsing the XML file.
  - loadXMLDocument
```
public static Document loadXMLDocument(InputStream in)
                                throws IOException,
                                       SAXException
```
    Loads an XML document from a file into a Document without schema validation.
    
    Parameters:
    
    in - The input stream.
    
    Returns:
    
    the loaded document.
    
    Throws:
    
    IOException - for file errors.
    
    SAXException - a SAX exception when loading/parsing the XML file.
  - getXMLDocument
```
public static String getXMLDocument(Document document)
                             throws TransformerException
```
    Gets a Document as a String.
    
    Parameters:
    
    document - The document to save.
    
    Returns:
    
    The XML representation of the document.
    
    Throws:
    
    TransformerException - For document errors.
    
    TransformerFactoryConfigurationError - For XML factory errors.
  - getNodeString
```
public static String getNodeString(Node node)
                            throws TransformerException
```
    Gets a Node as a String.
    
    Parameters:
    
    node - The document to save.
    
    Returns:
    
    The XML representation of the node.
    
    Throws:
    
    TransformerException - For document errors.
    
    TransformerFactoryConfigurationError - For XML factory errors.
  - saveXMLDocument
```
public static void saveXMLDocument(Document document,
                                   File file)
                            throws IOException,
                                   TransformerException
```
    Saves a Document to a File.
    
    Parameters:
    
    document - The document to save.
    
    file - The file to use for document saving.
    
    Throws:
    
    IOException - For file errors.
    
    TransformerException - For document errors.
  - saveXMLDocument
```
public static void saveXMLDocument(Document document,
                                   OutputStream output)
                            throws IOException,
                                   TransformerException
```
    Saves a Document to an output stream.
    
    Parameters:
    
    document - The document to save.
    
    output - The output stream.
    
    Throws:
    
    IOException - For file errors.
    
    TransformerException - For document errors.
  - saveXMLDocument
```
public static void saveXMLDocument(Document document,
                                   Writer writer)
                            throws IOException,
                                   TransformerException
```
    Saves a Document to a writer.
    
    Parameters:
    
    document - The document to save.
    
    writer - The writer.
    
    Throws:
    
    IOException - For file errors.
    
    TransformerException - For document errors.
  - list
```
public static void list(Document doc)
```
    Lists a Document.
    
    Parameters:
    
    doc - The document to list.
  - list
```
public static void list(Node node,
                        int indent)
```
    Lists a Node and it's tree.
    
    Parameters:
    
    node - The node to list.
    
    indent - The indent level.
  - getAttributeString
```
public static String getAttributeString(Node node,
                                        String name)
```
    Gets an attribute from a node.
    
    Parameters:
    
    node - the node.
    
    name - name of attribute.
    
    Returns:
    
    the string value of the attribute or null if it's not found.
  - getAttributeString
```
public static String getAttributeString(NamedNodeMap namedNodeMap,
                                        String name)
```
    Gets an attribute from a node attribute list.
    
    Parameters:
    
    namedNodeMap - the node's attributes.
    
    name - name of attribute.
    
    Returns:
    
    the string value of the attribute or null if it's not found.
  - getAttributeString
```
public static String getAttributeString(Node node,
                                        String name,
                                        String defaultValue)
```
    Gets an attribute from a node.
    
    Parameters:
    
    node - the node.
    
    name - name of attribute.
    
    defaultValue - the default value to use if attribute is not found.
    
    Returns:
    
    the string value of the attribute or defaultValue if it's not found.
  - getAttributeString
```
public static String getAttributeString(NamedNodeMap namedNodeMap,
                                        String name,
                                        String defaultValue)
```
    Gets an attribute from a node attribute list.
    
    Parameters:
    
    namedNodeMap - the node's attributes.
    
    name - name of attribute.
    
    defaultValue - the default value to use if attribute is not found.
    
    Returns:
    
    the string value of the attribute or defaultValue if it's not found.
  - getFirstElement
```
public static Element getFirstElement(Element parent,
                                      String name)
```
    Gets the first Element with the specified name.
    
    Parameters:
    
    parent - The parent element.
    
    name - The name.
    
    Returns:
    
    null if not found.
  - getJAXBContext
```
public static JAXBContext getJAXBContext()
                                  throws JAXBException
```
    Gets the JAXBContext for the "com.iizix" Core.
    
    Returns:
    
    The JAXBContext instance.
    
    Throws:
    
    JAXBException - For serialization errors.
  - getMarshaller
```
public static Marshaller getMarshaller()
                                throws JAXBException
```
    Gets the "com.iizix" Core JAXB marshaller.
    
    Returns:
    
    The Marshaller for the global JAXBContext instance.
    
    Throws:
    
    JAXBException - For serialization errors.
  - getUnmarshaller
```
public static Unmarshaller getUnmarshaller()
                                    throws JAXBException
```
    Gets the "com.iizix" Core JAXB unmarshaller.
    
    Returns:
    
    The Unmarshaller for the global JAXBContext instance.
    
    Throws:
    
    JAXBException - For serialization errors.
  - saveObject
```
public static void saveObject(Element parent,
                              Object obj)
                       throws JAXBException
```
    Saves a serializable "com.iizix" Core Object into an Element.
    
    Parameters:
    
    parent - The parent element
    
    obj - The object to save in the parent element.
    
    Throws:
    
    JAXBException - For serialization errors.
  - loadObject
```
public static Object loadObject(Element parent)
                         throws JAXBException
```
    Loads a serializable "com.iizix" Core Object into an Element.
    
    Parameters:
    
    parent - The parent element to retrieve the object from using the unmarshaller.
    
    Returns:
    
    The Object found, or null for none.
    
    Throws:
    
    JAXBException - For serialization errors.

Class XMLUtilities

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

XML_FILE_ENCODING

Constructor Detail

XMLUtilities

Method Detail

newDocumentBuilderWithoutSchema

createDocument

createLoader

loadXMLDocument

loadXMLDocument

loadXMLDocument

loadXMLDocument

getXMLDocument

getNodeString

saveXMLDocument

saveXMLDocument

saveXMLDocument

list

list

getAttributeString

getAttributeString

getAttributeString

getAttributeString

getFirstElement

getJAXBContext

getMarshaller

getUnmarshaller

saveObject

loadObject