org.springframework.roo.project

Class Execution

java.lang.Object

org.springframework.roo.project.Execution

All Implemented Interfaces:

Comparable<Execution>

public class Execution
extends Object
implements Comparable<Execution>

Immutable representation of an execution specification for a (Maven) build plugin

Since:

1.0

Author:

Adrian Colyer, Alan Stewart, Andrew Swan

Constructor Summary

Constructors

Constructor and Description
Execution(String id, String phase, Configuration configuration, String... goals) Constructor
Execution(String id, String phase, String... goals) Constructor for no execution-level Configuration

Method Summary

Modifier and Type	Method and Description
int	compareTo(Execution other)
boolean	equals(Object obj)
Configuration	getConfiguration() Returns this execution's configuration, if any; this is separate from any configuration defined at the plugin level
Element	getElement(Document document) Returns the XML element for this execution within the given Maven POM
List<String>	getGoals() Returns the goals this execution will execute
String	getId() Returns the unique ID of this execution
String	getPhase() Returns the Maven lifecycle phase to which this execution is bound
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Execution

public Execution(String id,
                 String phase,
                 Configuration configuration,
                 String... goals)

Constructor

Parameters:

id - the unique ID of this execution (required)

phase - the Maven life-cycle phase to which this execution is bound (required)

configuration - the execution-level configuration; can be null

goals - the goals to execute (must be at least one)

Since:

1.2.0

Execution

public Execution(String id,
                 String phase,
                 String... goals)

Constructor for no execution-level Configuration

Parameters:

id - the unique ID of this execution (required)

phase - the Maven life-cycle phase to which this execution is bound (required)

goals - the goals to execute (must be at least one)

Method Detail

compareTo

public int compareTo(Execution other)

Specified by:

compareTo in interface Comparable<Execution>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getConfiguration

public Configuration getConfiguration()

Returns this execution's configuration, if any; this is separate from any configuration defined at the plugin level

Returns:

null if there is none

Since:

1.2.0

getElement

public Element getElement(Document document)

Returns the XML element for this execution within the given Maven POM

Parameters:

document - the Maven POM to which to add the element (required)

Returns:

a non-null element

getGoals

public List<String> getGoals()

Returns the goals this execution will execute

Returns:

a non-empty list

getId

public String getId()

Returns the unique ID of this execution

Returns:

a non-blank ID

getPhase

public String getPhase()

Returns the Maven lifecycle phase to which this execution is bound

Returns:

a non-blank phase name

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object