Package cdc.util.data

Class Element

java.lang.Object

cdc.util.data.AbstractChild

cdc.util.data.Element

All Implemented Interfaces:

Child, Node, Parent

public final class Element
extends AbstractChild
implements Parent

Field Summary

Fields inherited from interface cdc.util.data.Node

ANY_NODE, IS_COMMENT, IS_ELEMENT, IS_EMPTY_ELEMENT, IS_IGNORABLE_TEXT, IS_TEXT

Constructor Summary

Constructors

Constructor	Description
Element(Element other)
Element(Parent parent, java.lang.String name)
Element(java.lang.String name)

Method Summary

Modifier and Type	Method	Description
void	addAttribute(Attribute attribute)	Adds an attribute.
void	addAttribute(java.lang.String name, boolean value)	Adds a boolean attribute.
void	addAttribute(java.lang.String name, byte value)	Adds a byte attribute.
void	addAttribute(java.lang.String name, double value)	Adds a double attribute.
void	addAttribute(java.lang.String name, float value)	Adds a float attribute.
void	addAttribute(java.lang.String name, int value)	Adds an int attribute.
void	addAttribute(java.lang.String name, long value)	Adds a long attribute.
void	addAttribute(java.lang.String name, short value)	Adds a short attribute.
void	addAttribute(java.lang.String name, java.lang.Object value)	Adds an object attribute.
void	addAttribute(java.lang.String name, java.lang.String value)	Adds a string attribute.
boolean	addChild(Child child)	Add a child to this parent, if possible.
Comment	addComment(java.lang.String content, boolean merge)
Text	addText(java.lang.String content, boolean merge)
boolean	canAddChild(Child child)	Returns true when a child can be added.
void	clearChildren()	Removes all children.
Element	clone(boolean recurse)	Return a clone of this node.
boolean	deepEquals(Node node)	Return true when this node and its descendants equals other node hierarchy.
void	ensureChildren()
Attribute	getAttribute(int index)	Returns the index-th attribute.
Attribute	getAttribute(java.lang.String name)	Returns the attribute that has a particular name.
boolean	getAttributeAsBoolean(java.lang.String name, boolean def)	Returns the value associated to an attribute as a boolean.
byte	getAttributeAsByte(java.lang.String name, byte def)	Returns the value associated to an attribute as a byte.
double	getAttributeAsDouble(java.lang.String name, double def)	Returns the value associated to an attribute as a double.
<E extends java.lang.Enum<E>> E	getAttributeAsEnum(java.lang.String name, java.lang.Class<E> enumClass, E def)	Returns the value associated to an attribute as an enum.
float	getAttributeAsFloat(java.lang.String name, float def)	Returns the value associated to an attribute as a float.
int	getAttributeAsInt(java.lang.String name, int def)	Returns the value associated to an attribute as an int.
long	getAttributeAsLong(java.lang.String name, long def)	Returns the value associated to an attribute as a long.
java.lang.Boolean	getAttributeAsOptionalBoolean(java.lang.String name, java.lang.Boolean def)
java.lang.Byte	getAttributeAsOptionalByte(java.lang.String name, java.lang.Byte def)
java.lang.Double	getAttributeAsOptionalDouble(java.lang.String name, java.lang.Double def)
<E extends java.lang.Enum<E>> E	getAttributeAsOptionalEnum(java.lang.String name, java.lang.Class<E> enumClass, E def)
java.lang.Float	getAttributeAsOptionalFloat(java.lang.String name, java.lang.Float def)
java.lang.Integer	getAttributeAsOptionalInt(java.lang.String name, java.lang.Integer def)
java.lang.Long	getAttributeAsOptionalLong(java.lang.String name, java.lang.Long def)
java.lang.Enum<?>	getAttributeAsOptionalRawEnum(java.lang.String name, java.lang.Class<? extends java.lang.Enum<?>> enumClass, java.lang.Enum<?> def)
java.lang.Short	getAttributeAsOptionalShort(java.lang.String name, java.lang.Short def)
java.lang.Enum<?>	getAttributeAsRawEnum(java.lang.String name, java.lang.Class<? extends java.lang.Enum<?>> enumClass, java.lang.Enum<?> def)
short	getAttributeAsShort(java.lang.String name, short def)	Returns the value associated to an attribute as a short.
int	getAttributeIndex(java.lang.String name)	Returns the index of the attribute that has a particular name.
java.util.List<Attribute>	getAttributes()
int	getAttributesCount()
java.lang.String	getAttributeValue(java.lang.String name, java.lang.String def)	Returns the value associated to an attribute as a string.
java.util.List<AbstractChild>	getChildren()
ElementContentType	getContentType()
java.lang.String	getName()
Element	getNthChildNamed(java.lang.String name, int index)
java.util.List<Attribute>	getSortedAttributes()
java.lang.String	getText(java.lang.String def)
boolean	getTextAsBoolean(boolean def)
byte	getTextAsByte(byte def)
double	getTextAsDouble(double def)
<E extends java.lang.Enum<E>> E	getTextAsEnum(java.lang.Class<E> enumClass, E def)
float	getTextAsFloat(float def)
int	getTextAsInt(int def)
long	getTextAsLong(long def)
short	getTextAsShort(short def)
NodeType	getType()
boolean	hasAttribute(java.lang.String name)	Returns true when an attribute with a particular name exists.
Attribute	removeAttribute(java.lang.String name)	Removes an attribute identified by its name.
boolean	removeChild(Child child)	Remove a child.
AbstractChild	removeChildAt(int index)	Remove the child located at a given index.
void	setName(java.lang.String name)
boolean	supportsChildType(NodeType type)	Returns true when this node supports a child of a given type.
java.lang.String	toString()

