Forge - Maven API 2.0.0.Alpha3

org.jboss.forge.maven.plugins
Class ConfigurationBuilder

java.lang.Object
  extended by org.jboss.forge.maven.plugins.ConfigurationBuilder
All Implemented Interfaces:
Configuration, PluginElement

public class ConfigurationBuilder
extends Object
implements Configuration

Builds a Configuration object

Author:
Paul Bakker

Method Summary
 Configuration addConfigurationElement(ConfigurationElement element)
          Add a ConfigurationElement to this Configuration.
static ConfigurationBuilder create()
           
static ConfigurationBuilder create(Configuration existingConfig, MavenPluginBuilder pluginBuilder)
           
static ConfigurationBuilder create(MavenPluginBuilder pluginBuilder)
           
 ConfigurationElementBuilder createConfigurationElement(String name)
           
 ConfigurationElement getConfigurationElement(String element)
          Get the specified ConfigurationElement, if it exists; otherwise, return null.
 MavenPluginBuilder getOrigin()
           
 boolean hasConfigurationElement(String configElement)
          Return true if this Configuration contains the given element; otherwise, return false;
 boolean hasConfigurationElements()
          Return true if this Configuration has any elements; otherwise, return false.
 List<ConfigurationElement> listConfigurationElements()
          List all ConfigurationElements contained in this Configuration.
 void removeConfigurationElement(String elementName)
          Remove the specified ConfigurationElement.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getConfigurationElement

public ConfigurationElement getConfigurationElement(String element)
Description copied from interface: Configuration
Get the specified ConfigurationElement, if it exists; otherwise, return null.

Specified by:
getConfigurationElement in interface Configuration

hasConfigurationElement

public boolean hasConfigurationElement(String configElement)
Description copied from interface: Configuration
Return true if this Configuration contains the given element; otherwise, return false;

Specified by:
hasConfigurationElement in interface Configuration

hasConfigurationElements

public boolean hasConfigurationElements()
Description copied from interface: Configuration
Return true if this Configuration has any elements; otherwise, return false.

Specified by:
hasConfigurationElements in interface Configuration

listConfigurationElements

public List<ConfigurationElement> listConfigurationElements()
Description copied from interface: Configuration
List all ConfigurationElements contained in this Configuration. Returns an empty list if none exist.

Specified by:
listConfigurationElements in interface Configuration

addConfigurationElement

public Configuration addConfigurationElement(ConfigurationElement element)
Description copied from interface: Configuration
Add a ConfigurationElement to this Configuration.

Specified by:
addConfigurationElement in interface Configuration

removeConfigurationElement

public void removeConfigurationElement(String elementName)
Description copied from interface: Configuration
Remove the specified ConfigurationElement.

Specified by:
removeConfigurationElement in interface Configuration

toString

public String toString()
Overrides:
toString in class Object

createConfigurationElement

public ConfigurationElementBuilder createConfigurationElement(String name)

create

public static ConfigurationBuilder create()

create

public static ConfigurationBuilder create(MavenPluginBuilder pluginBuilder)

create

public static ConfigurationBuilder create(Configuration existingConfig,
                                          MavenPluginBuilder pluginBuilder)

getOrigin

public MavenPluginBuilder getOrigin()

Forge - Maven API 2.0.0.Alpha3

Copyright © 2013 JBoss by Red Hat. All Rights Reserved.