org.rhq.augeas.node
Interface AugeasNode

All Known Implementing Classes:

AugeasNodeLazy, AugeasNodeReal, AugeasRootNode

public interface AugeasNode

Node is a part of the AugeasTree.

Author:

Filip Drabek

Method Summary

void	addChildNode(AugeasNode node)
boolean	equals(Object obj)
List<AugeasNode>	getChildByLabel(String labelName)
List<AugeasNode>	getChildNodes()
String	getFullPath()
String	getLabel()
AugeasNode	getParentNode()
String	getPath()
int	getSeq()
String	getValue()
void	remove(boolean updateSeq) Removes the node from its parent children optionally updating the sequence numbers of the sibling nodes with the same label.
void	setLabel(String label)
void	setPath(String path)
void	setSeq(int seq)
void	setValue(String value)
void	updateFromParent() Updates the settings of this node according to the data in the parent.

Method Detail

getPath

String getPath()

Returns:

returns the path to the node in the Augeas tree, excluding the node itself.

setPath

void setPath(String path)
             throws AugeasTreeException

Throws:

AugeasTreeException

getLabel

String getLabel()

Returns:

the label of the node

setLabel

void setLabel(String label)

getValue

String getValue()

Returns:

the value of the node

setValue

void setValue(String value)

getSeq

int getSeq()

Returns:

the sequence number of the node (i.e. Variable[6] in the augeas notation).

setSeq

void setSeq(int seq)

getParentNode

AugeasNode getParentNode()

Returns:

the parent node in the tree

getChildNodes

List<AugeasNode> getChildNodes()

Returns:

the child nodes in the tree

equals

boolean equals(Object obj)

Overrides:

equals in class Object

getFullPath

String getFullPath()

Returns:

the full path of the node including its label and sequence number

addChildNode

void addChildNode(AugeasNode node)

getChildByLabel

List<AugeasNode> getChildByLabel(String labelName)

remove

void remove(boolean updateSeq)
            throws AugeasTreeException

Removes the node from its parent children optionally updating the sequence numbers of the sibling nodes with the same label.

Parameters:

updateSeq - whether to update the siblings' sequence numbers

Throws:

AugeasTreeException

updateFromParent

void updateFromParent()

Updates the settings of this node according to the data in the parent. This method should work recursively.