er.xiss

Class ERXML.Doc

java.lang.Object

er.xiss.ERXML.Item

er.xiss.ERXML.Doc

Enclosing class:

ERXML

public static class ERXML.Doc
extends ERXML.Item

Doc represents the top level XML Document object, and is typically the first object you will make when building.

 XML.Doc doc = XML.doc();
 XML.E person = doc.root("person");
 

Author:

mschrag

Constructor Summary

Constructors

Constructor and Description
Doc() Constructs a new Document.

Method Summary

Modifier and Type	Method and Description
protected void	_add(ERXML.Item child) Adds a new child to this document.
<T extends ERXML.Item> T	add(T child) Adds a new child to this document.
protected void	checkNullRoot() Checks if there is already a root element and throws if there is.
List<ERXML.Item>	children() Returns the children of this document.
ERXML.Doc	comment(String comment) Creates and returns a new comment for this document.
ERXML.Declaration	declaration() Returns the declaration for this document, or null if there isn't one.
void	remove(ERXML.Item child) Removes the given child from this document.
ERXML.E	root() Returns the root element (or null if there isn't one).
ERXML.E	root(String name) Creates a new root element with the given name and returns it.
ERXML.E	root(String name, String value) Creates a new root element with the given name and initial text contents and returns it.
void	setDeclaration(ERXML.Declaration declaration) Sets the declaration for this document.
void	setRoot(ERXML.E root) Sets the root element of this document.
void	visit(ERXML.Visitor visitor) Visits this item and any of its children (if the visitor allows).
Document	w3c()
void	write(PrintWriter writer, int indent) Writes this item to the given writer with a certain indentation.

Methods inherited from class er.xiss.ERXML.Item

doc, parent, setParent, toString, writeEscapedString, writeIndent

Methods inherited from class java.lang.Object

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

Constructor Detail

Doc

public Doc()

Constructs a new Document.

Method Detail

checkNullRoot

protected void checkNullRoot()

Checks if there is already a root element and throws if there is.

declaration

public ERXML.Declaration declaration()

Returns the declaration for this document, or null if there isn't one. Every Document gets a version="1.0" encoding="UTF-8" declaration by default, so you should call setDeclaration(null) if you want to remove this default.

Returns:

the declaration for this document

setDeclaration

public void setDeclaration(ERXML.Declaration declaration)

Sets the declaration for this document.

Parameters:

declaration - the declaration for this document

root

public ERXML.E root(String name)

Creates a new root element with the given name and returns it. If there is already a root element, this will throw an exception.

Parameters:

name - the name of the new root element

Returns:

the new root element

root

public ERXML.E root(String name,
                    String value)

Creates a new root element with the given name and initial text contents and returns it. If there is already a root element, this will throw an exception.

Parameters:

name - the name of the new root element

value - the initial text value of this element

Returns:

the new root element

root

public ERXML.E root()

Returns the root element (or null if there isn't one). Documents do not start out with a root element, so this might be null.

Returns:

the root element

setRoot

public void setRoot(ERXML.E root)

Sets the root element of this document.

Parameters:

root - the new root element

comment

public ERXML.Doc comment(String comment)

Creates and returns a new comment for this document. If you want comments above the root element, you should call doc.comment(..) prior to calling .root(..).

Parameters:

comment - a new comment for this document

Returns:

this document

remove

public void remove(ERXML.Item child)

Removes the given child from this document.

Parameters:

child - the child to remove

_add

protected void _add(ERXML.Item child)

Adds a new child to this document.

Parameters:

child - the child to add

add

public <T extends ERXML.Item> T add(T child)

Adds a new child to this document. No validation is performed of these items.

Type Parameters:

T - the type of the item

Parameters:

child - the child to add

Returns:

the newly added item

children

public List<ERXML.Item> children()

Returns the children of this document.

Returns:

the children of this document

write

public void write(PrintWriter writer,
                  int indent)

Description copied from class: ERXML.Item

Writes this item to the given writer with a certain indentation. All items are pretty printed.

Specified by:

write in class ERXML.Item

Parameters:

writer - the writer to write to

indent - the current indentation

visit

public void visit(ERXML.Visitor visitor)

Description copied from class: ERXML.Item

Visits this item and any of its children (if the visitor allows).

Specified by:

visit in class ERXML.Item

Parameters:

visitor - the visitor to visit with

w3c

public Document w3c()