org.mdiutil.xml.tree

Class XMLNode

java.lang.Object

org.mdiutil.xml.tree.XMLNode

All Implemented Interfaces:

Iterable<XMLNode>, CommentedNode, NumberedNode

Direct Known Subclasses:

XMLCommentedNode, XMLInvalidNode, XMLNumberedNode, XMLRoot

public class XMLNode
extends Object
implements Iterable<XMLNode>, CommentedNode, NumberedNode

A Node in an XML File.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XMLNode.BoundPrefix A prefix bounded to an URI.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<SortableQName,String>	attributes The attributes.
protected Map<String,String>	boundPrefixes The bounded prefixes.
protected String	cData The CDATA content.
protected List<XMLNode>	children The children nodes.
protected XMLNode	nodeParent The node parent.
protected QName	qname The node name.

Constructor Summary

Constructors

Constructor and Description
XMLNode(QName qname) Create the Node.
XMLNode(String nodeName) Create the Node, with a local part.
XMLNode(XMLNode parent, QName qname) Create a Node.
XMLNode(XMLNode parent, String nodeName) Create a Node.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(QName qname, boolean value) Add an attribute for this Node.
void	addAttribute(QName qname, byte value) Add an attribute for this Node.
void	addAttribute(QName qname, char value) Add an attribute for this Node.
void	addAttribute(QName qname, double value) Add an attribute for this Node.
void	addAttribute(QName qname, float value) Add an attribute for this Node.
void	addAttribute(QName qname, int value) Add an attribute for this Node.
void	addAttribute(QName qname, long value) Add an attribute for this Node.
void	addAttribute(QName qname, short value) Add an attribute for this Node.
void	addAttribute(QName qname, String value) Add an attribute for this Node.
void	addAttribute(String attrName, boolean value) Add an attribute for this Node.
void	addAttribute(String attrName, byte value) Add an attribute for this Node.
void	addAttribute(String attrName, char value) Add an attribute for this Node.
void	addAttribute(String attrName, double value) Add an attribute for this Node.
void	addAttribute(String attrName, float value) Add an attribute for this Node.
void	addAttribute(String attrName, int value) Add an attribute for this Node.
void	addAttribute(String attrName, long value) Add an attribute for this Node.
void	addAttribute(String attrName, short value) Add an attribute for this Node.
void	addAttribute(String attrName, String value) Add an attribute for this Node.
void	addChild(XMLNode child) Add a child to this Node.
boolean	attributeValueIsBoolean(QName qname) Return true if an attribute of a specified name can be parsed as a boolean.
boolean	attributeValueIsBoolean(String attrName) Return true if an attribute of a specified name can be parsed as a boolean.
boolean	attributeValueIsByte(QName qname) Return true if an attribute of a specified name can be parsed as a byte.
boolean	attributeValueIsByte(String attrName) Return true if an attribute of a specified name can be parsed as a byte.
boolean	attributeValueIsChar(QName qname) Return true if an attribute of a specified name can be parsed as a char.
boolean	attributeValueIsChar(String attrName) Return true if an attribute of a specified name can be parsed as a char.
boolean	attributeValueIsDouble(QName qname) Return true if an attribute of a specified name can be parsed as a double.
boolean	attributeValueIsDouble(String attrName) Return true if an attribute of a specified name can be parsed as a double.
boolean	attributeValueIsFloat(QName qname) Return true if an attribute of a specified name can be parsed as a float.
boolean	attributeValueIsFloat(String attrName) Return true if an attribute of a specified name can be parsed as a float.
boolean	attributeValueIsInt(QName qname, boolean strict) Return true if an attribute of a specified name can be parsed as an int.
boolean	attributeValueIsInt(String attrName) Return true if an attribute of a specified name can be parsed as an int.
boolean	attributeValueIsInt(String attrName, boolean strict) Return true if an attribute of a specified name can be parsed as an int.
boolean	attributeValueIsLong(QName qname) Return true if an attribute of a specified name can be parsed as a long.
boolean	attributeValueIsLong(QName qname, boolean strict) Return true if an attribute of a specified name can be parsed as a long.
boolean	attributeValueIsLong(String attrName) Return true if an attribute of a specified name can be parsed as a long.
boolean	attributeValueIsLong(String attrName, boolean strict) Return true if an attribute of a specified name can be parsed as a long.
boolean	attributeValueIsShort(QName qname) Return true if an attribute of a specified name can be parsed as a short.
boolean	attributeValueIsShort(String attrName) Return true if an attribute of a specified name can be parsed as a short.
void	bindPrefix(String prefix, String uri) Bind a prefix to an URI.
boolean	CDATAValueIsBoolean() Return true if the value of the CDATA is a boolean.
boolean	CDATAValueIsByte() Return true if the value of the CDATA is a byte.
boolean	CDATAValueIsChar() Return true if the value of the CDATA is a char.
boolean	CDATAValueIsDouble() Return true if the value of the CDATA is a double.
boolean	CDATAValueIsFloat() Return true if the value of the CDATA is a float.
boolean	CDATAValueIsInt() Return true if the value of the CDATA is an int.
boolean	CDATAValueIsInt(boolean strict) Return true if the value of the CDATA is an int.
boolean	CDATAValueIsLong() Return true if the value of the CDATA is a long.
boolean	CDATAValueIsLong(boolean strict) Return true if the value of the CDATA is a long.
boolean	CDATAValueIsShort() Return true if the value of the CDATA is a short.
XMLNode	copy() Create a copy of this node.
XMLNode	copy(boolean deep) Create a copy of this node.
XMLNode	copyAsCommentedNode() Create a copy of this node as a commented node.
int	countAttributes() Return the number of attributes of the Node.
int	countChildren() Return the number of children of the Node.
boolean	equals(Object obj)
List<XMLNode>	getAllChildren(QName qname) Return the list of all children of this node having a specified qualified name.
List<XMLNode>	getAllChildren(String name) Return the list of all children of this node having a specified name.
Map<SortableQName,String>	getAttributes() Return the Map of attributes for this node.
String	getAttributeValue(QName qname) Return the value of an attribute of a specified name.
String	getAttributeValue(String attrName) Return the value of an attribute of a specified name.
boolean	getAttributeValueAsBoolean(QName qname, boolean defaultValue) Return the value of an attribute of a specified name as a boolean.
boolean	getAttributeValueAsBoolean(String attrName) Return the value of an attribute of a specified name as a char.
boolean	getAttributeValueAsBoolean(String attrName, boolean defaultValue) Return the value of an attribute of a specified name as a char.
byte	getAttributeValueAsByte(QName qname, byte defaultValue) Return the value of an attribute of a specified name as a byte.
byte	getAttributeValueAsByte(String attrName) Return the value of an attribute of a specified name as a byte.
byte	getAttributeValueAsByte(String attrName, byte defaultValue) Return the value of an attribute of a specified name as a byte.
char	getAttributeValueAsChar(QName qname, char defaultValue) Return the value of an attribute of a specified name as a char.
char	getAttributeValueAsChar(String attrName) Return the value of an attribute of a specified name as a char.
char	getAttributeValueAsChar(String attrName, char defaultValue) Return the value of an attribute of a specified name as a char.
double	getAttributeValueAsDouble(QName qname, double defaultValue) Return the value of an attribute of a specified name as a double.
double	getAttributeValueAsDouble(String attrName) Return the value of an attribute of a specified name as a double.
double	getAttributeValueAsDouble(String attrName, double defaultValue) Return the value of an attribute of a specified name as a double.
float	getAttributeValueAsFloat(QName qname, float defaultValue) Return the value of an attribute of a specified name as a float.
float	getAttributeValueAsFloat(String attrName) Return the value of an attribute of a specified name as a float.
float	getAttributeValueAsFloat(String attrName, float defaultValue) Return the value of an attribute of a specified name as a float.
int	getAttributeValueAsInt(QName qname, int defaultValue, boolean strict) Return the value of an attribute of a specified name as an int.
int	getAttributeValueAsInt(String attrName) Return the value of an attribute of a specified name as an int.
int	getAttributeValueAsInt(String attrName, int defaultValue) Return the value of an attribute of a specified name as an int.
int	getAttributeValueAsInt(String attrName, int defaultValue, boolean strict) Return the value of an attribute of a specified name as an int.
long	getAttributeValueAsLong(QName qname, long defaultValue, boolean strict) Return the value of an attribute of a specified name as a long.
long	getAttributeValueAsLong(String attrName) Return the value of an attribute of a specified name as a long.
long	getAttributeValueAsLong(String attrName, long defaultValue) Return the value of an attribute of a specified name as a long.
long	getAttributeValueAsLong(String attrName, long defaultValue, boolean strict) Return the value of an attribute of a specified name as a long.
short	getAttributeValueAsShort(QName qname, short defaultValue) Return the value of an attribute of a specified name as a short.
short	getAttributeValueAsShort(String attrName) Return the value of an attribute of a specified name as a short.
short	getAttributeValueAsShort(String attrName, short defaultValue) Return the value of an attribute of a specified name as a short.
String	getBoundedPrefix(String uri) Return the prefix bounded with an URI declaration.
Map<String,String>	getBoundPrefixes() Return the prefixes bounded to URIs.
String	getCDATA() Return the CDATA content for the node.
boolean	getCDATAValueAsBoolean(boolean defaultValue) Return the value of the CDATA as a boolean.
byte	getCDATAValueAsByte(byte defaultValue) Return the value of the CDATA as a byte.
char	getCDATAValueAsChar(char defaultValue) Return the value of the CDATA as a char.
double	getCDATAValueAsDouble(double defaultValue) Return the value of the CDATA as a double.
float	getCDATAValueAsFloat(float defaultValue) Return the value of the CDATA as a float.
int	getCDATAValueAsInt(int defaultValue) Return the value of the CDATA as an int.
int	getCDATAValueAsInt(int defaultValue, boolean strict) Return the value of the CDATA as an int.
long	getCDATAValueAsLong(long defaultValue) Return the value of the CDATA as a long.
long	getCDATAValueAsLong(long defaultValue, boolean strict) Return the value of the CDATA as a long.
short	getCDATAValueAsShort(short defaultValue) Return the value of the CDATA as a short.
String	getCDATAValueAsString() Return the CDATA content for the node.
XMLNode	getChild(int i) Return the i-th child of this node.
List<XMLNode>	getChildren() Return the ordered list of children of this Node.
String	getCompleteName() Return the complete name of the node.
String	getEscapedCDATA() Return the escaped CDATA content for the node.
XMLNode	getFirstChild() Return the first child of the Node.
int	getIndex(XMLNode child) Return the index of a child Node in this parent Node.
int	getIndexInParent() Return the index of the Node in its parent.
XMLNode	getLastChild() Return the last child of the Node.
String	getLocalPart() Return the Node local part name.
String	getName() Return the Node local part name.
String	getNamespaceURI() Return the Node namespace URI.
XMLNode	getNextSibling() Return the next sibling of the Node.
XMLNodePath	getNodePath() Return the node path.
XMLNode	getParent() Return the Node parent (or null if the Node is the root of the XML File).
String	getPrefix() Return the Node prefix.
String	getPrefixedName() Return the Node "complete" name, including the prefix.
XMLNode	getPreviousSibling() Return the previous sibling of the Node.
QName	getQualifiedName() Return the Node qualified name.
SortableQName	getSchemaLocationDeclaration() Return the schema location declaration.
String	getSchemaLocationValue() Return the schema location value.
boolean	hasAttribute(QName qname) Return true if the node has an attribute for a specified name.
boolean	hasAttribute(String name) Return true if the node has an attribute for a specified name.
boolean	hasBoundPrefix(String uri) Return true if there is a prefix bounded with an URI declaration.
boolean	hasBoundPrefixes() Return true if there are the prefixes bounded to URIs.
boolean	hasCDATA() Return true if there is a the CDATA content for the node.
boolean	hasChildren() Return true if this Node has children.
int	hashCode()
boolean	hasParent() Return true if the Node has a parent.
boolean	hasSchemaLocationDeclaration() Return true if there is a schema location declaration.
boolean	isWellFormed() Return true if the node is well-formed.
Iterator<XMLNode>	iterator() Return an iterator on the Nodes under this node.
List<XMLNode>	search(List<QName> qnames, boolean deep) Search for the children nodes having a specified qualified name among a list of qualified names.
List<XMLNode>	search(QName[] qnames, boolean deep) Search for the children nodes having a specified qualified name among a list of qualified names.
List<XMLNode>	search(QName qname, boolean deep) Search for the children nodes having a specified qualified name.
List<XMLNode>	search(String name, boolean deep) Search for the children nodes having a specified name.
XMLNode	searchFirst(List<QName> qnames, boolean deep) Search for the the first child node having a specified qualified name among a list of qualified names.
XMLNode	searchFirst(QName[] qnames, boolean deep) Search for the the first child node having a specified qualified name among a list of qualified names.
XMLNode	searchFirst(QName qname, boolean deep) Search for the the first child node having a specified qualified name.
XMLNode	searchFirst(String name, boolean deep) Search for the first child node having a specified name.
XMLNode	searchFirstForNames(List<String> names, boolean deep) Search for the first child node having a specified name among a list of names.
XMLNode	searchFirstForNames(String[] names, boolean deep) Search for the first child node having a specified name among a list of names.
List<XMLNode>	searchForNames(List<String> names, boolean deep) Search for the children nodes having a specified name almong a list of names.
List<XMLNode>	searchForNames(String[] names, boolean deep) Search for the children nodes having a specified name almong a list of names.
void	setBoundPrefixes(Map<String,String> boundPrefixes) Set the bound prefixes.
void	setCDATA(String cData) Set the CDATA content for the node.
protected void	setParent(XMLNode parent) Set the Node parent.
String	toString()
String	toString(int indentation) Return the node as a String.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.mdiutil.xml.tree.CommentedNode