Methods inherited from class cdc.util.data.AbstractChild

getDocument, getParent, getRootChild, getRootElement, resetParent, setParent

Methods inherited from interface cdc.util.data.Node

getDocument, getRootElement

Methods inherited from class java.lang.Object

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

Methods inherited from interface cdc.util.data.Parent

getChildAt, getChildren, getChildren, getChildrenCount, getChildrenCount, getLastChild, hasChildren

Constructor Detail

Element

public Element(java.lang.String name)

Element

public Element(Parent parent,
               java.lang.String name)

Element

public Element(Element other)

Method Detail

getType

public NodeType getType()

Specified by:

getType in interface Node

Returns:

The node type.

clone

public Element clone(boolean recurse)

Description copied from interface: Node

Return a clone of this node.

Specified by:

clone in interface Child

Specified by:

clone in interface Node

Specified by:

clone in interface Parent

Specified by:

clone in class AbstractChild

Parameters:

recurse - If true, also clone children nodes.

Returns:

A clone of this node, and optionally its children.

deepEquals

public boolean deepEquals(Node node)

Description copied from interface: Node

Return true when this node and its descendants equals other node hierarchy.

Parents are ignored.

Specified by:

deepEquals in interface Node

Parameters:

node - The other node to compare.

Returns:

True when this node and other node have same hierarchies.

canAddChild

public boolean canAddChild(Child child)

Description copied from interface: Parent

Returns true when a child can be added.

Specified by:

canAddChild in interface Parent

Parameters:

child - The child

Returns:

True when child an be added.

supportsChildType

public boolean supportsChildType(NodeType type)

Description copied from interface: Parent

Returns true when this node supports a child of a given type.

Specified by:

supportsChildType in interface Parent

Parameters:

type - The type.

Returns:

true when type is supported for a child.

ensureChildren

public void ensureChildren()

Specified by:

ensureChildren in interface Parent

getChildren

public java.util.List<AbstractChild> getChildren()

Specified by:

getChildren in interface Parent

Returns:

A list of children.

addChild

public boolean addChild(Child child)

Description copied from interface: Parent

Add a child to this parent, if possible.

If possible, child current parent is changed to this node.

Specified by:

addChild in interface Parent

Parameters:

child - The child.

Returns:

True when the child was added, false otherwise.

removeChild

public boolean removeChild(Child child)

Description copied from interface: Parent

Remove a child.

If child is not a child of this parent, then false is returned.

Specified by:

removeChild in interface Parent

Parameters:

child - The child.

Returns:

true if child was removed, false otherwise.

removeChildAt

public AbstractChild removeChildAt(int index)

Description copied from interface: Parent

Remove the child located at a given index.

If index is invalid, returns false.

Specified by:

removeChildAt in interface Parent

Parameters:

index - The index.

Returns:

true when removal was a success, false otherwise.

clearChildren

public void clearChildren()

Description copied from interface: Parent

Removes all children.

Specified by:

clearChildren in interface Parent

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

getContentType

public ElementContentType getContentType()

getAttributes

