boone.util

Class Xml

java.lang.Object

boone.util.Xml

public class Xml
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Xml()

Method Summary

Modifier and Type	Method and Description
static org.jdom2.Element	addChildTo(org.jdom2.Element parent, java.lang.String name, java.lang.String text) Creates a child element and adds it to parent.
static void	addClassName(org.jdom2.Element element, java.lang.Object o) Sets the unqualified class name of the given object as an attribute to the given element.
static org.jdom2.Element	addStorable(org.jdom2.Element element, java.lang.String name, Storable s) Adds an XML element representing the Storable.
static org.jdom2.Document	buildDocument() Returns an empty JDOM document.
static org.jdom2.Document	buildDocument(java.io.File file) Returns a JDOM document built from a file, or from scratch, if the file does not exist.
static org.jdom2.Document	buildDocument(java.io.InputStream in) Returns a JDOM document built from a possibly compressed (GZIP) input stream.
static org.jdom2.Document	buildDocument(java.lang.String fileName) Returns a JDOM document built from a file name, or from scratch, if a file with the given name does not exist.
static org.jdom2.Element	getChildOf(org.jdom2.Element element, java.lang.String name) Returns the child of an element and creates the child, if it does not exist.
static boolean	getDualProperty(org.jdom2.Element properties, java.lang.String name1, java.lang.String name2, boolean defaultValue) Returns a property which may have two different names.
static double	getDualProperty(org.jdom2.Element properties, java.lang.String name1, java.lang.String name2, double defaultValue) Returns a property which may have two different names.
static int	getDualProperty(org.jdom2.Element properties, java.lang.String name1, java.lang.String name2, int defaultValue) Returns a property which may have two different names.
static long	getDualProperty(org.jdom2.Element properties, java.lang.String name1, java.lang.String name2, long defaultValue) Returns a property which may have two different names.
static java.lang.String	getNodeContent(org.jdom2.Element node, java.lang.String property) Returns the content of either a child or a attribute of node parent
static boolean	getProperty(org.jdom2.Element properties, java.lang.String propertyName, boolean defaultValue) Returns the content of either a child node or an attribute of the XML element.
static double	getProperty(org.jdom2.Element properties, java.lang.String propertyName, double defaultValue) Returns the content of either a child node or an attribute of the XML element.
static float	getProperty(org.jdom2.Element properties, java.lang.String propertyName, float defaultValue) Returns the content of either a child node or an attribute of the XML element.
static int	getProperty(org.jdom2.Element properties, java.lang.String propertyName, int defaultValue) Returns the content of either a child node or an attribute of the XML element.
static long	getProperty(org.jdom2.Element properties, java.lang.String propertyName, long defaultValue) Returns the content of either a child node or an attribute of the XML element.
static java.lang.String	getProperty(org.jdom2.Element properties, java.lang.String propertyName, java.lang.String defaultValue) Returns the content of either a child node or an attribute of the XML element.
static Storable	getStorable(org.jdom2.Element element) Creates a storable from the given element.
static Storable	getStorable(org.jdom2.Element element, java.lang.String name) Creates a storable from the child with given name of the given element.
static boolean	hasAttributeValue(org.jdom2.Element element, java.lang.String name) Checks, if an element has a given attribute.
static void	saveDocument(org.jdom2.Document document, java.io.OutputStream out) Writes a JDOM document to the given output stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Xml

public Xml()

Method Detail

buildDocument

public static org.jdom2.Document buildDocument()

Returns an empty JDOM document.

Returns:

an empty JDOM document

buildDocument

public static org.jdom2.Document buildDocument(java.lang.String fileName)

Returns a JDOM document built from a file name, or from scratch, if a file with the given name does not exist.

Parameters:

fileName - the name of the file

Returns:

a JDOM document (may be empty)

buildDocument

public static org.jdom2.Document buildDocument(java.io.File file)

Returns a JDOM document built from a file, or from scratch, if the file does not exist.

Parameters:

file - a file

Returns:

a JDOM document (may be empty)

buildDocument

public static org.jdom2.Document buildDocument(java.io.InputStream in)

Returns a JDOM document built from a possibly compressed (GZIP) input stream. The document will be empty, if there were problems processing the input.

Parameters:

in - an input stream

Returns:

a JDOM document (may be empty)

addChildTo

public static org.jdom2.Element addChildTo(org.jdom2.Element parent,
                                           java.lang.String name,
                                           java.lang.String text)

Creates a child element and adds it to parent.

Parameters:

parent - the parent element

name - the child's name

text - the child's text

Returns:

the child

getChildOf

public static org.jdom2.Element getChildOf(org.jdom2.Element element,
                                           java.lang.String name)

Returns the child of an element and creates the child, if it does not exist.

Parameters:

element - a JDOM element

name - the child's name

Returns:

the child

getNodeContent

public static java.lang.String getNodeContent(org.jdom2.Element node,
                                              java.lang.String property)

Returns the content of either a child or a attribute of node parent

Parameters:

node - The node

property - specifies the name of the desired property

Returns:

the content of the child or attribute of the node

saveDocument

public static void saveDocument(org.jdom2.Document document,
                                java.io.OutputStream out)
                         throws java.io.IOException

Writes a JDOM document to the given output stream.

