de.smartics.ci.config.load
Class LoaderPlan

java.lang.Object
  de.smartics.ci.config.load.LoaderPlan

All Implemented Interfaces:

Iterable< String>

public final class LoaderPlan
     
     

      
      extends 
      
      Object
     
     
     
     

      
      implements 
      
      Iterable<
      
      String>
     
     

Allows to iterate over configurations.

Constructor Summary

LoaderPlan(String id, MavenConfig mavenConfig)
Default constructor.

Method Summary

void	addConfigurationName(String configurationName) Adds a configuration name to the loader plan.
boolean	equals(Object object) Returns true if the given object is semantically equal to the given object, false otherwise.
String	getId() Returns the identifier of the loader plan.
MavenConfig	getMavenConfig() Returns the information from the Maven project configuration.
int	hashCode() Returns the hash code of the object.
boolean	isEmpty() Checks if the loader plan contains at least on name.
Iterator<String>	iterator()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LoaderPlan

public LoaderPlan(String id,
                  MavenConfig mavenConfig)
           throws de.smartics.util.lang.BlankArgumentException,
                  de.smartics.util.lang.NullArgumentException

Default constructor.

Parameters:

id - the identifier of the loader plan.

mavenConfig - the information from the Maven project configuration.

Throws:

de.smartics.util.lang.BlankArgumentException - if id is blank.

de.smartics.util.lang.NullArgumentException - if mavenConfig is null.

Method Detail

getId

public String getId()

Returns the identifier of the loader plan.

Returns:

the identifier of the loader plan.

getMavenConfig

public MavenConfig getMavenConfig()

Returns the information from the Maven project configuration.

Returns:

the information from the Maven project configuration.

addConfigurationName

public void addConfigurationName(String configurationName)
                          throws de.smartics.util.lang.BlankArgumentException

Adds a configuration name to the loader plan.

Parameters:

configurationName - the name to add.

Throws:

de.smartics.util.lang.BlankArgumentException - if configurationName is blank.

iterator

public Iterator<String> iterator()

Specified by:

iterator in interface Iterable<String>

See Also:

Iterable.iterator()

isEmpty

public boolean isEmpty()

Checks if the loader plan contains at least on name.

Returns:

false if the loader plan contains at least one name, true if it is empty.

hashCode

public int hashCode()

Returns the hash code of the object.

Overrides:

hashCode in class Object

Returns:

the hash code.

equals

public boolean equals(Object object)

Returns true if the given object is semantically equal to the given object, false otherwise.

The Maven configuration is not a part of the check.

Overrides:

equals in class Object

Parameters:

object - the instance to compare to.

Returns:

true if the given object is semantically equal to the given object, false otherwise.

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()