org.springframework.roo.project

Class Plugin

java.lang.Object

org.springframework.roo.project.Plugin

All Implemented Interfaces:

Comparable<Plugin>

public class Plugin
extends Object
implements Comparable<Plugin>

Simplified immutable representation of a maven build plugin.

Structured after the model used by Maven.

Since:

1.1

Author:

Alan Stewart

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_GROUP_ID The Maven groupId that will be assigned to a plugin if one is not provided

Constructor Summary

Constructors

Constructor and Description
Plugin(Element plugin) Constructor from a POM-style XML element that defines a Maven .
Plugin(String groupId, String artifactId, String version) Constructor that takes the minimal Maven artifact coordinates.
Plugin(String groupId, String artifactId, String version, Configuration configuration, Collection<? extends Dependency> dependencies, Collection<? extends Execution> executions) Constructor that allows all fields to be set.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Plugin o)
boolean	equals(Object obj)
String	getArtifactId()
Configuration	getConfiguration() Returns the top-level configuration of this plugin, if any.
List<Dependency>	getDependencies()
Element	getElement(Document document) Returns the Element to add to the given POM Document for this plugin
List<Execution>	getExecutions()
GAV	getGAV() Returns the Maven-style coordinates of this plugin
String	getGroupId() Returns this plugin's groupId.
static String	getGroupId(Element plugin) Parses the plugin's Maven groupId from the given element
String	getSimpleDescription()
String	getVersion()
int	hashCode()
boolean	hasSameCoordinates(Plugin dependency) Indicates whether the given Plugin has the same Maven coordinates as this one; this is not necessarily the same as calling equals(Object), which may compare more fields beyond the basic coordinates.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_GROUP_ID

public static final String DEFAULT_GROUP_ID

The Maven groupId that will be assigned to a plugin if one is not provided

See Also:

Constant Field Values

Constructor Detail

Plugin

public Plugin(Element plugin)

Constructor from a POM-style XML element that defines a Maven .

Parameters:

plugin - the XML element to parse (required)

Plugin

public Plugin(String groupId,
              String artifactId,
              String version)

Constructor that takes the minimal Maven artifact coordinates.

Parameters:

groupId - the group ID (required)

artifactId - the artifact ID (required)

version - the version (required)

Plugin

public Plugin(String groupId,
              String artifactId,
              String version,
              Configuration configuration,
              Collection<? extends Dependency> dependencies,
              Collection<? extends Execution> executions)

Constructor that allows all fields to be set.

Parameters:

groupId - the group ID (required)

artifactId - the artifact ID (required)

version - the version (required)

configuration - the configuration for this plugin (optional)

dependencies - the dependencies for this plugin (can be null)

executions - the executions for this plugin (can be null)

Method Detail

getGroupId

public static String getGroupId(Element plugin)

Parses the plugin's Maven groupId from the given element

Parameters:

plugin - the element to parse (required)

Returns:

a non-blank groupId

compareTo

public int compareTo(Plugin o)

Specified by:

compareTo in interface Comparable<Plugin>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getArtifactId

public String getArtifactId()

getConfiguration

public Configuration getConfiguration()

Returns the top-level configuration of this plugin, if any. Note that individual Executions may have their own Configurations instead of or in addition to this configuration.

Returns:

null if none exists

getDependencies

public List<Dependency> getDependencies()

getElement

public Element getElement(Document document)

Returns the Element to add to the given POM Document for this plugin

Parameters:

plugin - the plugin for which to create an XML Element (required)

document - the document to which the element will belong (required)

Returns:

a non-null element

Since:

1.2.0

getExecutions

public List<Execution> getExecutions()

getGAV

public GAV getGAV()

Returns the Maven-style coordinates of this plugin

Returns:

a non-null set of coordinates

getGroupId

public String getGroupId()

Returns this plugin's groupId.

Returns:

getSimpleDescription

public String getSimpleDescription()

Returns:

a simple description, as would be used for console output

getVersion

public String getVersion()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

hasSameCoordinates

public boolean hasSameCoordinates(Plugin dependency)

Indicates whether the given Plugin has the same Maven coordinates as this one; this is not necessarily the same as calling equals(Object), which may compare more fields beyond the basic coordinates.

Parameters:

plugin - the plugin to check (can be null)

Returns:

false if any coordinates are different

toString

public String toString()

Overrides:

toString in class Object