org.yawlfoundation.yawl.util

Class XNode

java.lang.Object

org.yawlfoundation.yawl.util.XNode

All Implemented Interfaces:

java.lang.Comparable<XNode>

public class XNode
extends java.lang.Object
implements java.lang.Comparable<XNode>

A utility for building xml strings. Handles elements, attributes, comments, text and CDATA (and that's all - no edge cases). NOTE: To keep things simple, while this class allows a node to have both child nodes and text, where both have values set the child nodes have precedence (ie. the text is ignored). Author: Michael Adams Creation Date: 19/03/2010

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XNode.ContentType

Constructor Summary

Constructors

Constructor and Description
XNode(java.lang.String name)
XNode(java.lang.String name, java.lang.String text)

Method Summary

Modifier and Type	Method and Description
void	addAttribute(java.lang.String key, boolean value)
void	addAttribute(java.lang.String key, byte value)
void	addAttribute(java.lang.String key, double value)
void	addAttribute(java.lang.String key, float value)
void	addAttribute(java.lang.String key, int value)
void	addAttribute(java.lang.String key, long value)
void	addAttribute(java.lang.String key, java.lang.Object o)
void	addAttribute(java.lang.String key, short value)
void	addAttribute(java.lang.String key, java.lang.String value)
void	addAttribute(java.lang.String key, java.lang.String value, boolean escape)
void	addAttributes(java.util.Map<java.lang.String,java.lang.String> map)
XNode	addCDATA(java.lang.String cdata)
XNode	addChild(java.lang.String name)
XNode	addChild(java.lang.String name, boolean b)
XNode	addChild(java.lang.String name, byte b)
XNode	addChild(java.lang.String name, double d)
XNode	addChild(java.lang.String name, float f)
XNode	addChild(java.lang.String name, int i)
XNode	addChild(java.lang.String name, long l)
XNode	addChild(java.lang.String name, java.lang.Object o)
XNode	addChild(java.lang.String name, short s)
XNode	addChild(java.lang.String name, java.lang.String text)
XNode	addChild(java.lang.String name, java.lang.String text, boolean escape)
XNode	addChild(XNode child)
void	addChildren(java.util.Collection<XNode> children)
void	addChildren(java.util.Map<java.lang.String,java.lang.String> children)
void	addClosingComment(java.lang.String comment)
<E extends XNodeIO> void	addCollection(java.util.Collection<E> list) Adds a child node to this node for each object in a list
XNode	addComment(java.lang.String comment)
void	addContent(java.lang.String content)
void	addContent(java.lang.String content, java.lang.String nsPrefix, java.lang.String nsURI)
void	addOpeningComment(java.lang.String comment)
int	compareTo(XNode other)
int	getAttributeCount()
java.util.Map<java.lang.String,java.lang.String>	getAttributes()
java.lang.String	getAttributeValue(java.lang.String key)
XNode	getChild()
XNode	getChild(int index)
XNode	getChild(java.lang.String name)
int	getChildCount()
java.util.List<XNode>	getChildren()
java.util.List<XNode>	getChildren(java.lang.String name)
java.util.List<XNode>	getChildren(XNode.ContentType cType)
java.lang.String	getChildText(java.lang.String name)
java.lang.String	getChildText(java.lang.String name, boolean escape)
int	getDepth()
java.lang.String	getName()
XNode	getOrAddChild(java.lang.String name)
XNode	getParent()
java.lang.String	getText()
java.lang.String	getText(boolean escape)
int	getTextLength()
boolean	hasAttribute(java.lang.String key)
boolean	hasChild(java.lang.String name)
boolean	hasChildren()
boolean	hasChildren(java.lang.String name)
XNode	insertChild(int index, XNode child)
XNode	insertComment(int index, java.lang.String comment)
boolean	isCDATA()
boolean	isComment()
int	length()
<E extends XNodeIO> void	populateCollection(java.util.Collection<E> list, E instance) Creates and adds an object of type E to a list for each child node.
int	posChildWithAttribute(java.lang.String key, java.lang.String value)
int	posChildWithName(java.lang.String name)
boolean	removeChild(XNode child)
void	removeChildren()
void	removeDuplicateChildren()
void	setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
void	setDepth(int depth)
void	setName(java.lang.String name)
void	setParent(XNode parent)
void	setText(boolean value)
void	setText(byte value)
void	setText(double value)
void	setText(float value)
void	setText(int value)
void	setText(long value)
void	setText(short value)
void	setText(java.lang.String text)
void	setText(java.lang.String text, boolean escape)
void	sort()
void	sort(java.util.Comparator<XNode> comparator)
Document	toDocument()
Element	toElement()
java.lang.String	toPrettyString()
java.lang.String	toPrettyString(boolean header)
java.lang.String	toPrettyString(boolean header, int tabSize)
java.lang.String	toPrettyString(int tabSize)
java.lang.String	toPrettyString(int offset, int tabSize)
java.lang.String	toString()
java.lang.String	toString(boolean header)

Methods inherited from class java.lang.Object

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

Constructor Detail

XNode

public XNode(java.lang.String name)

XNode

public XNode(java.lang.String name,
             java.lang.String text)

Method Detail

compareTo

public int compareTo(XNode other)

Specified by:

compareTo in interface java.lang.Comparable<XNode>

addAttribute

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

addAttribute

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

addAttribute

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

addAttribute

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

addAttribute

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

addAttribute

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

addAttribute

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

addAttribute

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

addAttribute

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

addAttribute

public void addAttribute(java.lang.String key,
                         java.lang.Object o)

addAttributes

public void addAttributes(java.util.Map<java.lang.String,java.lang.String> map)

insertChild

public XNode insertChild(int index,
                         XNode child)

addChild

public XNode addChild(XNode child)

addChild

public XNode addChild(java.lang.String name)

addChild

public XNode addChild(java.lang.String name,
                      java.lang.String text)

addChild

public XNode addChild(java.lang.String name,
                      boolean b)

addChild

public XNode addChild(java.lang.String name,
                      long l)

addChild

public XNode addChild(java.lang.String name,
                      int i)

addChild

public XNode addChild(java.lang.String name,
                      byte b)

addChild

public XNode addChild(java.lang.String name,
                      short s)

addChild

public XNode addChild(java.lang.String name,
                      double d)

addChild

public XNode addChild(java.lang.String name,
                      float f)

addChild

public XNode addChild(java.lang.String name,
                      java.lang.Object o)

addChild

public XNode addChild(java.lang.String name,
                      java.lang.String text,
                      boolean escape)

addChildren

public void addChildren(java.util.Collection<XNode> children)

addChildren

public void addChildren(java.util.Map<java.lang.String,java.lang.String> children)

removeChild

public boolean removeChild(XNode child)

removeChildren

public void removeChildren()

addContent

public void addContent(java.lang.String content)

addContent

public void addContent(java.lang.String content,
                       java.lang.String nsPrefix,
                       java.lang.String nsURI)

addCollection

public <E extends XNodeIO> void addCollection(java.util.Collection<E> list)

Adds a child node to this node for each object in a list

Type Parameters:

E - a type extending the XNodeIO interface

Parameters:

list - the list of objects to create child nodes from

populateCollection

public <E extends XNodeIO> void populateCollection(java.util.Collection<E> list,
                                                   E instance)

Creates and adds an object of type E to a list for each child node. It is assumed that each child of this node represents an object of type E.

Type Parameters:

E - a type extending the XNodeIO interface

Parameters:

list - the list of objects to populate

instance - an instance of an E type object

removeDuplicateChildren

public void removeDuplicateChildren()

addComment

public XNode addComment(java.lang.String comment)

insertComment

public XNode insertComment(int index,
                           java.lang.String comment)

isComment

public boolean isComment()

addOpeningComment

public void addOpeningComment(java.lang.String comment)

addClosingComment

public void addClosingComment(java.lang.String comment)

addCDATA

public XNode addCDATA(java.lang.String cdata)

isCDATA

public boolean isCDATA()

setText

public void setText(java.lang.String text)

setText

public void setText(java.lang.String text,
                    boolean escape)

setText

public void setText(boolean value)

setText

public void setText(byte value)

setText

public void setText(short value)

setText

public void setText(int value)

setText

public void setText(long value)

setText

public void setText(double value)

setText

public void setText(float value)

getChild

public XNode getChild(java.lang.String name)

getOrAddChild

public XNode getOrAddChild(java.lang.String name)

getChild

public XNode getChild()

getChild

public XNode getChild(int index)

getChildren

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

getChildren

public java.util.List<XNode> getChildren(XNode.ContentType cType)

getChildren

public java.util.List<XNode> getChildren(java.lang.String name)

getChildText

public java.lang.String getChildText(java.lang.String name)

getChildText

public java.lang.String getChildText(java.lang.String name,
                                     boolean escape)

posChildWithName

public int posChildWithName(java.lang.String name)

posChildWithAttribute

public int posChildWithAttribute(java.lang.String key,
                                 java.lang.String value)

getText

public java.lang.String getText()

getText

public java.lang.String getText(boolean escape)

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String key)

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

hasAttribute

public boolean hasAttribute(java.lang.String key)

setAttributes

public void setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

setParent

public void setParent(XNode parent)

getParent

public XNode getParent()

getDepth

public int getDepth()

setDepth

public void setDepth(int depth)

hasChildren

public boolean hasChildren()

hasChildren

public boolean hasChildren(java.lang.String name)

hasChild

public boolean hasChild(java.lang.String name)

getAttributeCount

public int getAttributeCount()

getChildCount

public int getChildCount()

getTextLength

public int getTextLength()

length

public int length()

sort

public void sort()

sort

public void sort(java.util.Comparator<XNode> comparator)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(boolean header)

toPrettyString

public java.lang.String toPrettyString()

toPrettyString

public java.lang.String toPrettyString(boolean header)

toPrettyString

public java.lang.String toPrettyString(int tabSize)

toPrettyString

public java.lang.String toPrettyString(int offset,
                                       int tabSize)

toPrettyString

public java.lang.String toPrettyString(boolean header,
                                       int tabSize)

toElement

public Element toElement()

toDocument

public Document toDocument()