PluginDescriptor (Maven Plugin API 3.0.5 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.maven.plugin.descriptor.model
Class PluginDescriptor

java.lang.Object
  org.apache.maven.plugin.descriptor.model.PluginDescriptor

All Implemented Interfaces:: Serializable

public class PluginDescriptor
extends Object
implements Serializable
extends Object
implements Serializable

Root element of the plugin.xml file.

Version:: $Revision$ $Date$
See Also:: Serialized Form

Constructor Summary
`PluginDescriptor()`

Method Summary
`void`	`addDependency(Dependency dependency)` Method addDependency.
`void`	`addMojo(MojoDescriptor mojoDescriptor)` Method addMojo.
`String`	`getArtifactId()` Get the artifact id of the plugin.
`List<Dependency>`	`getDependencies()` Method getDependencies.
`String`	`getDescription()` Get description of the plugin.
`String`	`getGoalPrefix()` Get the goalPrefix field.
`String`	`getGroupId()` Get the group id of the plugin.
`String`	`getModelEncoding()` Get the modelEncoding field.
`List<MojoDescriptor>`	`getMojos()` Method getMojos.
`String`	`getVersion()` Get the version of the plugin.
`boolean`	`isInheritedByDefault()` Get the inheritedByDefault field.
`boolean`	`isIsolatedRealm()` Get the isolatedRealm field.
`void`	`removeDependency(Dependency dependency)` Method removeDependency.
`void`	`removeMojo(MojoDescriptor mojoDescriptor)` Method removeMojo.
`void`	`setArtifactId(String artifactId)` Set the artifact id of the plugin.
`void`	`setDependencies(List<Dependency> dependencies)` Set a set of dependencies which the plugin requires in order to function.
`void`	`setDescription(String description)` Set description of the plugin.
`void`	`setGoalPrefix(String goalPrefix)` Set the goalPrefix field.
`void`	`setGroupId(String groupId)` Set the group id of the plugin.
`void`	`setInheritedByDefault(boolean inheritedByDefault)` Set the inheritedByDefault field.
`void`	`setIsolatedRealm(boolean isolatedRealm)` Set the isolatedRealm field.
`void`	`setModelEncoding(String modelEncoding)` Set the modelEncoding field.
`void`	`setMojos(List<MojoDescriptor> mojos)` Set description of each Mojo provided by the plugin.
`void`	`setVersion(String version)` Set the version of the plugin.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

PluginDescriptor

public PluginDescriptor()

Method Detail

addDependency

public void addDependency(Dependency dependency)

Method addDependency.

Parameters:: dependency -

addMojo

public void addMojo(MojoDescriptor mojoDescriptor)

Method addMojo.

Parameters:: mojoDescriptor -

getArtifactId

public String getArtifactId()

Get the artifact id of the plugin.

Returns:: String

getDependencies

public List<Dependency> getDependencies()

Method getDependencies.

Returns:: List

getDescription

public String getDescription()

Get description of the plugin.

Returns:: String

getGoalPrefix

public String getGoalPrefix()

Get the goalPrefix field.

Returns:: String

getGroupId

public String getGroupId()

Get the group id of the plugin.

Returns:: String

getModelEncoding

public String getModelEncoding()

Get the modelEncoding field.

Returns:: String

getMojos

public List<MojoDescriptor> getMojos()

Method getMojos.

Returns:: List

getVersion

public String getVersion()

Get the version of the plugin.

Returns:: String

isInheritedByDefault

public boolean isInheritedByDefault()

Get the inheritedByDefault field.

Returns:: boolean

isIsolatedRealm

public boolean isIsolatedRealm()

Get the isolatedRealm field.

Returns:: boolean

removeDependency

public void removeDependency(Dependency dependency)

Method removeDependency.

Parameters:: dependency -

removeMojo

public void removeMojo(MojoDescriptor mojoDescriptor)

Method removeMojo.

Parameters:: mojoDescriptor -

setArtifactId

public void setArtifactId(String artifactId)

Set the artifact id of the plugin.

Parameters:: artifactId -

setDependencies

public void setDependencies(List<Dependency> dependencies)

Set a set of dependencies which the plugin requires in order to function. This enables the plugin to function independently of its POM (or at least to declare the libraries it needs to run).

Parameters:: dependencies -

setDescription

public void setDescription(String description)

Set description of the plugin.

Parameters:: description -

setGoalPrefix

public void setGoalPrefix(String goalPrefix)

Set the goalPrefix field.

Parameters:: goalPrefix -

setGroupId

public void setGroupId(String groupId)

Set the group id of the plugin.

Parameters:: groupId -

setInheritedByDefault

public void setInheritedByDefault(boolean inheritedByDefault)

Set the inheritedByDefault field.

Parameters:: inheritedByDefault -

setIsolatedRealm

public void setIsolatedRealm(boolean isolatedRealm)

Set the isolatedRealm field.

Parameters:: isolatedRealm -

setModelEncoding

public void setModelEncoding(String modelEncoding)

Set the modelEncoding field.

Parameters:: modelEncoding -

setMojos

public void setMojos(List<MojoDescriptor> mojos)

Set description of each Mojo provided by the plugin.

Parameters:: mojos -

setVersion

public void setVersion(String version)

Set the version of the plugin.

Parameters:: version -