public java.util.List<Attribute> getAttributes()

Returns:

A list of attributes.

getSortedAttributes

public java.util.List<Attribute> getSortedAttributes()

Returns:

A list of attributes sorted by names.

getAttributesCount

public int getAttributesCount()

Returns:

The number of attributes.

getAttribute

public Attribute getAttribute(int index)

Returns the index-th attribute.

Parameters:

index - The index.

Returns:

The index-th attribute.

hasAttribute

public boolean hasAttribute(java.lang.String name)

Returns true when an attribute with a particular name exists.

Parameters:

name - The name.

Returns:

True when an attribute named name exists.

getAttribute

public Attribute getAttribute(java.lang.String name)

Returns the attribute that has a particular name.

Parameters:

name - The name.

Returns:

The attribute named name or null.

getAttributeIndex

public int getAttributeIndex(java.lang.String name)

Returns the index of the attribute that has a particular name.

Parameters:

name - The name.

Returns:

The index of attribute named name or -1.

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String name,
                                          java.lang.String def)

Returns the value associated to an attribute as a string.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists.

Returns:

The value of attribute named name or def.

getAttributeAsBoolean

public boolean getAttributeAsBoolean(java.lang.String name,
                                     boolean def)

Returns the value associated to an attribute as a boolean.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists or if its value can not be converted to a boolean.

Returns:

The value of attribute named name or def.

getAttributeAsOptionalBoolean

public java.lang.Boolean getAttributeAsOptionalBoolean(java.lang.String name,
                                                       java.lang.Boolean def)

getAttributeAsLong

public long getAttributeAsLong(java.lang.String name,
                               long def)

Returns the value associated to an attribute as a long.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists or if its value can not be converted to a long.

Returns:

The value of attribute named name or def.

getAttributeAsOptionalLong

public java.lang.Long getAttributeAsOptionalLong(java.lang.String name,
                                                 java.lang.Long def)

getAttributeAsInt

public int getAttributeAsInt(java.lang.String name,
                             int def)

Returns the value associated to an attribute as an int.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists or if its value can not be converted to an int.

Returns:

The value of attribute named name or def.

getAttributeAsOptionalInt

public java.lang.Integer getAttributeAsOptionalInt(java.lang.String name,
                                                   java.lang.Integer def)

getAttributeAsShort

public short getAttributeAsShort(java.lang.String name,
                                 short def)

Returns the value associated to an attribute as a short.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists or if its value can not be converted to a short.

Returns:

The value of attribute named name or def.

getAttributeAsOptionalShort

public java.lang.Short getAttributeAsOptionalShort(java.lang.String name,
                                                   java.lang.Short def)

getAttributeAsByte

public byte getAttributeAsByte(java.lang.String name,
                               byte def)

Returns the value associated to an attribute as a byte.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists or if its value can not be converted to a byte.

Returns:

The value of attribute named name or def.

getAttributeAsOptionalByte

public java.lang.Byte getAttributeAsOptionalByte(java.lang.String name,
                                                 java.lang.Byte def)

getAttributeAsDouble

public double getAttributeAsDouble(java.lang.String name,
                                   double def)

Returns the value associated to an attribute as a double.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists or if its value can not be converted to a double.

Returns:

The value of attribute named name or def.

getAttributeAsOptionalDouble

public java.lang.Double getAttributeAsOptionalDouble(java.lang.String name,
                                                     java.lang.Double def)

getAttributeAsFloat

public float getAttributeAsFloat(java.lang.String name,
                                 float def)

Returns the value associated to an attribute as a float.

Parameters:

name - The attribute name.

def - The value to return if no attribute named name exists or if its value can not be converted to a float.

Returns:

The value of attribute named name or def.

getAttributeAsOptionalFloat

public java.lang.Float getAttributeAsOptionalFloat(java.lang.String name,
                                                   java.lang.Float def)

getAttributeAsRawEnum

public java.lang.Enum<?> getAttributeAsRawEnum(java.lang.String name,
                                               java.lang.Class<? extends java.lang.Enum<?>> enumClass,
                                               java.lang.Enum<?> def)

getAttributeAsOptionalRawEnum

public java.lang.Enum<?> getAttributeAsOptionalRawEnum(java.lang.String name,
                                                       java.lang.Class<? extends java.lang.Enum<?>> enumClass,
                                                       java.lang.Enum<?> def)

