ERXML.E (Project Wonder Reference Documentation)

java.lang.Object
- er.xiss.ERXML.Item
- - er.xiss.ERXML.Node
  - - er.xiss.ERXML.E

Enclosing class:

ERXML
```
public static class ERXML.E
extends ERXML.Node
```
E represents an element of the XML document, which can have attributes and children nodes.

Author:

mschrag

Constructor Summary

Constructors
Constructor and Description

E(String name)
Constructs a new element.

E(String name, String text)
Constructs a new element.

Constructors
Constructor and Description
`E(String name)` Constructs a new element.
`E(String name, String text)` Constructs a new element.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ERXML.E`	`add(ERXML.Attr attribute)` Adds the given attribute to this element.
`<T extends ERXML.Node> T`	`add(T child)` Adds a new node to this element.
`List<ERXML.Attr>`	`attributes()` Returns the attributes for this element.
`ERXML.CDATA`	`cdata(String cdata)` Creates and appends a new CDATA node to this element.
`ERXML.E`	`child(String name)` Returns the child element with the given name from this element, or null if there isn't one.
`boolean`	`childBoolean(String name, boolean defaultValue)` Returns the boolean variant of the child element with the given name from this element, or defaultValue if there isn't one.
`<T extends Enum<T>> T`	`childEnum(String name, Class<T> enumClass, T defaultValue)` Returns the enum variant of the child element with the given name from this element, or defaultValue if there isn't one.
`float`	`childFloat(String name, float defaultValue)` Returns the float variant of the child element with the given name from this element, or defaultValue if there isn't one.
`int`	`childInt(String name, int defaultValue)` Returns the int variant of the child element with the given name from this element, or defaultValue if there isn't one.
`List<ERXML.Node>`	`children()` Returns the children nodes of this element.
`List<ERXML.E>`	`children(String name)` Returns a list of direct children of this element that have the given name, or an empty list if there aren't any.
`String`	`childText(String name)` Returns the text of the child element with the given name from this element, or null if there isn't one.
`ERXML.Comment`	`comment(String comment)` Creates and appends a new comment node to this element.
`Set<ERXML.E>`	`descendents(String name)` Returns a set of descendent elements of this element that have the given name, or an empty list if there aren't any.
`Set<String>`	`descendentsText(String name)` Returns a set of the text of the descendent elements of this element that have the given name, or an empty list if there aren't any.
`ERXML.E`	`e(String name)` Creates and appends a new element to this element.
`ERXML.E`	`e(String name, String value)` Creates and appends a new element to this element.
`String`	`get(String attributeName)` Returns the value of the attribute with the given name, or null if there isn't one.
`ERXML.Attr`	`getAttr(String attributeName)` Returns the attribute with the given name, or null if there isn't one.
`boolean`	`getBoolean(String attributeName, boolean defaultValue)` Returns the boolean variant of the value of the attribute with the given name, or null if there isn't one.
`<T extends Enum<T>> T`	`getEnum(String attributeName, Class<T> enumClass, T defaultValue)` Returns the enum variant of the value of the attribute with the given name, or null if there isn't one.
`float`	`getFloat(String attributeName, float defaultValue)` Returns the float variant of the value of the attribute with the given name, or null if there isn't one.
`int`	`getInt(String attributeName, int defaultValue)` Returns the int variant of the value of the attribute with the given name, or null if there isn't one.
`String`	`name()` Returns the name of this element.
`void`	`remove(ERXML.Attr attribute)` Removes the given attribute from this element.
`void`	`remove(ERXML.Node child)` Removes the given node from this element.
`ERXML.Attr`	`remove(String attributeName)` Removes the attribute with the given name.
`ERXML.E`	`set(String... nvPairs)` Sets a series of attributes in the format "name1","value1", "name2","value2", ...
`ERXML.E`	`set(String name, String value)` Sets the attribute of the given name to the given value.
`void`	`setName(String name)` Sets the name of this element.
`ERXML.E`	`setText(String text)` Sets the text value of this element.
`String`	`text()` Returns the text value of this element, or null if there isn't one.
`ERXML.Text`	`text(String text)` Creates and appends a new text node to this element.
`ERXML.Text`	`textNode()` Returns the text value of this element, or null if there isn't one.
`void`	`visit(ERXML.Visitor visitor)` Visits this item and any of its children (if the visitor allows).
`Node`	`w3c(Document doc)`
`void`	`write(PrintWriter writer, int indent)` Writes this item to the given writer with a certain indentation.
`protected void`	`writeAttributes(PrintWriter writer)` Writes the attributes of this element to the writer.

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
  - E
```
public E(String name)
```
    Constructs a new element.
    
    Parameters:
    
    name - the name of this element
  - E
```
public E(String name,
         String text)
```
    Constructs a new element.
    
    Parameters:
    
    name - the name of this element
    
    text - the initial text of this element
- Method Detail
  - setName
```
public void setName(String name)
```
    Sets the name of this element.
    
    Parameters:
    
    name - the name of this element
  - name
```
public String name()
```
    Returns the name of this element.
    
    Returns:
    
    the name of this element
  - 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
  - set
```
public ERXML.E set(String name,
                   String value)