getComment, hasComment, setComment

Methods inherited from interface org.mdiutil.xml.tree.NumberedNode

getLineNumber, hasLineNumber, setLineNumber

Field Detail

qname

protected QName qname

The node name.

nodeParent

protected XMLNode nodeParent

The node parent.

children

protected final List<XMLNode> children

The children nodes.

attributes

protected final Map<SortableQName,String> attributes

The attributes.

cData

protected String cData

The CDATA content.

boundPrefixes

protected Map<String,String> boundPrefixes

The bounded prefixes.

Constructor Detail

XMLNode

public XMLNode(String nodeName)

Create the Node, with a local part.

Qualified name

If the name contains a colon, it will be considered as a qualified name with a prefix and a null URI. For example new XMLNode("h:element") is equivalent to new XMLNode(new QName(XMLConstants.NULL_NS_URI, "element", "h")) But new XMLNode("element") is equivalent to new XMLNode(new QName(XMLConstants.NULL_NS_URI, "element", XMLConstants.DEFAULT_NS_PREFIX))

Parameters:

nodeName - the Node name

XMLNode

public XMLNode(QName qname)

Create the Node.

Parameters:

qname - the Node qualified name

XMLNode

public XMLNode(XMLNode parent,
               String nodeName)

Create a Node.

Parameters:

