Class PluginDescriptor
- java.lang.Object
-
- org.codehaus.plexus.component.repository.ComponentSetDescriptor
-
- org.apache.maven.plugin.descriptor.PluginDescriptor
-
- All Implemented Interfaces:
java.lang.Cloneable
public class PluginDescriptor extends org.codehaus.plexus.component.repository.ComponentSetDescriptor implements java.lang.Cloneable
- Author:
- Jason van Zyl
-
-
Constructor Summary
Constructors Constructor Description PluginDescriptor()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addMojo(MojoDescriptor mojoDescriptor)
PluginDescriptor
clone()
Creates a shallow copy of this plugin descriptor.static java.lang.String
constructPluginKey(java.lang.String groupId, java.lang.String artifactId, java.lang.String version)
boolean
equals(java.lang.Object object)
java.lang.String
getArtifactId()
java.util.Map<java.lang.String,org.apache.maven.artifact.Artifact>
getArtifactMap()
The map of artifacts accessible by the versionlessKey, i.e.java.util.List<org.apache.maven.artifact.Artifact>
getArtifacts()
Gets the artifacts that make up the plugin's class realm, excluding artifacts shadowed by the Maven core realm likemaven-project
.org.codehaus.plexus.classworlds.realm.ClassRealm
getClassRealm()
static java.lang.String
getDefaultPluginArtifactId(java.lang.String id)
static java.lang.String
getDefaultPluginGroupId()
java.lang.String
getDescription()
java.lang.String
getGoalPrefix()
static java.lang.String
getGoalPrefixFromArtifactId(java.lang.String artifactId)
Parse maven-...-plugin.java.lang.String
getGroupId()
java.lang.String
getId()
java.util.Set<org.apache.maven.artifact.Artifact>
getIntroducedDependencyArtifacts()
Lifecycle
getLifecycleMapping(java.lang.String lifecycleId)
MojoDescriptor
getMojo(java.lang.String goal)
java.util.List<MojoDescriptor>
getMojos()
java.lang.String
getName()
org.apache.maven.model.Plugin
getPlugin()
org.apache.maven.artifact.Artifact
getPluginArtifact()
java.lang.String
getPluginLookupKey()
java.lang.String
getRequiredMavenVersion()
Get required Maven version, as defined in plugin's pom.xml (not plugin.xml).java.lang.String
getSource()
java.lang.String
getVersion()
int
hashCode()
boolean
isInheritedByDefault()
void
setArtifactId(java.lang.String artifactId)
void
setArtifacts(java.util.List<org.apache.maven.artifact.Artifact> artifacts)
void
setClassRealm(org.codehaus.plexus.classworlds.realm.ClassRealm classRealm)
void
setDescription(java.lang.String description)
void
setGoalPrefix(java.lang.String goalPrefix)
void
setGroupId(java.lang.String groupId)
void
setInheritedByDefault(boolean inheritedByDefault)
void
setIntroducedDependencyArtifacts(java.util.Set<org.apache.maven.artifact.Artifact> introducedDependencyArtifacts)
void
setName(java.lang.String name)
void
setPlugin(org.apache.maven.model.Plugin plugin)
void
setPluginArtifact(org.apache.maven.artifact.Artifact pluginArtifact)
void
setRequiredMavenVersion(java.lang.String requiredMavenVersion)
Set required Maven version, as defined in plugin's pom.xml (not plugin.xml).void
setSource(java.lang.String source)
void
setVersion(java.lang.String version)
-
-
-
Method Detail
-
getMojos
public java.util.List<MojoDescriptor> getMojos()
-
addMojo
public void addMojo(MojoDescriptor mojoDescriptor) throws DuplicateMojoDescriptorException
- Throws:
DuplicateMojoDescriptorException
-
getGroupId
public java.lang.String getGroupId()
-
setGroupId
public void setGroupId(java.lang.String groupId)
-
getArtifactId
public java.lang.String getArtifactId()
-
setArtifactId
public void setArtifactId(java.lang.String artifactId)
-
constructPluginKey
public static java.lang.String constructPluginKey(java.lang.String groupId, java.lang.String artifactId, java.lang.String version)
-
getPluginLookupKey
public java.lang.String getPluginLookupKey()
-
getId
public java.lang.String getId()
-
getDefaultPluginArtifactId
public static java.lang.String getDefaultPluginArtifactId(java.lang.String id)
-
getDefaultPluginGroupId
public static java.lang.String getDefaultPluginGroupId()
-
getGoalPrefixFromArtifactId
public static java.lang.String getGoalPrefixFromArtifactId(java.lang.String artifactId)
Parse maven-...-plugin. TODO move to plugin-tools-api as a default only
-
getGoalPrefix
public java.lang.String getGoalPrefix()
-
setGoalPrefix
public void setGoalPrefix(java.lang.String goalPrefix)
-
setVersion
public void setVersion(java.lang.String version)
-
getVersion
public java.lang.String getVersion()
-
setSource
public void setSource(java.lang.String source)
-
getSource
public java.lang.String getSource()
-
isInheritedByDefault
public boolean isInheritedByDefault()
-
setInheritedByDefault
public void setInheritedByDefault(boolean inheritedByDefault)
-
getArtifacts
public java.util.List<org.apache.maven.artifact.Artifact> getArtifacts()
Gets the artifacts that make up the plugin's class realm, excluding artifacts shadowed by the Maven core realm likemaven-project
.- Returns:
- The plugin artifacts, never
null
.
-
setArtifacts
public void setArtifacts(java.util.List<org.apache.maven.artifact.Artifact> artifacts)
-
getArtifactMap
public java.util.Map<java.lang.String,org.apache.maven.artifact.Artifact> getArtifactMap()
The map of artifacts accessible by the versionlessKey, i.e. groupId:artifactId- Returns:
- a Map of artifacts, never
null
- See Also:
getArtifacts()
-
equals
public boolean equals(java.lang.Object object)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
getMojo
public MojoDescriptor getMojo(java.lang.String goal)
-
setClassRealm
public void setClassRealm(org.codehaus.plexus.classworlds.realm.ClassRealm classRealm)
-
getClassRealm
public org.codehaus.plexus.classworlds.realm.ClassRealm getClassRealm()
-
setIntroducedDependencyArtifacts
public void setIntroducedDependencyArtifacts(java.util.Set<org.apache.maven.artifact.Artifact> introducedDependencyArtifacts)
-
getIntroducedDependencyArtifacts
public java.util.Set<org.apache.maven.artifact.Artifact> getIntroducedDependencyArtifacts()
-
setName
public void setName(java.lang.String name)
-
getName
public java.lang.String getName()
-
setDescription
public void setDescription(java.lang.String description)
-
getDescription
public java.lang.String getDescription()
-
setRequiredMavenVersion
public void setRequiredMavenVersion(java.lang.String requiredMavenVersion)
Set required Maven version, as defined in plugin's pom.xml (not plugin.xml).- Parameters:
requiredMavenVersion
- Maven version required by the plugin- Since:
- 3.0.2
-
getRequiredMavenVersion
public java.lang.String getRequiredMavenVersion()
Get required Maven version, as defined in plugin's pom.xml (not plugin.xml).- Returns:
- the Maven version required by the plugin
- Since:
- 3.0.2
-
setPlugin
public void setPlugin(org.apache.maven.model.Plugin plugin)
-
getPlugin
public org.apache.maven.model.Plugin getPlugin()
-
getPluginArtifact
public org.apache.maven.artifact.Artifact getPluginArtifact()
-
setPluginArtifact
public void setPluginArtifact(org.apache.maven.artifact.Artifact pluginArtifact)
-
getLifecycleMapping
public Lifecycle getLifecycleMapping(java.lang.String lifecycleId) throws java.io.IOException, org.codehaus.plexus.util.xml.pull.XmlPullParserException
- Throws:
java.io.IOException
org.codehaus.plexus.util.xml.pull.XmlPullParserException
-
clone
public PluginDescriptor clone()
Creates a shallow copy of this plugin descriptor.- Overrides:
clone
in classjava.lang.Object
-
-