org.apache.ambari.server.api.util

Interface TreeNode<T>

All Known Implementing Classes:

TreeNodeImpl

public interface TreeNode<T>

Tree where each node can have a name, properties and an associated object.

Method Summary

Modifier and Type	Method and Description
TreeNode<T>	addChild(TreeNode<T> child) Add the specified child node.
TreeNode<T>	addChild(T child, String name) Add a child node for the provided object.
TreeNode<T>	getChild(String name) Find a child node by name.
Collection<TreeNode<T>>	getChildren() Obtain the list of child nodes.
String	getName() Obtain the name of the node.
T	getObject() Obtain the object associated with this node.
TreeNode<T>	getParent() Obtain the parent node or null if this node is the root.
Object	getProperty(String name) Get the specified node property.
String	getStringProperty(String name) Get the specified node property as a String.
TreeNode<T>	removeChild(String name) Remove a child from this resource.
void	removeProperty(String name) Remove a property from the node.
void	setName(String name) Set the name of the node.
void	setParent(TreeNode<T> parent) Set the parent node.
void	setProperty(String name, Object value) Set a property on the node.

Method Detail

getParent

TreeNode<T> getParent()

Obtain the parent node or null if this node is the root.

Returns:

the parent node or null if this node is the root

getChildren

Collection<TreeNode<T>> getChildren()

Obtain the list of child nodes.

Returns:

a list of child nodes or an empty list if a leaf node

getObject

T getObject()

Obtain the object associated with this node.

Returns:

the object associated with this node or null

getName

String getName()

Obtain the name of the node.

Returns:

the name of the node or null

setName

void setName(String name)

Set the name of the node.

Parameters:

name - the name to set

setParent

void setParent(TreeNode<T> parent)

Set the parent node.

Parameters:

parent - the parent node to set

addChild

TreeNode<T> addChild(T child,
                     String name)

Add a child node for the provided object.

Parameters:

child - the object associated with the new child node

name - the name of the child node

Returns:

the newly created child node

addChild

TreeNode<T> addChild(TreeNode<T> child)

Add the specified child node.

Parameters:

child - the child node to add

Returns:

the added child node

removeChild

TreeNode<T> removeChild(String name)

Remove a child from this resource.

Parameters:

name - name of child to remove

Returns:

the previous value associated with key, or null if there was no mapping for key

setProperty

void setProperty(String name,
                 Object value)

Set a property on the node.

Parameters:

name - the name of the property

value - the value of the property

getProperty

Object getProperty(String name)

Get the specified node property.

Parameters:

name - property name

Returns:

the requested property value or null

getStringProperty

String getStringProperty(String name)

Get the specified node property as a String.

Parameters:

name - property name

Returns:

the requested property value (as a String) or null

removeProperty

void removeProperty(String name)

Remove a property from the node.

Parameters:

name - name of property to be removed

getChild

TreeNode<T> getChild(String name)

Find a child node by name. The name may contain '/' to delimit names to find a child more then one level deep. To find a node named 'bar' that is a child of a child named 'foo', use the name 'foo/bar'.

Parameters:

name - the name of the child. May contain the '/' path separator.

Returns:

the requested node or null if the child was not found