parent - the Node parent

nodeName - the Node name

XMLNode

public XMLNode(XMLNode parent,
               QName qname)

Create a Node.

Parameters:

parent - the Node parent

qname - the Node qualified name

Method Detail

isWellFormed

public boolean isWellFormed()

Return true if the node is well-formed.

Returns:

true if the node is well-formed

bindPrefix

public void bindPrefix(String prefix,
                       String uri)

Bind a prefix to an URI.

Parameters:

prefix - the prefix

uri - the URI

setBoundPrefixes

public void setBoundPrefixes(Map<String,String> boundPrefixes)

Set the bound prefixes.

Parameters:

boundPrefixes - the prefixes.

getBoundPrefixes

public Map<String,String> getBoundPrefixes()

Return the prefixes bounded to URIs.

Returns:

the bound prefixes

hasBoundPrefixes

public boolean hasBoundPrefixes()

Return true if there are the prefixes bounded to URIs.

Returns:

true if there are the prefixes bounded to URIs

hasBoundPrefix

public boolean hasBoundPrefix(String uri)

Return true if there is a prefix bounded with an URI declaration.

Parameters:

uri - the URI declaration

Returns:

true if there is a prefix bounded with the URI declaration

getBoundedPrefix

public String getBoundedPrefix(String uri)

Return the prefix bounded with an URI declaration.

Parameters:

uri - the URI declaration

Returns:

the prefix

getSchemaLocationDeclaration