```
    Sets the attribute of the given name to the given value. If there is already an attribute with this name, it is replaced.
    
    Parameters:
    
    name - the name of the attribute
    
    value - the value of the attribute
    
    Returns:
    
    this element
  - set
```
public ERXML.E set(String... nvPairs)
```
    Sets a series of attributes in the format "name1","value1", "name2","value2", ... If any name already exists, it will be replaced with the value you provide.
    
    Parameters:
    
    nvPairs - an array of name-value pairs
    
    Returns:
    
    this element
  - add
```
public ERXML.E add(ERXML.Attr attribute)
```
    Adds the given attribute to this element. This does not check for duplicates.
    
    Parameters:
    
    attribute - the attribute to add
    
    Returns:
    
    this element
  - getAttr
```
public ERXML.Attr getAttr(String attributeName)
```
    Returns the attribute with the given name, or null if there isn't one.
    
    Parameters:
    
    attributeName - the name of the attribute to look up
    
    Returns:
    
    the attribute with the given name, or null if there isn't one
  - remove
```
public ERXML.Attr remove(String attributeName)
```
    Removes the attribute with the given name.
    
    Parameters:
    
    attributeName - the name of the attribute to remove
    
    Returns:
    
    the removed attribute, or null if there wasn't one
  - remove
```
public void remove(ERXML.Attr attribute)
```
    Removes the given attribute from this element.
    
    Parameters:
    
    attribute - the attribute to remove
  - get
```
public String get(String attributeName)
```
    Returns the value of the attribute with the given name, or null if there isn't one.
    
    Parameters:
    
    attributeName - the name of the attribute to look up
    
    Returns:
    
    the value of the attribute with the given name, or null if there isn't one
  - getInt
```
public int getInt(String attributeName,
                  int defaultValue)
```
    Returns the int variant of the value of the attribute with the given name, or null if there isn't one.
    
    Parameters:
    
    attributeName - the name of the attribute to lookup
    
    defaultValue - the default value to return if there is no attribute, or if the attribute value is null
    
    Returns:
    
    the int variant of the value of the attribute with the given name, or null if there isn't one.
  - getFloat
```
public float getFloat(String attributeName,
                      float defaultValue)
```
    Returns the float variant of the value of the attribute with the given name, or null if there isn't one.
    
    Parameters:
    
    attributeName - the name of the attribute to lookup
    
    defaultValue - the default value to return if there is no attribute, or if the attribute value is null
    
    Returns:
    
    the float variant of the value of the attribute with the given name, or null if there isn't one.
  - getBoolean
```
public boolean getBoolean(String attributeName,
                          boolean defaultValue)
```
    Returns the boolean variant of the value of the attribute with the given name, or null if there isn't one.
    
    Parameters:
    
    attributeName - the name of the attribute to lookup
    
    defaultValue - the default value to return if there is no attribute, or if the attribute value is null
    
    Returns:
    
    the boolean variant of the value of the attribute with the given name, or null if there isn't one.
  - getEnum
```
public <T extends Enum<T>> T getEnum(String attributeName,
                                     Class<T> enumClass,
                                     T defaultValue)
```
    Returns the enum variant of the value of the attribute with the given name, or null if there isn't one.
    
    Parameters:
    
    attributeName - the name of the attribute to lookup
    
    enumClass - the class of the enum to return
    
    defaultValue - the default value to return if there is no attribute, or if the attribute value is null
    
    Returns:
    
    the enum variant of the value of the attribute with the given name, or null if there isn't one.
  - attributes
```
public List<ERXML.Attr> attributes()
```
    Returns the attributes for this element.
    
    Returns:
    
    the attributes for this element
  - setText
```
public ERXML.E setText(String text)
```
    Sets the text value of this element. This will replace an existing Text child with the provided string, or create a new one if one doesn't exist. If there is already a child in this element that is not a Text node, this will throw an exception.
    
    Parameters:
    
    text - the new text value for this node
    
    Returns:
    
    this element
  - textNode
```
public ERXML.Text textNode()
```
    Returns the text value of this element, or null if there isn't one. If there is a non-text child of this element, this will throw an exception.
    
    Returns:
    
    the text value of this element
  - text
```
public String text()
```
    Returns the text value of this element, or null if there isn't one. If there is a non-text child of this element, this will throw an exception.
    
    Returns:
    
    the text value of this element
  - children
```
public List<ERXML.Node> children()
```
    Returns the children nodes of this element.
    
    Returns:
    
    the children nodes of this element
  - childText
```
public String childText(String name)
```
    Returns the text of the child element with the given name from this element, or null if there isn't one.
    
    Parameters:
    
    name - the name of the element to look up
    
    Returns:
    
    the text of the child element with the given name from this element, or null if there isn't one
  - childInt
```
public int childInt(String name,
                    int defaultValue)
