er.xiss

Class ERXML

java.lang.Object

er.xiss.ERXML

public class ERXML
extends Object

XML is the container class for all of the XISS XML builder classes and methods.

Author:

mschrag http://github.com/mschrag/xiss

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ERXML.Attr Attr represents a key-value pair attribute of an element.
static class	ERXML.CDATA CDATA represents a CDATA section of your document.
static class	ERXML.Comment Comment represents a Comment section of the document.
static class	ERXML.Content Content is the abstract superclass of all Nodes that have text content.
static class	ERXML.Declaration Declaration represents an XML declaration (the <? ...
static class	ERXML.Doc Doc represents the top level XML Document object, and is typically the first object you will make when building.
static class	ERXML.E E represents an element of the XML document, which can have attributes and children nodes.
static class	ERXML.Item Item is the base class of everything that can appear in an XML document.
static class	ERXML.Node Node is the abstract superclass of all Node items in a Document.
static class	ERXML.Text Text represents a bare text node.
static interface	ERXML.Visitor Visitor is an interface that can be passed to the visit method of any XML.Item to walk the DOM.

Field Summary

Fields

Modifier and Type	Field and Description
static NSTimestamp	versionDate Version ID

Constructor Summary

Constructors

Constructor and Description
ERXML()

Method Summary

Modifier and Type	Method and Description
static ERXML.Attr	a(String name, String value) Creates and returns a new attribute.
static ERXML.CDATA	cdata(String cdata) Creates and returns a new cdata node.
static ERXML.Comment	comment(String comment) Creates and returns a new comment node.
static ERXML.Declaration	declaration(String version, String encoding) Creates and returns a new Declaration.
static ERXML.Doc	doc() Creates and returns a new Document.
static ERXML.Doc	doc(Document w3cDocument) Converts a W3C Document into an XML.Doc.
static ERXML.Doc	doc(ERXML.Item... children) Creates and returns a new Document.
static ERXML.Doc	doc(File file) Creates and return a document parsed from the given file.
static ERXML.Doc	doc(Reader reader) Creates and return a document parsed from the given reader.
static ERXML.Doc	doc(String documentString) Creates and return a document parsed from the given string.
static ERXML.E	e(Element w3cElement) Converts a W3C Element into an XML.E.
static ERXML.E	e(String name) Creates and returns a new Element.
static ERXML.E	e(String name, Object... children) Creates and returns a new Element.
static ERXML.E	e(String name, String text) Creates and returns a new Element.
static ERXML.Text	text(String text) Creates and returns a new text node.

Methods inherited from class java.lang.Object

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

Field Detail

versionDate

public static final NSTimestamp versionDate

Version ID

Constructor Detail

ERXML

public ERXML()

Method Detail

doc

public static ERXML.Doc doc()

Creates and returns a new Document.

Returns:

a new document

doc

public static ERXML.Doc doc(String documentString)

Creates and return a document parsed from the given string.

Parameters:

documentString - the string to parse as XML

Returns:

a new parsed document

doc

public static ERXML.Doc doc(Reader reader)

Creates and return a document parsed from the given reader.

Parameters:

reader - the reader to parse from

Returns:

a new parsed document

doc

public static ERXML.Doc doc(File file)

Creates and return a document parsed from the given file.

Parameters:

file - the file to parse from

Returns:

a new parsed document

e

public static ERXML.E e(Element w3cElement)

Converts a W3C Element into an XML.E.

Parameters:

w3cElement - the W3C Element

Returns:

the equivalent XML.E

doc

public static ERXML.Doc doc(Document w3cDocument)

Converts a W3C Document into an XML.Doc.

Parameters:

w3cDocument - the W3C Document

Returns:

the equivalent XML.Doc

doc

public static ERXML.Doc doc(ERXML.Item... children)

Creates and returns a new Document. The first item that is an element will be set as the root element of the document.

Parameters:

children - the children to add to the document

Returns:

a new element

declaration

public static ERXML.Declaration declaration(String version,
                                            String encoding)

Creates and returns a new Declaration.

Parameters:

version - the version of the declaration

encoding - the encoding of the declaration

Returns:

a new declaration

e

public static ERXML.E e(String name)

Creates and returns a new Element.

Parameters:

name - the name of the element

Returns:

a new element

e

public static ERXML.E e(String name,
                        Object... children)

Creates and returns a new Element.

Parameters:

name - the name of the element

children - the children to add to this element (String, XML.Node, or XML.Attr)

Returns:

a new element

e

public static ERXML.E e(String name,
                        String text)

Creates and returns a new Element.

Parameters:

name - the name of the element

text - the text of the element

Returns:

a new element

a

public static ERXML.Attr a(String name,
                           String value)

Creates and returns a new attribute.

Parameters:

name - the name of the attribute

value - the value of the attribute

Returns:

a new attribute

text

public static ERXML.Text text(String text)

Creates and returns a new text node.

Parameters:

text - the text of the node

Returns:

a new text node

cdata

public static ERXML.CDATA cdata(String cdata)

Creates and returns a new cdata node.

Parameters:

cdata - the text of the cdata node

Returns:

a new cdata node

comment

public static ERXML.Comment comment(String comment)

Creates and returns a new comment node.

Parameters:

comment - the text of the comment node

Returns:

a new comment node