public SortableQName getSchemaLocationDeclaration()

Return the schema location declaration.

Returns:

the schema location declaration

getSchemaLocationValue

public String getSchemaLocationValue()

Return the schema location value.

Returns:

the schema location value

hasSchemaLocationDeclaration

public boolean hasSchemaLocationDeclaration()

Return true if there is a schema location declaration.

Returns:

true if there is a schema location declaration

copyAsCommentedNode

public XMLNode copyAsCommentedNode()

Create a copy of this node as a commented node. It will also copy all the children under this node.

Returns:

the Node copy.

copy

public XMLNode copy()

Create a copy of this node. It will also copy all the children under this node.

Returns:

the Node copy.

copy

public XMLNode copy(boolean deep)

Create a copy of this node. It deep is true, then will also copy all the children under this node.

Parameters:

deep - true for a deep copy

Returns:

the Node copy.

getAllChildren

public List<XMLNode> getAllChildren(QName qname)

Return the list of all children of this node having a specified qualified name. The list will include all children, including children of children Nodes.

Parameters:

qname - the qualified name

Returns:

the list

getAllChildren

public List<XMLNode> getAllChildren(String name)

Return the list of all children of this node having a specified name. The list will include all children, including children of children Nodes.

Parameters:

name - the name

Returns:

the list

hasParent

public boolean hasParent()

Return true if the Node has a parent.

Returns:

true if the Node has a parent

getParent

public XMLNode getParent()

Return the Node parent (or null if the Node is the root of the XML File).

Returns:

the Node parent (or null if the Node is the root of the XML File)

setParent

protected void setParent(XMLNode parent)

Set the Node parent.

Parameters:

parent - the Node parent

getPrefixedName

public String getPrefixedName()

Return the Node "complete" name, including the prefix.

Returns:

the Node name including the prefix

getCompleteName

public String getCompleteName()

Return the complete name of the node. It will be the prefix with a colon and the local name if the prefix exists, and the local name only if the prefix does not exist.

Returns:

the complete name.

getName

public String getName()

Return the Node local part name. Same result as getLocalPart().

Returns:

the Node local part name

getLocalPart

public String getLocalPart()

Return the Node local part name.

Returns:

the Node local part name

getNamespaceURI

public String getNamespaceURI()

Return the Node namespace URI.

Returns:

the Node namespace URI

getPrefix

public String getPrefix()

Return the Node prefix.

Returns:

the Node prefix

getQualifiedName

public QName getQualifiedName()

Return the Node qualified name.

Returns:

the Node qualified name

getChildren

public List<XMLNode> getChildren()

Return the ordered list of children of this Node.

Returns:

the ordered list of children of this Node

getChild

public XMLNode getChild(int i)

Return the i-th child of this node.

Parameters:

i - the child index

Returns:

the i-th child of this node

getFirstChild

public XMLNode getFirstChild()

Return the first child of the Node.

Returns:

the first child of the Node

getLastChild

public XMLNode getLastChild()

Return the last child of the Node.

Returns:

the last child of the Node

getNextSibling

public XMLNode getNextSibling()

Return the next sibling of the Node.

Returns:

the next sibling of the Node

getPreviousSibling

public XMLNode getPreviousSibling()

Return the previous sibling of the Node.

Returns:

the previous sibling of the Node

addChild

public void addChild(XMLNode child)

Add a child to this Node.

Parameters:

child - the Node child

getIndex

public int getIndex(XMLNode child)

Return the index of a child Node in this parent Node.

Parameters:

child - the child Node

Returns:

the index of the child, or -1 if the child Node is not a child of this Node

getIndexInParent

public int getIndexInParent()

Return the index of the Node in its parent.

Returns:

the index of the Node in its parent., or -1 if the node has no parent

hasChildren

public boolean hasChildren()

Return true if this Node has children.

Returns:

true if this Node has children

countChildren

public int countChildren()

Return the number of children of the Node.

Returns:

the number of children of the Node

countAttributes

public int countAttributes()

Return the number of attributes of the Node.

Returns:

the number of attributes of the Node

getAttributes

public Map<SortableQName,String> getAttributes()

Return the Map of attributes for this node.

Returns:

the Map of attributes for this node

hasAttribute

public boolean hasAttribute(QName qname)

Return true if the node has an attribute for a specified name.

Parameters:

qname - the attribute qualified name

Returns:

true if the node has an attribute for the specified name

hasAttribute

public boolean hasAttribute(String name)

Return true if the node has an attribute for a specified name.

Parameters:

name - the attribute name

Returns:

true if the node has an attribute for the specified name

getNodePath

public XMLNodePath getNodePath()

Return the node path.

Returns:

the node path

getAttributeValue

public String getAttributeValue(String attrName)

Return the value of an attribute of a specified name.

Parameters:

attrName - the attribute name

Returns:

the value of the attribute

getAttributeValue

public String getAttributeValue(QName qname)

Return the value of an attribute of a specified name.

Parameters:

qname - the attribute qualified name

Returns:

the value of the attribute

attributeValueIsFloat

public boolean attributeValueIsFloat(String attrName)

Return true if an attribute of a specified name can be parsed as a float.

Parameters:

attrName - the attribute name

Returns:

true if the attribute can be parsed as a float

attributeValueIsFloat

public boolean attributeValueIsFloat(QName qname)

Return true if an attribute of a specified name can be parsed as a float.

Parameters:

qname - the attribute qualified name

Returns:

true if the attribute can be parsed as a float

getAttributeValueAsFloat

public float getAttributeValueAsFloat(String attrName)

Return the value of an attribute of a specified name as a float.

