Package groovy.util
Class Node
- java.lang.Object
- 
- groovy.util.Node
 
- 
- All Implemented Interfaces:
- Serializable,- Cloneable
 
 public class Node extends Object implements Serializable, Cloneable Represents an arbitrary tree node which can be used for structured metadata or any arbitrary XML-like tree. A node can have a name, a value and an optional Map of attributes. Typically the name is a String and a value is either a String or a List of other Nodes, though the types are extensible to provide a flexible structure, e.g. you could use a QName as the name which includes a namespace URI and a local name. Or a JMX ObjectName etc. So this class can represent metadata like{foo a=1 b="abc"}or nested metadata like{foo a=1 b="123" { bar x=12 text="hello" }}- See Also:
- Serialized Form
 
- 
- 
Constructor SummaryConstructors Constructor Description Node(Node parent, Object name)Creates a new Node namednameand if a parent is supplied, adds the newly created node as a child of the parent.Node(Node parent, Object name, Object value)Creates a new Node namednamewith valuevalueand if a parent is supplied, adds the newly created node as a child of the parent.Node(Node parent, Object name, Map attributes)Creates a new Node namednamewith attributes specified in theattributesMap.Node(Node parent, Object name, Map attributes, Object value)Creates a new Node namednamewith valuevalueand with attributes specified in theattributesMap.
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanappend(Node child)Appends a child to the current node.NodeappendNode(Object name)Creates a new node as a child of the current node.NodeappendNode(Object name, Object value)Creates a new node as a child of the current node.NodeappendNode(Object name, Map attributes)Creates a new node as a child of the current node.NodeappendNode(Object name, Map attributes, Object value)Creates a new node as a child of the current node.Objectattribute(Object key)Provides lookup of attributes by key.Mapattributes()Returns aMapof the attributes of the node or an emptyMapif the node does not have any attributes.ListbreadthFirst()Provides a collection of all the nodes in the tree using a breadth-first preorder traversal.ListbreadthFirst(boolean preorder)Provides a collection of all the nodes in the tree using a breadth-first traversal.voidbreadthFirst(Closure c)Calls the provided closure for all the nodes in the tree using a breadth-first preorder traversal.voidbreadthFirst(Map<String,Object> options, Closure c)Calls the provided closure for all the nodes in the tree using a breadth-first traversal.Listchildren()Returns aListof the nodes children.Objectclone()Creates a new Node with the same name, no parent, shallow cloned attributes and if the value is a NodeList, a (deep) clone of those nodes.ListdepthFirst()Provides a collection of all the nodes in the tree using a depth-first preorder traversal.ListdepthFirst(boolean preorder)Provides a collection of all the nodes in the tree using a depth-first traversal.voiddepthFirst(Closure c)Provides a collection of all the nodes in the tree using a depth-first preorder traversal.voiddepthFirst(Map<String,Object> options, Closure c)Provides a collection of all the nodes in the tree using a depth-first traversal.Objectget(String key)Provides lookup of elements by non-namespaced nameNodeListgetAt(QName name)Provides lookup of elements by QName.NodeListgetAt(QName name)Provides lookup of elements by QName.Iteratoriterator()Returns anIteratorof the children of the node.List<String>localText()Returns the list of any direct String nodes of this node.Objectname()Returns anObjectrepresenting the name of the node.Nodeparent()Returns the parent of the node.voidplus(Closure c)Adds sibling nodes (defined using builder-style notation via a Closure) after the current node.voidprint(PrintWriter out)Writes the node to the specifiedPrintWriter.booleanremove(Node child)Removes a child of the current node.NodereplaceNode(Closure c)Replaces the current node with nodes defined using builder-style notation via a Closure.NodereplaceNode(Node n)Replaces the current node with the supplied node.protected static voidsetMetaClass(MetaClass metaClass, Class nodeClass)Extension point for subclasses to override the metaclass.protected voidsetParent(Node parent)Adds or replaces the parent of the node.voidsetValue(Object value)Adds or replaces the value of the node.Stringtext()Returns the textual representation of the current node and all its child nodes.BigDecimaltoBigDecimal()Converts the text of this GPathResult to a BigDecimal object.BigIntegertoBigInteger()Converts the text of this GPathResult to a BigInteger object.DoubletoDouble()Converts the text of this GPathResult to a Double object.FloattoFloat()Converts the text of this GPathResult to a Float object.IntegertoInteger()Converts the text of this GPathResult to a Integer object.LongtoLong()Converts the text of this GPathResult to a Long object.StringtoString()Objectvalue()Returns anObjectrepresenting the value of the node.
 
