net.sourceforge.anotherfsm.qfsm

Class XmlUtils

java.lang.Object

net.sourceforge.anotherfsm.qfsm.XmlUtils

 class XmlUtils
extends java.lang.Object

Helper methods for XML/DOM parsing.

Author:

Michal Turek

Constructor Summary

Constructors

Constructor and Description
XmlUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkElementName(org.w3c.dom.Element element, java.lang.String expected) Check the element has the expected name.
static void	ensureNotEmpty(java.lang.String string, java.lang.String objectName) Verify the string is not empty.
static void	ensureNotNull(java.lang.Object object, java.lang.String objectName) Verify the passed object is not null.
static java.lang.String	getAtribute(org.w3c.dom.Element element, java.lang.String name) Get a value of an attribute.
static java.util.List<org.w3c.dom.Element>	getElements(org.w3c.dom.Element element, java.lang.String name) Get all subelements with a concrete name.
static org.w3c.dom.Element	getOneElement(org.w3c.dom.Element element, java.lang.String name) Get one subelement with a concrete name.
static org.w3c.dom.Element	getOneOptionalElement(org.w3c.dom.Element element, java.lang.String name) Get one optional subelement with a concrete name.
static java.lang.String	getOptionalAtribute(org.w3c.dom.Element element, java.lang.String name) Get a value of an optional attribute.
static java.lang.String	getOptionalText(org.w3c.dom.Element element) Get optional text located inside an element.
static java.lang.String	getText(org.w3c.dom.Element element) Get text located inside an element.
static boolean	toBoolean(java.lang.String string) Parse string to a boolean value.
static double	toDouble(java.lang.String string) Parse string to a double value.
static org.w3c.dom.Element	toElement(org.w3c.dom.Node node) Convert a node to an element.
static int	toInt(java.lang.String string) Parse string to an integer value.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlUtils

XmlUtils()

Method Detail

ensureNotNull

public static void ensureNotNull(java.lang.Object object,
                 java.lang.String objectName)
                          throws QfsmException

Verify the passed object is not null.

Parameters:

object - the object

objectName - the object name

Throws:

QfsmException - if the object is null

ensureNotEmpty

public static void ensureNotEmpty(java.lang.String string,
                  java.lang.String objectName)
                           throws QfsmException

Verify the string is not empty.

Parameters:

string - the string

objectName - the string name

Throws:

QfsmException - if the string is empty

checkElementName

public static void checkElementName(org.w3c.dom.Element element,
                    java.lang.String expected)
                             throws QfsmException

Check the element has the expected name.

Parameters:

element - the element

expected - the expected name

Throws:

QfsmException - if the element name differs from the expected one

toElement

public static org.w3c.dom.Element toElement(org.w3c.dom.Node node)
                                     throws QfsmException

Convert a node to an element.

Parameters:

node - the node

Returns:

the element

Throws:

QfsmException - if the node is not element

getOneElement

public static org.w3c.dom.Element getOneElement(org.w3c.dom.Element element,
                                java.lang.String name)
                                         throws QfsmException

Get one subelement with a concrete name.

Parameters:

element - the parent element

name - the subelement name

Returns:

the subelement

Throws:

QfsmException - if the element is not defined or if more than one element of this name is defined

getOneOptionalElement

public static org.w3c.dom.Element getOneOptionalElement(org.w3c.dom.Element element,
                                        java.lang.String name)
                                                 throws QfsmException

Get one optional subelement with a concrete name.

Parameters:

element - the parent element

name - the subelement name

Returns:

the subelement or null if the subelement is not defined

Throws:

QfsmException - if more than one element of this name is defined

getElements

public static java.util.List<org.w3c.dom.Element> getElements(org.w3c.dom.Element element,
                                              java.lang.String name)
                                                       throws QfsmException

Get all subelements with a concrete name.

Parameters:

element - the parent element

name - the subelements name

Returns:

the list of subelements

Throws:

QfsmException - if something fails

getText

public static java.lang.String getText(org.w3c.dom.Element element)
                                throws QfsmException

Get text located inside an element.

Parameters:

element - the parent element

Returns:

the text

Throws:

QfsmException - if the text is empty

getOptionalText

public static java.lang.String getOptionalText(org.w3c.dom.Element element)
                                        throws QfsmException

Get optional text located inside an element.

Parameters:

element - the parent element

Returns:

the text or empty string

Throws:

QfsmException - if something fails

getAtribute

public static java.lang.String getAtribute(org.w3c.dom.Element element,
                           java.lang.String name)
                                    throws QfsmException

Get a value of an attribute.

Parameters:

element - the parent element

name - the attribute name

Returns:

the attribute value

Throws:

QfsmException - if the attribute is not defined

getOptionalAtribute

public static java.lang.String getOptionalAtribute(org.w3c.dom.Element element,
                                   java.lang.String name)
                                            throws QfsmException

Get a value of an optional attribute.

Parameters:

element - the parent element

name - the attribute name

Returns:

the attribute value or empty string if the attribute is not defined

Throws:

QfsmException - if something fails

toInt

public static int toInt(java.lang.String string)
                 throws QfsmException

Parse string to an integer value.

Parameters:

string - the string

Returns:

the integer

Throws:

QfsmException - if the parsing fails

toDouble

public static double toDouble(java.lang.String string)
                       throws QfsmException

Parse string to a double value.

Parameters:

string - the string

Returns:

the double value

Throws:

QfsmException - if the parsing fails

toBoolean

public static boolean toBoolean(java.lang.String string)
                         throws QfsmException

Parse string to a boolean value. The allowed keywords are 0, false, no, 1, true, yes independent to case.

Parameters:

string - the string

Returns:

the boolean value

Throws:

QfsmException - if the parsing fails