getAttributeAsEnum

public <E extends java.lang.Enum<E>> E getAttributeAsEnum(java.lang.String name,
                                                          java.lang.Class<E> enumClass,
                                                          E def)

Returns the value associated to an attribute as an enum.

Type Parameters:

E - The enum type.

Parameters:

name - The attribute name.

enumClass - The enum class.

def - The value to return if no attribute named name exists or if its value can not be converted to an enum.

Returns:

The value of attribute named name or def.

getAttributeAsOptionalEnum

public <E extends java.lang.Enum<E>> E getAttributeAsOptionalEnum(java.lang.String name,
                                                                  java.lang.Class<E> enumClass,
                                                                  E def)

addAttribute

public void addAttribute(Attribute attribute)

Adds an attribute.

Parameters:

attribute - The attribute.

Throws:

java.lang.IllegalArgumentException - When attribute is null or another attribute with same name already exists.

addAttribute

public void addAttribute(java.lang.String name,
                         java.lang.Object value)

Adds an object attribute.

The string value is constructed using value.toString().

Parameters:

name - The attribute name.

value - The attribute value.

Throws:

java.lang.IllegalArgumentException - When name is null or another attribute with same name already exists.

addAttribute

public void addAttribute(java.lang.String name,
                         java.lang.String value)

Adds a string attribute.

Parameters:

name - The attribute name.

value - The attribute value.

Throws:

java.lang.IllegalArgumentException - When name is null or another attribute with same name already exists.

addAttribute

public void addAttribute(java.lang.String name,
                         boolean value)

Adds a boolean attribute.

Parameters:

name - The attribute name.

value - The attribute value.

Throws:

java.lang.IllegalArgumentException - When name is null or another attribute with same name already exists.

addAttribute

public void addAttribute(java.lang.String name,
                         long value)

Adds a long attribute.

Parameters:

name - The attribute name.

value - The attribute value.

Throws:

java.lang.IllegalArgumentException - When name is null or another attribute with same name already exists.

addAttribute

public void addAttribute(java.lang.String name,
                         int value)

Adds an int attribute.

Parameters:

name - The attribute name.

value - The attribute value.

Throws:

java.lang.IllegalArgumentException - When name is null or another attribute with same name already exists.

addAttribute

public void addAttribute(java.lang.String name,
                         short value)

Adds a short attribute.

Parameters:

name - The attribute name.

value - The attribute value.

Throws:

java.lang.IllegalArgumentException - When name is null or another attribute with same name already exists.

addAttribute

public void addAttribute(java.lang.String name,
                         byte value)

Adds a byte attribute.

Parameters:

name - The attribute name.

value - The attribute value.

Throws:

java.lang.IllegalArgumentException - When name is null or another attribute with same name already exists.

addAttribute

public void addAttribute(java.lang.String name,
                         double value)

Adds a double attribute.

Parameters:

name - The attribute name.

value - The attribute value.

Throws:

java.lang.IllegalArgumentException - When name is null or another attribute with same name already exists.

addAttribute

public void addAttribute(java.lang.String name,
                         float value)

Adds a float attribute.

Parameters:

name - The attribute name.

value - The attribute value.

Throws:

java.lang.IllegalArgumentException - When name is null or another attribute with same name already exists.

removeAttribute

public Attribute removeAttribute(java.lang.String name)

Removes an attribute identified by its name.

Parameters:

name - The name of the attribute to remove.

Returns:

The removed attribute or null.

getNthChildNamed

public Element getNthChildNamed(java.lang.String name,
                                int index)

addComment

public Comment addComment(java.lang.String content,
                          boolean merge)

addText

public Text addText(java.lang.String content,
                    boolean merge)

getText

public java.lang.String getText(java.lang.String def)

getTextAsBoolean

public boolean getTextAsBoolean(boolean def)

getTextAsLong

public long getTextAsLong(long def)

getTextAsInt

public int getTextAsInt(int def)

getTextAsShort

public short getTextAsShort(short def)

getTextAsByte

public byte getTextAsByte(byte def)

getTextAsDouble

public double getTextAsDouble(double def)

getTextAsFloat

public float getTextAsFloat(float def)

getTextAsEnum

public <E extends java.lang.Enum<E>> E getTextAsEnum(java.lang.Class<E> enumClass,
                                                     E def)

toString

public java.lang.String toString()

Overrides:

toString in class AbstractChild