org.apache.maven.model
Class Plugin

java.lang.Object
  org.apache.maven.model.ConfigurationContainer
      org.apache.maven.model.Plugin

All Implemented Interfaces:

Serializable

public class Plugin
extends ConfigurationContainer
implements Serializable

The <plugin> element contains informations required for a plugin.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Plugin()

Method Summary

void	addDependency(Dependency dependency) Method addDependency.
void	addExecution(PluginExecution pluginExecution) Method addExecution.
static String	constructKey(String groupId, String artifactId)
boolean	equals(Object other)
void	flushExecutionMap() Reset the executionMap field to null
String	getArtifactId() Get the artifact ID of the plugin in the repository.
List	getDependencies() Method getDependencies.
List	getExecutions() Method getExecutions.
Map	getExecutionsAsMap()
Object	getGoals() Get Deprecated.
String	getGroupId() Get the group ID of the plugin in the repository.
String	getKey()
String	getModelEncoding()
String	getVersion() Get the version (or valid range of versions) of the plugin to be used.
int	hashCode()
boolean	isExtensions() Get whether to load Maven extensions (such as packaging and type handlers) from this plugin.
void	removeDependency(Dependency dependency) Method removeDependency.
void	removeExecution(PluginExecution pluginExecution) Method removeExecution.
void	setArtifactId(String artifactId) Set the artifact ID of the plugin in the repository.
void	setDependencies(List dependencies) Set additional dependencies that this project needs to introduce to the plugin's classloader.
void	setExecutions(List executions) Set multiple specifications of a set of goals to execute during the build lifecycle, each having (possibly) a different configuration.
void	setExtensions(boolean extensions) Set whether to load Maven extensions (such as packaging and type handlers) from this plugin.
void	setGoals(Object goals) Set Deprecated.
void	setGroupId(String groupId) Set the group ID of the plugin in the repository.
void	setModelEncoding(String modelEncoding) Set an encoding used for reading/writing the model.
void	setVersion(String version) Set the version (or valid range of versions) of the plugin to be used.
String	toString()

Methods inherited from class org.apache.maven.model.ConfigurationContainer

getConfiguration, getInherited, isInheritanceApplied, setConfiguration, setInherited, unsetInheritanceApplied

Methods inherited from class java.lang.Object

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

Constructor Detail

Plugin

public Plugin()

Method Detail

addDependency

public void addDependency(Dependency dependency)

Method addDependency.

Parameters:

dependency -

addExecution

public void addExecution(PluginExecution pluginExecution)

Method addExecution.

Parameters:

pluginExecution -

getArtifactId

public String getArtifactId()

Get the artifact ID of the plugin in the repository.

Returns:

String

getDependencies

public List getDependencies()

Method getDependencies.

Returns:

java.util.List

getExecutions

public List getExecutions()

Method getExecutions.

Returns:

java.util.List

getGoals

public Object getGoals()

Get Deprecated. Unused by Maven.

Returns:

Object

getGroupId

public String getGroupId()

Get the group ID of the plugin in the repository.

Returns:

String

getVersion

public String getVersion()

Get the version (or valid range of versions) of the plugin to be used.

Returns:

String

isExtensions

public boolean isExtensions()

Get whether to load Maven extensions (such as packaging and type handlers) from this plugin. For performance reasons, this should only be enabled when necessary.

Returns:

boolean

removeDependency

public void removeDependency(Dependency dependency)

Method removeDependency.

Parameters:

dependency -

removeExecution

public void removeExecution(PluginExecution pluginExecution)

Method removeExecution.

Parameters:

pluginExecution -

setArtifactId

public void setArtifactId(String artifactId)

Set the artifact ID of the plugin in the repository.

Parameters:

artifactId -

setDependencies

public void setDependencies(List dependencies)

Set additional dependencies that this project needs to introduce to the plugin's classloader.

Parameters:

dependencies -

setExecutions

public void setExecutions(List executions)

Set multiple specifications of a set of goals to execute during the build lifecycle, each having (possibly) a different configuration.

Parameters:

executions -

setExtensions

public void setExtensions(boolean extensions)

Set whether to load Maven extensions (such as packaging and type handlers) from this plugin. For performance reasons, this should only be enabled when necessary.

Parameters:

extensions -

setGoals

public void setGoals(Object goals)

Set Deprecated. Unused by Maven.

Parameters:

goals -

setGroupId

public void setGroupId(String groupId)

Set the group ID of the plugin in the repository.

Parameters:

groupId -

setVersion

public void setVersion(String version)

Set the version (or valid range of versions) of the plugin to be used.

Parameters:

version -

flushExecutionMap

public void flushExecutionMap()

Reset the executionMap field to null

getExecutionsAsMap

public Map getExecutionsAsMap()

Returns:

a Map of executions field with PluginExecution#getId() as key

See Also:

PluginExecution.getId()

getKey

public String getKey()

Returns:

the key of the plugin, ie groupId:artifactId

constructKey

public static String constructKey(String groupId,
                                  String artifactId)

Parameters:

groupId -

artifactId -

Returns:

the key of the plugin, ie groupId:artifactId

equals

public boolean equals(Object other)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

setModelEncoding

public void setModelEncoding(String modelEncoding)

Set an encoding used for reading/writing the model.

Overrides:

setModelEncoding in class ConfigurationContainer

Parameters:

modelEncoding - the encoding used when reading/writing the model.

getModelEncoding

public String getModelEncoding()

Overrides:

getModelEncoding in class ConfigurationContainer

Returns:

the current encoding used when reading/writing this model.