Parameters:

attrName - the attribute name

Returns:

the value of the attribute

getAttributeValueAsFloat

public float getAttributeValueAsFloat(String attrName,
                                      float defaultValue)

Return the value of an attribute of a specified name as a float.

Parameters:

attrName - the attribute name

defaultValue - the default value

Returns:

the value of the attribute

getAttributeValueAsFloat

public float getAttributeValueAsFloat(QName qname,
                                      float defaultValue)

Return the value of an attribute of a specified name as a float.

Parameters:

qname - the attribute qualified name

defaultValue - the default value

Returns:

the value of the attribute

attributeValueIsDouble

public boolean attributeValueIsDouble(String attrName)

Return true if an attribute of a specified name can be parsed as a double.

Parameters:

attrName - the attribute name

Returns:

true if the attribute can be parsed as a double

attributeValueIsDouble

public boolean attributeValueIsDouble(QName qname)

Return true if an attribute of a specified name can be parsed as a double.

Parameters:

qname - the attribute qualified name

Returns:

true if the attribute can be parsed as a double

getAttributeValueAsDouble

public double getAttributeValueAsDouble(String attrName)

Return the value of an attribute of a specified name as a double.

Parameters:

attrName - the attribute name

Returns:

the value of the attribute

getAttributeValueAsDouble

public double getAttributeValueAsDouble(String attrName,
                                        double defaultValue)

Return the value of an attribute of a specified name as a double.

Parameters:

attrName - the attribute name

defaultValue - the default value

Returns:

the value of the attribute

getAttributeValueAsDouble

public double getAttributeValueAsDouble(QName qname,
                                        double defaultValue)

Return the value of an attribute of a specified name as a double.

Parameters:

qname - the attribute qualified name

defaultValue - the default value

Returns:

the value of the attribute

attributeValueIsLong

public boolean attributeValueIsLong(String attrName)

Return true if an attribute of a specified name can be parsed as a long.

Parameters:

attrName - the attribute name

Returns:

true if the attribute can be parsed as a long

attributeValueIsLong

public boolean attributeValueIsLong(String attrName,
                                    boolean strict)

Return true if an attribute of a specified name can be parsed as a long.

Parameters:

attrName - the attribute name

strict - true if the parsing must be strict (ie decimal values are not allowed)

Returns:

true if the attribute can be parsed as a long

attributeValueIsLong

public boolean attributeValueIsLong(QName qname)

Return true if an attribute of a specified name can be parsed as a long.

Parameters:

qname - the attribute qualified name

Returns:

true if the attribute can be parsed as a long

attributeValueIsLong

public boolean attributeValueIsLong(QName qname,
                                    boolean strict)

Return true if an attribute of a specified name can be parsed as a long.

Parameters:

qname - the attribute qualified name

strict - true if the parsing must be strict (ie decimal values are not allowed)

Returns:

true if the attribute can be parsed as a long

getAttributeValueAsLong

public long getAttributeValueAsLong(String attrName)

Return the value of an attribute of a specified name as a long.

Parameters:

attrName - the attribute name

Returns:

the value of the attribute

getAttributeValueAsLong

public long getAttributeValueAsLong(String attrName,
                                    long defaultValue)

Return the value of an attribute of a specified name as a long.

Parameters:

attrName - the attribute name

defaultValue - the default value

Returns:

the value of the attribute

getAttributeValueAsLong

public long getAttributeValueAsLong(String attrName,
                                    long defaultValue,
                                    boolean strict)

Return the value of an attribute of a specified name as a long.

Parameters:

attrName - the attribute name

defaultValue - the default value

strict - true if the parsing must be strict (ie decimal values are not allowed)

Returns:

the value of the attribute

getAttributeValueAsLong

public long getAttributeValueAsLong(QName qname,
                                    long defaultValue,
                                    boolean strict)

Return the value of an attribute of a specified name as a long.

Parameters:

qname - the attribute qualified name

defaultValue - the default value

strict - true if the parsing must be strict (ie decimal values are not allowed)

Returns:

the value of the attribute

attributeValueIsInt

public boolean attributeValueIsInt(String attrName)

Return true if an attribute of a specified name can be parsed as an int.

Parameters:

attrName - the attribute name

Returns:

true if the attribute can be parsed as an int

attributeValueIsInt

public boolean attributeValueIsInt(String attrName,
                                   boolean strict)

Return true if an attribute of a specified name can be parsed as an int.

Parameters:

attrName - the attribute name

strict - true if the parsing must be strict (ie decimal values are not allowed)

Returns:

true if the attribute can be parsed as an int

attributeValueIsInt

public boolean attributeValueIsInt(QName qname,
                                   boolean strict)

Return true if an attribute of a specified name can be parsed as an int.

Parameters:

qname - the attribute qualified name

strict - true if the parsing must be strict (ie decimal values are not allowed)

Returns:

true if the attribute can be parsed as an int

getAttributeValueAsInt

public int getAttributeValueAsInt(String attrName)

Return the value of an attribute of a specified name as an int.

Parameters:

attrName - the attribute name

Returns:

the value of the attribute

getAttributeValueAsInt

public int getAttributeValueAsInt(String attrName,
                                  int defaultValue)

Return the value of an attribute of a specified name as an int.

Parameters:

attrName - the attribute name

defaultValue - the default value

Returns:

the value of the attribute

getAttributeValueAsInt

public int getAttributeValueAsInt(String attrName,
                                  int defaultValue,
                                  boolean strict)

Return the value of an attribute of a specified name as an int.

Parameters:

attrName - the attribute name

defaultValue - the default value