- 
- 
- 
Constructor Detail- 
Nodepublic Node(Node parent, Object name) Creates a new Node namednameand if a parent is supplied, adds the newly created node as a child of the parent.- Parameters:
- parent- the parent node or null if no parent
- name- the name of the node
 
 - 
Nodepublic Node(Node parent, Object name, Object value) Creates a new Node namednamewith valuevalueand if a parent is supplied, adds the newly created node as a child of the parent.- Parameters:
- parent- the parent node or null if no parent
- name- the name of the node
- value- the Node value, e.g. some text but in general any Object
 
 - 
Nodepublic Node(Node parent, Object name, Map attributes) Creates a new Node namednamewith attributes specified in theattributesMap. If a parent is supplied, the newly created node is added as a child of the parent.- Parameters:
- parent- the parent node or null if no parent
- name- the name of the node
- attributes- a Map of name-value pairs
 
 - 
Nodepublic Node(Node parent, Object name, Map attributes, Object value) Creates a new Node namednamewith valuevalueand with attributes specified in theattributesMap. If a parent is supplied, the newly created node is added as a child of the parent.- Parameters:
- parent- the parent node or null if no parent
- name- the name of the node
- attributes- a Map of name-value pairs
- value- the Node value, e.g. some text but in general any Object
 
 
- 
 - 
Method Detail- 
clonepublic Object clone() Creates a new Node with the same name, no parent, shallow cloned attributes and if the value is a NodeList, a (deep) clone of those nodes.
 - 
appendpublic boolean append(Node child) Appends a child to the current node.- Parameters:
- child- the child to append
- Returns:
- true
 
 - 
removepublic boolean remove(Node child) Removes a child of the current node.- Parameters:
- child- the child to remove
- Returns:
- trueif the param was a child of the current node
 
 - 
appendNodepublic Node appendNode(Object name, Map attributes) Creates a new node as a child of the current node.- Parameters:
- name- the name of the new node
- attributes- the attributes of the new node
- Returns:
- the newly created Node
 
 - 
appendNodepublic Node appendNode(Object name) Creates a new node as a child of the current node.- Parameters:
- name- the name of the new node
- Returns:
- the newly created Node
 
 - 
appendNodepublic Node appendNode(Object name, Object value) Creates a new node as a child of the current node.- Parameters:
- name- the name of the new node
- value- the value of the new node
- Returns:
- the newly created Node
 
 - 
appendNodepublic Node appendNode(Object name, Map attributes, Object value) Creates a new node as a child of the current node.- Parameters:
- name- the name of the new node
- attributes- the attributes of the new node
- value- the value of the new node
- Returns:
- the newly created Node
 
 - 
replaceNodepublic Node replaceNode(Closure c) Replaces the current node with nodes defined using builder-style notation via a Closure.- Parameters:
- c- A Closure defining the new nodes using builder-style notation.
- Returns:
- the original now replaced node
 
 - 
replaceNodepublic Node replaceNode(Node n) Replaces the current node with the supplied node.- Parameters:
- n- the new Node
- Returns:
- the original now replaced node
 
 - 
pluspublic void plus(Closure c) Adds sibling nodes (defined using builder-style notation via a Closure) after the current node.- Parameters:
- c- A Closure defining the new sibling nodes to add using builder-style notation.
 
 - 
setMetaClassprotected static void setMetaClass(MetaClass metaClass, Class nodeClass) Extension point for subclasses to override the metaclass. The default one supports the property and @ attribute notations.- Parameters:
- metaClass- the original metaclass
- nodeClass- the class whose metaclass we wish to override (this class or a subclass)
 
 - 
textpublic String text() Returns the textual representation of the current node and all its child nodes.- Returns:
- the text value of the node including child text
 
 - 
iteratorpublic Iterator iterator() Returns anIteratorof the children of the node.- Returns:
- the iterator of the nodes children
 
 - 
childrenpublic List children() Returns aListof the nodes children.- Returns:
- the nodes children
 
 - 
attributespublic Map attributes() Returns aMapof the attributes of the node or an emptyMapif the node does not have any attributes.- Returns:
- the attributes of the node
 
 - 
attributepublic Object attribute(Object key) Provides lookup of attributes by key.- Parameters:
- key- the key of interest
- Returns:
- the attribute matching the key or nullif no match exists
 
 - 
namepublic Object name() Returns anObjectrepresenting the name of the node.- Returns:
- the name or nullif name is empty
 
 - 
valuepublic Object value() Returns anObjectrepresenting the value of the node.- Returns:
- the value or nullif value is empty
 
 - 
setValuepublic void setValue(Object value) Adds or replaces the value of the node.- Parameters:
- value- the new value of the node
 
 - 