Parameters:

document - a JDOM document

out - an output stream

Throws:

java.io.IOException

getProperty

public static java.lang.String getProperty(org.jdom2.Element properties,
                                           java.lang.String propertyName,
                                           java.lang.String defaultValue)

Returns the content of either a child node or an attribute of the XML element.
If the xml element or the child or the attribute is null the specified default value is returned.

Parameters:

properties - XML element

propertyName - the name of the property

defaultValue - default

Returns:

property or default, if undefined

getProperty

public static int getProperty(org.jdom2.Element properties,
                              java.lang.String propertyName,
                              int defaultValue)

Returns the content of either a child node or an attribute of the XML element. If the xml element or the child or the attribute is null or a parse error occurs the specified default value is returned.

Parameters:

properties - XML element

propertyName - the name of the property

defaultValue - default

Returns:

property or default, if undefined

getProperty

public static long getProperty(org.jdom2.Element properties,
                               java.lang.String propertyName,
                               long defaultValue)

Returns the content of either a child node or an attribute of the XML element. If the xml element or the child or the attribute is null or a parse error occurs the specified default value is returned.

Parameters:

properties - XML element

propertyName - the name of the property

defaultValue - default

Returns:

property or default, if undefined

getDualProperty

public static int getDualProperty(org.jdom2.Element properties,
                                  java.lang.String name1,
                                  java.lang.String name2,
                                  int defaultValue)

Returns a property which may have two different names. If both names do not exist, the default value is returned.

Parameters:

properties - XML element

name1 - a name of the property

name2 - another name of the property

defaultValue - default value

Returns:

property or default, if undefined

getDualProperty

public static long getDualProperty(org.jdom2.Element properties,
                                   java.lang.String name1,
                                   java.lang.String name2,
                                   long defaultValue)

Returns a property which may have two different names. If both names do not exist, the default value is returned.

Parameters:

properties - XML element

name1 - a name of the property

name2 - another name of the property

defaultValue - default value

Returns:

property or default, if undefined

getProperty

public static double getProperty(org.jdom2.Element properties,
                                 java.lang.String propertyName,
                                 double defaultValue)

Returns the content of either a child node or an attribute of the XML element. If the XML element or the child or the attribute is null or a parse error occurs the specified default value is returned.

Parameters:

properties - XML element

propertyName - the name of the property

defaultValue - default

Returns:

property or default, if undefined

getDualProperty

public static double getDualProperty(org.jdom2.Element properties,
                                     java.lang.String name1,
                                     java.lang.String name2,
                                     double defaultValue)

Returns a property which may have two different names. If both names do not exist, the default value is returned.

Parameters:

properties - XML element

name1 - a name of the property

name2 - another name of the property

defaultValue - default value

Returns:

property or default, if undefined

getProperty

public static float getProperty(org.jdom2.Element properties,
                                java.lang.String propertyName,
                                float defaultValue)

Returns the content of either a child node or an attribute of the XML element. If the XML element or the child or the attribute is null or a parse error occurs the specified default value is returned.

Parameters:

properties - XML element

propertyName - the name of the property

defaultValue - default

Returns:

property or default, if undefined

getProperty

public static boolean getProperty(org.jdom2.Element properties,
                                  java.lang.String propertyName,
                                  boolean defaultValue)

Returns the content of either a child node or an attribute of the XML element. If the xml element or the child or the attribute is null the specified default value is returned.

Parameters:

properties - XML element

propertyName - the name of the property

defaultValue - default

Returns:

property or default, if undefined

getDualProperty

public static boolean getDualProperty(org.jdom2.Element properties,
                                      java.lang.String name1,
                                      java.lang.String name2,
                                      boolean defaultValue)

Returns a property which may have two different names. If both names do not exist, the default value is returned.

Parameters:

properties - XML element

name1 - a name of the property

name2 - another name of the property

defaultValue - default value

Returns:

property or default, if undefined

hasAttributeValue

public static boolean hasAttributeValue(org.jdom2.Element element,
                                        java.lang.String name)

Checks, if an element has a given attribute.

Parameters:

element - an XML element

name - the attribute name

Returns:

true, if attribute exists

getStorable

public static Storable getStorable(org.jdom2.Element element,
                                   java.lang.String name)

Creates a storable from the child with given name of the given element. Gets the class name form the "class" attribute of the child, converts the possibly unqualified name to a qualified one, and creates a new instance of this class, Then, the attributes of this object are read from XML.

Returns:

an object, null if problems

getStorable

public static Storable getStorable(org.jdom2.Element element)

Creates a storable from the given element. Gets the class name form the "class" attribute of the element, converts the possibly unqualified name to a qualified one, and creates a new instance of this class, Then, the attributes of this object are read from XML.

Returns:

an object, null if problems

addStorable

public static org.jdom2.Element addStorable(org.jdom2.Element element,
                                            java.lang.String name,
                                            Storable s)

Adds an XML element representing the Storable. The attributes of the Storable are not added here.

Parameters:

element - the parent element

name - the name of the child

s - a Storable

Returns:

the child element

addClassName

public static void addClassName(org.jdom2.Element element,
                                java.lang.Object o)

Sets the unqualified class name of the given object as an attribute to the given element.

Parameters:

element - an XML element

o - an object