strict - true if the parsing must be strict (ie decimal values are not allowed)

Returns:

the value of the attribute

getAttributeValueAsInt

public int getAttributeValueAsInt(QName qname,
                                  int defaultValue,
                                  boolean strict)

Return the value of an attribute of a specified name as an int.

Parameters:

qname - the attribute qualified name

defaultValue - the default value

strict - true if the parsing must be strict (ie decimal values are not allowed)

Returns:

the value of the attribute

attributeValueIsShort

public boolean attributeValueIsShort(String attrName)

Return true if an attribute of a specified name can be parsed as a short.

Parameters:

attrName - the attribute name

Returns:

true if the attribute can be parsed as a short

attributeValueIsShort

public boolean attributeValueIsShort(QName qname)

Return true if an attribute of a specified name can be parsed as a short.

Parameters:

qname - the attribute qualified name

Returns:

true if the attribute can be parsed as a short

getAttributeValueAsShort

public short getAttributeValueAsShort(String attrName)

Return the value of an attribute of a specified name as a short.

Parameters:

attrName - the attribute name

Returns:

the value of the attribute

getAttributeValueAsShort

public short getAttributeValueAsShort(String attrName,
                                      short defaultValue)

Return the value of an attribute of a specified name as a short.

Parameters:

attrName - the attribute name

defaultValue - the default value

Returns:

the value of the attribute

getAttributeValueAsShort

public short getAttributeValueAsShort(QName qname,
                                      short defaultValue)

Return the value of an attribute of a specified name as a short.

Parameters:

qname - the attribute qualified name

defaultValue - the default value

Returns:

the value of the attribute

attributeValueIsByte

public boolean attributeValueIsByte(String attrName)

Return true if an attribute of a specified name can be parsed as a byte.

Parameters:

attrName - the attribute name

Returns:

true if the attribute can be parsed as a byte

attributeValueIsByte

public boolean attributeValueIsByte(QName qname)

Return true if an attribute of a specified name can be parsed as a byte.

Parameters:

qname - the attribute qualified name

Returns:

true if the attribute can be parsed as a byte

getAttributeValueAsByte

public byte getAttributeValueAsByte(String attrName)

Return the value of an attribute of a specified name as a byte.

Parameters:

attrName - the attribute name

Returns:

the value of the attribute

getAttributeValueAsByte

public byte getAttributeValueAsByte(String attrName,
                                    byte defaultValue)

Return the value of an attribute of a specified name as a byte.

Parameters:

attrName - the attribute name

defaultValue - the default value

Returns:

the value of the attribute

getAttributeValueAsByte

public byte getAttributeValueAsByte(QName qname,
                                    byte defaultValue)

Return the value of an attribute of a specified name as a byte.

Parameters:

qname - the attribute qualified name

defaultValue - the default value

Returns:

the value of the attribute

attributeValueIsChar

public boolean attributeValueIsChar(String attrName)

Return true if an attribute of a specified name can be parsed as a char.

Parameters:

attrName - the attribute name

Returns:

true if the attribute can be parsed as a char

attributeValueIsChar

public boolean attributeValueIsChar(QName qname)

Return true if an attribute of a specified name can be parsed as a char.

Parameters:

qname - the attribute qualified name

Returns:

true if the attribute can be parsed as a char

getAttributeValueAsChar

public char getAttributeValueAsChar(String attrName)

Return the value of an attribute of a specified name as a char.

Parameters:

attrName - the attribute name

Returns:

the value of the attribute

getAttributeValueAsChar

public char getAttributeValueAsChar(String attrName,
                                    char defaultValue)

Return the value of an attribute of a specified name as a char.

Parameters:

attrName - the attribute name

defaultValue - the default value

Returns:

the value of the attribute

getAttributeValueAsChar

public char getAttributeValueAsChar(QName qname,
                                    char defaultValue)

Return the value of an attribute of a specified name as a char.

Parameters:

qname - the attribute qualified name

defaultValue - the default value

Returns:

the value of the attribute

attributeValueIsBoolean

public boolean attributeValueIsBoolean(String attrName)

Return true if an attribute of a specified name can be parsed as a boolean.

Parameters:

attrName - the attribute name

Returns:

true if the attribute can be parsed as a char

attributeValueIsBoolean

public boolean attributeValueIsBoolean(QName qname)

Return true if an attribute of a specified name can be parsed as a boolean.

Parameters:

qname - the attribute qualified name

Returns:

true if the attribute can be parsed as a boolean

getAttributeValueAsBoolean

public boolean getAttributeValueAsBoolean(String attrName)

Return the value of an attribute of a specified name as a char.

Parameters:

attrName - the attribute name

Returns:

the value of the attribute

getAttributeValueAsBoolean

public boolean getAttributeValueAsBoolean(String attrName,
                                          boolean defaultValue)

Return the value of an attribute of a specified name as a char.

Parameters:

attrName - the attribute name

defaultValue - the default value

Returns:

the value of the attribute

getAttributeValueAsBoolean

public boolean getAttributeValueAsBoolean(QName qname,
                                          boolean defaultValue)

Return the value of an attribute of a specified name as a boolean.

Parameters:

qname - the attribute qualified name

defaultValue - the default value

Returns:

the value of the attribute

addAttribute

public void addAttribute(QName qname,
                         String value)

Add an attribute for this Node.

Parameters:

qname - the attribute qualified name

value - the attribute value

addAttribute

public void addAttribute(String attrName,
                         String value)

Add an attribute for this Node.

Parameters:

attrName - the attribute name

value - the attribute value

addAttribute

public void addAttribute(QName qname,
                         float value)

Add an attribute for this Node.

