org.jboss.forge.addon.maven.plugins

Interface ConfigurationElement

All Superinterfaces:

PluginElement

All Known Implementing Classes:

ConfigurationElementBuilder, ConfigurationElementImpl

public interface ConfigurationElement
extends PluginElement

Author:

Paul Bakker

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	getAttributes() Returns an immutable map of the element attributes
ConfigurationElement	getChildByContent(String content) Returns the child element that contains the given content.
ConfigurationElement	getChildByContent(String content, boolean directChildsOnly) Returns the child element that contains the given content.
ConfigurationElement	getChildByName(String name) Checks if the child element that has the given name exists.
ConfigurationElement	getChildByName(String name, boolean directChildsOnly) Returns the child element that has the given name exists.
List<PluginElement>	getChildren()
String	getName()
String	getText()
boolean	hasChildByContent(String content) Checks if a child element is present with the given content.
boolean	hasChildByContent(String content, boolean directChildsOnly) Checks if a child element is present with the given content.
boolean	hasChildByName(String name) Checks if the child element that has the given name exists.
boolean	hasChildByName(String name, boolean directChildsOnly) Checks if the child element that has the given name exists.
boolean	hasChildren()
boolean	isPlugin()

Method Detail

getName

String getName()

isPlugin

boolean isPlugin()

hasChildren

boolean hasChildren()

getText

String getText()

getAttributes

Map<String,String> getAttributes()

Returns an immutable map of the element attributes

getChildren

List<PluginElement> getChildren()

hasChildByContent

boolean hasChildByContent(String content,
                        boolean directChildsOnly)

Checks if a child element is present with the given content.

Parameters:

content - The content to filter on.

directChildsOnly - True if only direct elements should be matched

Returns:

True if an element was found containing the given content

hasChildByContent

boolean hasChildByContent(String content)

Checks if a child element is present with the given content. Also search indirect child elements.

Parameters:

content - The content to filter on.

Returns:

True if an element was found containing the given content

See Also:

hasChildByContent(String, boolean)

getChildByContent

ConfigurationElement getChildByContent(String content,
                                     boolean directChildsOnly)

Returns the child element that contains the given content.

Parameters:

content - The content to filter on.

directChildsOnly - True if only direct elements should be matched

Returns:

The element found, or raises an ConfigurationElementNotFoundException if the element was not found.

getChildByContent

ConfigurationElement getChildByContent(String content)

Returns the child element that contains the given content. Also search indirect child elements.

Parameters:

content - The content to filter on.

Returns:

The element found, or raises an ConfigurationElementNotFoundException if the element was not found.

See Also:

getChildByContent(String, boolean)

hasChildByName

boolean hasChildByName(String name,
                     boolean directChildsOnly)

Checks if the child element that has the given name exists.

Parameters:

name - The element name to filter on.

directChildsOnly - True if only direct elements should be matched

Returns:

The element found, or raises an ConfigurationElementNotFoundException if the element was not found.

hasChildByName

boolean hasChildByName(String name)

Checks if the child element that has the given name exists. Also search indirect child elements.

Parameters:

name - The element name to filter on.

Returns:

The element found, or raises an ConfigurationElementNotFoundException if the element was not found.

getChildByName

ConfigurationElement getChildByName(String name,
                                  boolean directChildsOnly)

Returns the child element that has the given name exists.

Parameters:

name - The element name to filter on.

directChildsOnly - True if only direct elements should be matched

Returns:

The element found, or raises an ConfigurationElementNotFoundException if the element was not found.

getChildByName

ConfigurationElement getChildByName(String name)

Checks if the child element that has the given name exists. Also search indirect child elements.

Parameters:

name - The element name to filter on.

Returns:

The element found, or raises an ConfigurationElementNotFoundException if the element was not found.