parentpublic Node parent() Returns the parent of the node.- Returns:
- the parent or nullfor the root node
 
 - 
setParentprotected void setParent(Node parent) Adds or replaces the parent of the node.- Parameters:
- parent- the new parent of the node
 
 - 
getpublic Object get(String key) Provides lookup of elements by non-namespaced name- Parameters:
- key- the name (or shortcut key) of the node(s) of interest
- Returns:
- the nodes which match key
 
 - 
getAtpublic NodeList getAt(QName name) Provides lookup of elements by QName.- Parameters:
- name- the QName of interest
- Returns:
- the nodes matching name
 
 - 
getAtpublic NodeList getAt(QName name) Provides lookup of elements by QName.- Parameters:
- name- the QName of interest
- Returns:
- the nodes matching name
 
 - 
depthFirstpublic List depthFirst() Provides a collection of all the nodes in the tree using a depth-first preorder traversal.- Returns:
- the list of (depth-first) ordered nodes
 
 - 
depthFirstpublic List depthFirst(boolean preorder) Provides a collection of all the nodes in the tree using a depth-first traversal.- Parameters:
- preorder- if false, a postorder depth-first traversal will be performed
- Returns:
- the list of (depth-first) ordered nodes
- Since:
- 2.5.0
 
 - 
depthFirstpublic void depthFirst(Closure c) Provides a collection of all the nodes in the tree using a depth-first preorder traversal.- Parameters:
- c- the closure to run for each node (a one or two parameter can be used; if one parameter is given the closure will be passed the node, for a two param closure the second parameter will be the level).
- Since:
- 2.5.0
 
 - 
depthFirstpublic void depthFirst(Map<String,Object> options, Closure c) Provides a collection of all the nodes in the tree using a depth-first traversal. A boolean 'preorder' options is supported.- Parameters:
- options- map containing options
- c- the closure to run for each node (a one or two parameter can be used; if one parameter is given the closure will be passed the node, for a two param closure the second parameter will be the level).
- Since:
- 2.5.0
 
 - 
breadthFirstpublic List breadthFirst() Provides a collection of all the nodes in the tree using a breadth-first preorder traversal.- Returns:
- the list of (breadth-first) ordered nodes
 
 - 
breadthFirstpublic List breadthFirst(boolean preorder) Provides a collection of all the nodes in the tree using a breadth-first traversal.- Parameters:
- preorder- if false, a postorder breadth-first traversal will be performed
- Returns:
- the list of (breadth-first) ordered nodes
- Since:
- 2.5.0
 
 - 
breadthFirstpublic void breadthFirst(Closure c) Calls the provided closure for all the nodes in the tree using a breadth-first preorder traversal.- Parameters:
- c- the closure to run for each node (a one or two parameter can be used; if one parameter is given the closure will be passed the node, for a two param closure the second parameter will be the level).
- Since:
- 2.5.0
 
 - 
breadthFirstpublic void breadthFirst(Map<String,Object> options, Closure c) Calls the provided closure for all the nodes in the tree using a breadth-first traversal. A boolean 'preorder' options is supported.- Parameters:
- options- map containing options
- c- the closure to run for each node (a one or two parameter can be used; if one parameter is given the closure will be passed the node, for a two param closure the second parameter will be the level).
- Since:
- 2.5.0
 
 - 
localTextpublic List<String> localText() Returns the list of any direct String nodes of this node.- Returns:
- the list of String values from this node
- Since:
- 2.3.0
 
 - 
printpublic void print(PrintWriter out) Writes the node to the specifiedPrintWriter.- Parameters:
- out- the writer receiving the output
 
 - 
toIntegerpublic Integer toInteger() Converts the text of this GPathResult to a Integer object.- Returns:
- the GPathResult, converted to a Integer
 
 - 
toLongpublic Long toLong() Converts the text of this GPathResult to a Long object.- Returns:
- the GPathResult, converted to a Long
 
 - 
toFloatpublic Float toFloat() Converts the text of this GPathResult to a Float object.- Returns:
- the GPathResult, converted to a Float
 
 - 
toDoublepublic Double toDouble() Converts the text of this GPathResult to a Double object.- Returns:
- the GPathResult, converted to a Double
 
 - 
toBigDecimalpublic BigDecimal toBigDecimal() Converts the text of this GPathResult to a BigDecimal object.- Returns:
- the GPathResult, converted to a BigDecimal
 
 - 
toBigIntegerpublic BigInteger toBigInteger() Converts the text of this GPathResult to a BigInteger object.- Returns:
- the GPathResult, converted to a BigInteger
 
 
- 
 
-