org.gradle.gradleplugin.foundation.settings

Class DOM4JSettingsNode

java.lang.Object

org.gradle.gradleplugin.foundation.settings.DOM4JSettingsNode

All Implemented Interfaces:

SettingsNode

public class DOM4JSettingsNode
extends Object
implements SettingsNode

An implementation of SettingsNode that uses DOM4J nodes as its actual storage medium.

Author:

mhunsicker

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME_ATTRIBUTE
static String	TAG_NAME
static String	VALUE_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
DOM4JSettingsNode(org.dom4j.Element element)

Method Summary

Methods

Modifier and Type	Method and Description
SettingsNode	addChild(String name) Call this to add a child node to this node.
SettingsNode	addChildIfNotPresent(String name) This adds a child node with the specified name or returns the existing child node if one already exists with said name.
boolean	equals(Object obj)
SettingsNode	getChildNode(String name) Returns the child node with the specified name.
List<SettingsNode>	getChildNodes()
List<SettingsNode>	getChildNodes(String name)
org.dom4j.Element	getElement()
String	getName()
SettingsNode	getNodeAtPath(String... pathPortions) Returns a node at the specified path starting at 'this' node.
String	getValue()
String	getValueOfChild(String name, String defaultValue) Gets the value of the child node.
boolean	getValueOfChildAsBoolean(String name, boolean defaultValue)
int	getValueOfChildAsInt(String name, int defaultValue) Gets the value of the child node as an integer.
long	getValueOfChildAsLong(String name, long defaultValue)
int	hashCode()
void	removeAllChildren() Deletes all the children of this node.
void	removeFromParent() Removes this node from its parent.
void	setName(String name) Sets the name of this node.
void	setValue(String value) Sets the value of this node.
void	setValueOfChild(String name, String value) Sets the value of the child node, adding it if it is not already present.
void	setValueOfChildAsBoolean(String name, boolean value)
void	setValueOfChildAsInt(String name, int value) Sets the value of the child node as an integer, adding it if it is not already present.
void	setValueOfChildAsLong(String name, long value)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TAG_NAME

public static final String TAG_NAME

See Also:

Constant Field Values

NAME_ATTRIBUTE

public static final String NAME_ATTRIBUTE

See Also:

Constant Field Values

VALUE_ATTRIBUTE

public static final String VALUE_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

DOM4JSettingsNode

public DOM4JSettingsNode(org.dom4j.Element element)

Method Detail

getElement

public org.dom4j.Element getElement()

setName

public void setName(String name)

Description copied from interface: SettingsNode

Sets the name of this node. This is used as its identifier.

Specified by:

setName in interface SettingsNode

Parameters:

name - the new name. Cannot be null!

getName

public String getName()

Specified by:

getName in interface SettingsNode

setValue

public void setValue(String value)

Description copied from interface: SettingsNode

Sets the value of this node. This is whatever you like, but is always internally text.

Specified by:

setValue in interface SettingsNode

Parameters:

value - the new value. Can be null.

getValue

public String getValue()

Specified by:

getValue in interface SettingsNode

setValueOfChild

public void setValueOfChild(String name,
                   String value)

Description copied from interface: SettingsNode

Sets the value of the child node, adding it if it is not already present. This is a convenience function providing more java preferences-like behavior.

Specified by:

setValueOfChild in interface SettingsNode

Parameters:

name - the name of the child node.

value - the new value.

getValueOfChild

public String getValueOfChild(String name,
                     String defaultValue)

Description copied from interface: SettingsNode

Gets the value of the child node. If it is not present, the defaultValue is returned. This is a convenience function providing more java preferences-like behavior.

Specified by:

getValueOfChild in interface SettingsNode

Parameters:

name - the name of the child node.

defaultValue - the value to return if the child node is not present

Returns:

the value.

getChildNode

public SettingsNode getChildNode(String name)

Description copied from interface: SettingsNode

Returns the child node with the specified name.

Specified by:

getChildNode in interface SettingsNode

Parameters:

name - the name of the sought node

Returns:

the child settings node or null if no match found.

getChildNodes

public List<SettingsNode> getChildNodes()

Specified by:

getChildNodes in interface SettingsNode

Returns:

a list of all child nodes of this node.

getChildNodes

public List<SettingsNode> getChildNodes(String name)

Specified by:

getChildNodes in interface SettingsNode

Parameters:

name - the names of the sought child nodes.

Returns:

a list of all child nodes of this node that have the specified name. If none are found, this should return an empty list. Never null.

getValueOfChildAsInt

public int getValueOfChildAsInt(String name,
                       int defaultValue)

Description copied from interface: SettingsNode

Gets the value of the child node as an integer. If it is not present or the value is cannot be interpretted as an integer, the defaultValue is returned. This is a convenience function providing more java preferences-like behavior.

Specified by:

getValueOfChildAsInt in interface SettingsNode

Parameters:

name - the name of the child node.

defaultValue - the value to return if the child node is not present or cannot be interpretted as an integer.

Returns:

the value.

setValueOfChildAsInt

public void setValueOfChildAsInt(String name,
                        int value)

Description copied from interface: SettingsNode

Sets the value of the child node as an integer, adding it if it is not already present. This is a convenience function providing more java preferences-like behavior.

Specified by:

setValueOfChildAsInt in interface SettingsNode

Parameters:

name - the name of the child node.

value - the new value.

getValueOfChildAsLong

public long getValueOfChildAsLong(String name,
                         long defaultValue)

Specified by:

getValueOfChildAsLong in interface SettingsNode

setValueOfChildAsLong

public void setValueOfChildAsLong(String name,
                         long value)

Specified by:

setValueOfChildAsLong in interface SettingsNode

getValueOfChildAsBoolean

public boolean getValueOfChildAsBoolean(String name,
                               boolean defaultValue)

Specified by:

getValueOfChildAsBoolean in interface SettingsNode

setValueOfChildAsBoolean

public void setValueOfChildAsBoolean(String name,
                            boolean value)

Specified by:

setValueOfChildAsBoolean in interface SettingsNode

addChild

public SettingsNode addChild(String name)

Description copied from interface: SettingsNode

Call this to add a child node to this node.

Specified by:

addChild in interface SettingsNode

Parameters:

name - the name of the node

Returns:

the child settings node.

addChildIfNotPresent

public SettingsNode addChildIfNotPresent(String name)

Description copied from interface: SettingsNode

This adds a child node with the specified name or returns the existing child node if one already exists with said name.

Specified by:

addChildIfNotPresent in interface SettingsNode

Parameters:

name - the name.

Returns:

the child settings node. Never null.

getNodeAtPath

public SettingsNode getNodeAtPath(String... pathPortions)

Description copied from interface: SettingsNode

Returns a node at the specified path starting at 'this' node.

Specified by:

getNodeAtPath in interface SettingsNode

Parameters:

pathPortions - an array of 'names' of the nodes. The first item corresponds to a direct child of this node. The second item would be the grand child of this node. etc. etc.

Returns:

a node if it exists. Null if not.

removeFromParent

public void removeFromParent()

Description copied from interface: SettingsNode

Removes this node from its parent.

Specified by:

removeFromParent in interface SettingsNode

removeAllChildren

public void removeAllChildren()

Description copied from interface: SettingsNode

Deletes all the children of this node.

Specified by:

removeAllChildren in interface SettingsNode

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object