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
Modifier and TypeMethodDescriptionvoid
addChild
(PlexusConfiguration configuration) Adds a configuration under this configuration, which acts as a parent.getAttribute
(String paramName) Returns the value of the named attribute.getAttribute
(String name, String defaultValue) Returns the value of the named attribute, or default if one cannot be found.String[]
Returns an array of attribute names.getChild
(int i) Returns the child configuration at the given location.Returns the child configuration of the given name.Returns the child configuration of the given name.int
Returns the number of directly children under this configuration.Returns an array of all child configurations.getChildren
(String name) Returns an array of all child configurations with the given name.getName()
Returns the name of this configuration.getValue()
Returns the value of this configuration.Returns the value of this configuration, or default if one cannot be found.
-
Method Details
-
getName
String getName()Returns the name of this configuration.- Returns:
- the name of this configuration
-
getValue
Returns the value of this configuration.- Returns:
- the value of this configuration
- Throws:
PlexusConfigurationException
-
getValue
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
-
getAttributeNames
String[] getAttributeNames()Returns an array of attribute names.- Returns:
- an array of attribute names
-
getAttribute
Returns the value of the named attribute.- Returns:
- the value of the named attribute
- Throws:
PlexusConfigurationException
-
getAttribute
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
-
getChild
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
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
Returns the child configuration of the given name.- Parameters:
child
- the name of the child to returncreateChild
- true if a new child should be create, if none found- Returns:
- the child configuration of the given name, or new child if created
-
getChildren
PlexusConfiguration[] getChildren()Returns an array of all child configurations.- Returns:
- an array of all child configurations
-
getChildren
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
-
addChild
Adds a configuration under this configuration, which acts as a parent.- Parameters:
configuration
- the child configuration to add
-
getChildCount
int getChildCount()Returns the number of directly children under this configuration.- Returns:
- the number of directly children under this configuration.
-