```
    Returns the int variant of the child element with the given name from this element, or defaultValue if there isn't one.
    
    Parameters:
    
    name - the name of the element to look up
    
    defaultValue - the default value to return if there is no child node, or if the child node is empty
    
    Returns:
    
    the int variant of the child element with the given name from this element, or defaultValue if there isn't one.
  - childFloat
```
public float childFloat(String name,
                        float defaultValue)
```
    Returns the float variant of the child element with the given name from this element, or defaultValue if there isn't one.
    
    Parameters:
    
    name - the name of the element to look up
    
    defaultValue - the default value to return if there is no child node, or if the child node is empty
    
    Returns:
    
    the float variant of the child element with the given name from this element, or defaultValue if there isn't one.
  - childBoolean
```
public boolean childBoolean(String name,
                            boolean defaultValue)
```
    Returns the boolean variant of the child element with the given name from this element, or defaultValue if there isn't one.
    
    Parameters:
    
    name - the name of the element to look up
    
    defaultValue - the default value to return if there is no child node, or if the child node is empty
    
    Returns:
    
    the boolean variant of the child element with the given name from this element, or defaultValue if there isn't one.
  - childEnum
```
public <T extends Enum<T>> T childEnum(String name,
                                       Class<T> enumClass,
                                       T defaultValue)
```
    Returns the enum variant of the child element with the given name from this element, or defaultValue if there isn't one.
    
    Parameters:
    
    name - the name of the element to look up
    
    enumClass - the class of the enum to return
    
    defaultValue - the default value to return if there is no child node, or if the child node is empty
    
    Returns:
    
    the enum variant of the child element with the given name from this element, or defaultValue if there isn't one.
  - child
```
public ERXML.E child(String name)
```
    Returns the child element with the given name from this element, or null if there isn't one.
    
    Parameters:
    
    name - the name of the element to look up
    
    Returns:
    
    the child element with the given name from this element, or null if there isn't one
  - children
```
public List<ERXML.E> children(String name)
```
    Returns a list of direct children of this element that have the given name, or an empty list if there aren't any.
    
    Parameters:
    
    name - the name of the children elements to look up
    
    Returns:
    
    a list of direct children of this element that have the given name, or an empty list if there aren't any
  - descendentsText
```
public Set<String> descendentsText(String name)
```
    Returns a set of the text of the descendent elements of this element that have the given name, or an empty list if there aren't any.
    
    Parameters:
    
    name - the name of the descendent elements to look up
    
    Returns:
    
    a set of the text of the descendents of this element that have the given name, or an empty set if there aren't any
  - descendents
```
public Set<ERXML.E> descendents(String name)
```
    Returns a set of descendent elements of this element that have the given name, or an empty list if there aren't any.
    
    Parameters:
    
    name - the name of the descendent elements to look up
    
    Returns:
    
    a set of descendents of this element that have the given name, or an empty set if there aren't any
  - e
```
public ERXML.E e(String name)
```
    Creates and appends a new element to this element.
    
    Parameters:
    
    name - the name of the new element
    
    Returns:
    
    the new element
  - e
```
public ERXML.E e(String name,
                 String value)
```
    Creates and appends a new element to this element.
    
    Parameters:
    
    name - the name of the new element
    
    value - the text value of the new element
    
    Returns:
    
    the new element
  - text
```
public ERXML.Text text(String text)
```
    Creates and appends a new text node to this element.
    
    Parameters:
    
    text - the text value to append
    
    Returns:
    
    the new text node
  - cdata
```
public ERXML.CDATA cdata(String cdata)
```
    Creates and appends a new CDATA node to this element.
    
    Parameters:
    
    cdata - the cdata value to append
    
    Returns:
    
    the new cdata node
  - comment
```
public ERXML.Comment comment(String comment)
```
    Creates and appends a new comment node to this element.
    
    Parameters:
    
    comment - the comment value to append
    
    Returns:
    
    the new comment node
  - remove
```
public void remove(ERXML.Node child)
```
    Removes the given node from this element.
    
    Parameters:
    
    child - the child node to remove
  - add
```
public <T extends ERXML.Node> T add(T child)
```
    Adds a new node to this element.
    
    Type Parameters:
    
    T - the type of the node to add
    
    Parameters:
    
    child - the child to add
    
    Returns:
    
    the added child
  - writeAttributes
```
protected void writeAttributes(PrintWriter writer)
```
    Writes the attributes of this element to the writer.
    
    Parameters:
    
    writer - the writer to write attributes to
  - 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
  - w3c
```
public Node w3c(Document doc)
```
    Specified by:
    
    w3c in class ERXML.Node

Class ERXML.E

Constructor Summary

Method Summary

Methods inherited from class er.xiss.ERXML.Item

Methods inherited from class java.lang.Object

Constructor Detail

E

E

Method Detail

setName

name

visit

set

set

add

getAttr

remove

remove

get

getInt

getFloat

getBoolean

getEnum

attributes

setText

textNode

text

children

childText

childInt

childFloat

childBoolean

childEnum

child

children

descendentsText

descendents

e

e

text

cdata

comment

remove

add

writeAttributes

write

w3c