Parameters:

qname - the attribute qualified name

value - the attribute value

addAttribute

public void addAttribute(String attrName,
                         float value)

Add an attribute for this Node.

Parameters:

attrName - the attribute name

value - the attribute value

addAttribute

public void addAttribute(QName qname,
                         double value)

Add an attribute for this Node.

Parameters:

qname - the attribute qualified name

value - the attribute value

addAttribute

public void addAttribute(String attrName,
                         double value)

Add an attribute for this Node.

Parameters:

attrName - the attribute name

value - the attribute value

addAttribute

public void addAttribute(QName qname,
                         int value)

Add an attribute for this Node.

Parameters:

qname - the attribute qualified name

value - the attribute value

addAttribute

public void addAttribute(String attrName,
                         int value)

Add an attribute for this Node.

Parameters:

attrName - the attribute name

value - the attribute value

addAttribute

public void addAttribute(QName qname,
                         long value)

Add an attribute for this Node.

Parameters:

qname - the attribute qualified name

value - the attribute value

addAttribute

public void addAttribute(String attrName,
                         long value)

Add an attribute for this Node.

Parameters:

attrName - the attribute name

value - the attribute value

addAttribute

public void addAttribute(QName qname,
                         short value)

Add an attribute for this Node.

Parameters:

qname - the attribute qualified name

value - the attribute value

addAttribute

public void addAttribute(String attrName,
                         short value)

Add an attribute for this Node.

Parameters:

attrName - the attribute name

value - the attribute value

addAttribute

public void addAttribute(QName qname,
                         byte value)

Add an attribute for this Node.

Parameters:

qname - the attribute qualified name

value - the attribute value

addAttribute

public void addAttribute(String attrName,
                         byte value)

Add an attribute for this Node.

Parameters:

attrName - the attribute name

value - the attribute value

addAttribute

public void addAttribute(QName qname,
                         char value)

Add an attribute for this Node.

Parameters:

qname - the attribute qualified name

value - the attribute value

addAttribute

public void addAttribute(String attrName,
                         char value)

Add an attribute for this Node.

Parameters:

attrName - the attribute name

value - the attribute value

addAttribute

public void addAttribute(QName qname,
                         boolean value)

Add an attribute for this Node.

Parameters:

qname - the attribute qualified name

value - the attribute value

addAttribute

public void addAttribute(String attrName,
                         boolean value)

Add an attribute for this Node.

Parameters:

attrName - the attribute name

value - the attribute value

setCDATA

public void setCDATA(String cData)

Set the CDATA content for the node.

Parameters:

cData - the CDATA content

getCDATA

public String getCDATA()

Return the CDATA content for the node. If the CDATA content is empty, it will return null.

Returns:

the CDATA content

getEscapedCDATA

public String getEscapedCDATA()

Return the escaped CDATA content for the node. If the CDATA content is empty, it will return null.

Returns:

the escaped CDATA content

CDATAValueIsBoolean

public boolean CDATAValueIsBoolean()

Return true if the value of the CDATA is a boolean.

Returns:

true if the value of the CDATA is a boolean

getCDATAValueAsString

public String getCDATAValueAsString()

Return the CDATA content for the node. If the CDATA content is empty, it will return an empty string.

Returns:

the CDATA content

getCDATAValueAsBoolean

public boolean getCDATAValueAsBoolean(boolean defaultValue)

Return the value of the CDATA as a boolean.

Parameters:

defaultValue - the default value

Returns:

the value of the CDATA

CDATAValueIsShort

public boolean CDATAValueIsShort()

Return true if the value of the CDATA is a short.

Returns:

true if the value of the CDATA is a short

getCDATAValueAsShort

public short getCDATAValueAsShort(short defaultValue)

Return the value of the CDATA as a short.

Parameters:

defaultValue - the default value

Returns:

the value of the CDATA

CDATAValueIsByte

public boolean CDATAValueIsByte()

Return true if the value of the CDATA is a byte.

Returns:

true if the value of the CDATA is a byte

getCDATAValueAsByte

public byte getCDATAValueAsByte(byte defaultValue)

Return the value of the CDATA as a byte.

Parameters:

defaultValue - the default value

Returns:

the value of the CDATA

CDATAValueIsChar

public boolean CDATAValueIsChar()

Return true if the value of the CDATA is a char.

Returns:

true if the value of the CDATA is a char

getCDATAValueAsChar

public char getCDATAValueAsChar(char defaultValue)

Return the value of the CDATA as a char.

Parameters:

defaultValue - the default value

Returns:

the value of the CDATA

CDATAValueIsInt

public boolean CDATAValueIsInt()

Return true if the value of the CDATA is an int.

Returns:

true if the value of the CDATA is an int

CDATAValueIsInt

public boolean CDATAValueIsInt(boolean strict)

Return true if the value of the CDATA is an int.

Parameters:

strict - true if the parsing must be strict (ie decimal values are not allowed)

Returns:

true if the value of the CDATA is an int

getCDATAValueAsInt

public int getCDATAValueAsInt(int defaultValue)

Return the value of the CDATA as an int.

Parameters:

defaultValue - the default value

Returns:

the value of the CDATA

getCDATAValueAsInt

public int getCDATAValueAsInt(int defaultValue,
                              boolean strict)

Return the value of the CDATA as an int.

Parameters:

defaultValue - the default value

strict - true if the parsing must be strict (ie decimal values are not allowed)

Returns:

the value of the CDATA

CDATAValueIsLong

public boolean CDATAValueIsLong()

Return true if the value of the CDATA is a long.

Returns:

true if the value of the CDATA is a long

