org.codehaus.plexus.configuration

Interface PlexusConfiguration

public interface PlexusConfiguration

A configuration data hierarchy for configuring aspects of plexus. For example, to populate a ComponentDescriptor. Implementation of PlexusConfiguration may be populated by any means, for example, by XML file.
Method Summary
voidaddChild(PlexusConfiguration configuration)
Adds a configuration under this configuration, which acts as a parent.
StringgetAttribute(String paramName)
Returns the value of the named attribute.
StringgetAttribute(String name, String defaultValue)
Returns the value of the named attribute, or default if one cannot be found.
String[]getAttributeNames()
Returns an array of attribute names.
PlexusConfigurationgetChild(String child)
Returns the child configuration of the given name.
PlexusConfigurationgetChild(int i)
Returns the child configuration at the given location.
PlexusConfigurationgetChild(String child, boolean createChild)
Returns the child configuration of the given name.
intgetChildCount()
Returns the number of directly children under this configuration.
PlexusConfiguration[]getChildren()
Returns an array of all child configurations.
PlexusConfiguration[]getChildren(String name)
Returns an array of all child configurations with the given name.
StringgetName()
Returns the name of this configuration.
StringgetValue()
Returns the value of this configuration.
StringgetValue(String defaultValue)
Returns the value of this configuration, or default if one cannot be found.

Method Detail

addChild

public void addChild(PlexusConfiguration configuration)
Adds a configuration under this configuration, which acts as a parent.

Parameters: configuration the child configuration to add

getAttribute

public String getAttribute(String paramName)
Returns the value of the named attribute.

Returns: the value of the named attribute

Throws: PlexusConfigurationException

getAttribute

public String getAttribute(String name, String defaultValue)
Returns the value of the named attribute, or default if one cannot be found.

Parameters: defaultValue value to return if none is found

Returns: the value of the named attribute

getAttributeNames

public String[] getAttributeNames()
Returns an array of attribute names.

Returns: an array of attribute names

getChild

public PlexusConfiguration getChild(String child)
Returns the child configuration of the given name.

Parameters: child the name of the child to return

Returns: the child configuration of the given name

getChild

public PlexusConfiguration getChild(int i)
Returns the child configuration at the given location.

Parameters: i the position of the child under this configuration

Returns: the child configuration at the given location

getChild

public PlexusConfiguration getChild(String child, boolean createChild)
Returns the child configuration of the given name.

Parameters: child the name of the child to return createChild true if a new child should be create, if none found

Returns: the child configuration of the given name, or new child if created

getChildCount

public int getChildCount()
Returns the number of directly children under this configuration.

Returns: the number of directly children under this configuration.

getChildren

public PlexusConfiguration[] getChildren()
Returns an array of all child configurations.

Returns: an array of all child configurations

getChildren

public PlexusConfiguration[] getChildren(String name)
Returns an array of all child configurations with the given name.

Parameters: name the name of the children configurations to return

Returns: an array of all child configurations with the given name

getName

public String getName()
Returns the name of this configuration.

Returns: the name of this configuration

getValue

public String getValue()
Returns the value of this configuration.

Returns: the value of this configuration

Throws: PlexusConfigurationException

getValue

public String getValue(String defaultValue)
Returns the value of this configuration, or default if one cannot be found.

Parameters: defaultValue value to return if none is found

Returns: the value of this configuration