Package org.apache.maven.plugin.descriptor

Class 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 Detail

      • PluginDescriptor

        public PluginDescriptor()

    • Method Detail

      • 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 like maven-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 class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • 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

      • setRequiredJavaVersion

        public void setRequiredJavaVersion​(java.lang.String requiredJavaVersion)

      • getRequiredJavaVersion

        public java.lang.String getRequiredJavaVersion()

      • 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 class java.lang.Object