CDATAValueIsLong

public boolean CDATAValueIsLong(boolean strict)

Return true if the value of the CDATA is a long.

Parameters:

strict - true if the parsing must be strict (ie decimal values are not allowed)

Returns:

true if the value of the CDATA is a long

getCDATAValueAsLong

public long getCDATAValueAsLong(long defaultValue)

Return the value of the CDATA as a long.

Parameters:

defaultValue - the default value

Returns:

the value of the CDATA

getCDATAValueAsLong

public long getCDATAValueAsLong(long defaultValue,
                                boolean strict)

Return the value of the CDATA as a long.

Parameters:

defaultValue - the default value

strict - true if the parsing must be strict (ie decimal values are not allowed)

Returns:

the value of the CDATA

CDATAValueIsFloat

public boolean CDATAValueIsFloat()

Return true if the value of the CDATA is a float.

Returns:

true if the value of the CDATA is a float

getCDATAValueAsFloat

public float getCDATAValueAsFloat(float defaultValue)

Return the value of the CDATA as a float.

Parameters:

defaultValue - the default value

Returns:

the value of the CDATA

CDATAValueIsDouble

public boolean CDATAValueIsDouble()

Return true if the value of the CDATA is a double.

Returns:

true if the value of the CDATA is a double

getCDATAValueAsDouble

public double getCDATAValueAsDouble(double defaultValue)

Return the value of the CDATA as a double.

Parameters:

defaultValue - the default value

Returns:

the value of the CDATA

hasCDATA

public boolean hasCDATA()

Return true if there is a the CDATA content for the node.

Returns:

true if there is a the CDATA content for the nodet

search

public List<XMLNode> search(String name,
                            boolean deep)

Search for the children nodes having a specified name. See XMLNodeUtilities.search(org.mdiutil.xml.tree.XMLNode, java.lang.String, boolean).

Parameters:

name - the name to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

searchForNames

public List<XMLNode> searchForNames(List<String> names,
                                    boolean deep)

Search for the children nodes having a specified name almong a list of names. See XMLNodeUtilities.search(org.mdiutil.xml.tree.XMLNode, java.lang.String, boolean).

Parameters:

names - the names to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

searchForNames

public List<XMLNode> searchForNames(String[] names,
                                    boolean deep)

Search for the children nodes having a specified name almong a list of names. See XMLNodeUtilities.search(org.mdiutil.xml.tree.XMLNode, java.lang.String, boolean).

Parameters:

names - the names to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

searchFirst

public XMLNode searchFirst(QName qname,
                           boolean deep)

Search for the the first child node having a specified qualified name. See XMLNodeUtilities.searchFirst(org.mdiutil.xml.tree.XMLNode, javax.xml.namespace.QName, boolean).

Parameters:

qname - the qualified name to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

searchFirst

public XMLNode searchFirst(List<QName> qnames,
                           boolean deep)

Search for the the first child node having a specified qualified name among a list of qualified names. See XMLNodeUtilities.searchFirst(org.mdiutil.xml.tree.XMLNode, java.util.List, boolean).

Parameters:

qnames - the qualified names to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

searchFirst

public XMLNode searchFirst(QName[] qnames,
                           boolean deep)

Search for the the first child node having a specified qualified name among a list of qualified names. See XMLNodeUtilities.searchFirst(org.mdiutil.xml.tree.XMLNode, java.util.List, boolean).

Parameters:

qnames - the qualified names to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

searchFirst

public XMLNode searchFirst(String name,
                           boolean deep)

Search for the first child node having a specified name. See XMLNodeUtilities.searchFirst(org.mdiutil.xml.tree.XMLNode, java.lang.String, boolean).

Parameters:

name - the name to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

searchFirstForNames

public XMLNode searchFirstForNames(List<String> names,
                                   boolean deep)

Search for the first child node having a specified name among a list of names. See XMLNodeUtilities.searchFirst(org.mdiutil.xml.tree.XMLNode, java.lang.String, boolean).

Parameters:

names - the name to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

searchFirstForNames

public XMLNode searchFirstForNames(String[] names,
                                   boolean deep)

Search for the first child node having a specified name among a list of names. See XMLNodeUtilities.searchFirst(org.mdiutil.xml.tree.XMLNode, java.lang.String, boolean).

Parameters:

names - the name to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

search

public List<XMLNode> search(QName qname,
                            boolean deep)

Search for the children nodes having a specified qualified name. See XMLNodeUtilities.search(org.mdiutil.xml.tree.XMLNode, javax.xml.namespace.QName, boolean).

Parameters:

qname - the qualified name to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

search

public List<XMLNode> search(List<QName> qnames,
                            boolean deep)

Search for the children nodes having a specified qualified name among a list of qualified names. See XMLNodeUtilities.search(org.mdiutil.xml.tree.XMLNode, java.util.List, boolean).

Parameters:

qnames - the qualified names to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

search

public List<XMLNode> search(QName[] qnames,
                            boolean deep)

Search for the children nodes having a specified qualified name among a list of qualified names. See XMLNodeUtilities.search(org.mdiutil.xml.tree.XMLNode, java.util.List, boolean).

Parameters:

qnames - the qualified names to search for

deep - if the search should continue for children of nodes found in the search

Returns:

the list of nodes with the specified name

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString(int indentation)

Return the node as a String.

Parameters:

indentation - the indentation

Returns:

the node as a String

toString

public String toString()

Overrides:

toString in class Object

iterator

public Iterator<XMLNode> iterator()

Return an iterator on the Nodes under this node.

Specified by:

iterator in interface Iterable<XMLNode>

Returns:

the iterator