org.apache.maven.plugins.help
Class DescribeMojo
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.plugins.help.DescribeMojo
- All Implemented Interfaces:
- org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
public class DescribeMojo
- extends org.apache.maven.plugin.AbstractMojo
Describes the attributes of a plugin and/or plugin mojo.
Fields inherited from interface org.apache.maven.plugin.Mojo |
ROLE |
Methods inherited from class org.apache.maven.plugin.AbstractMojo |
getLog, getPluginContext, setLog, setPluginContext |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
DescribeMojo
public DescribeMojo()
execute
public void execute()
throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException
- Throws:
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException
- See Also:
Mojo.execute()
getPlugin
public final java.lang.String getPlugin()
- Returns:
- a String of the plugin parameter value
setPlugin
public final void setPlugin(java.lang.String plugin)
- Parameters:
plugin
- the plugin value to be set
getPluginManager
public final org.apache.maven.plugin.PluginManager getPluginManager()
- Returns:
- a PluginManager object
setPluginManager
public final void setPluginManager(org.apache.maven.plugin.PluginManager pluginManager)
- Parameters:
pluginManager
- the plugin manager to be set
getArtifactId
public final java.lang.String getArtifactId()
- Returns:
- a String that contains the artifactId
setArtifactId
public final void setArtifactId(java.lang.String artifactId)
- Parameters:
artifactId
- the artifactId to be set
getGroupId
public final java.lang.String getGroupId()
- Returns:
- a String that contains the groupId
setGroupId
public final void setGroupId(java.lang.String groupId)
- Parameters:
groupId
- the groupId value to be set
getLocalRepository
public final org.apache.maven.artifact.repository.ArtifactRepository getLocalRepository()
- Returns:
- an ArtifactRepository object of the local repository
setLocalRepository
public final void setLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository localRepository)
- Parameters:
localRepository
- the local repository value to be set
getMojo
public final java.lang.String getMojo()
- Returns:
- a String of the mojo parameter value
setMojo
public final void setMojo(java.lang.String mojo)
- Parameters:
mojo
- the mojo parameter value to be set
getOutput
public final java.io.File getOutput()
- Returns:
- a File object where the description will be written to
setOutput
public final void setOutput(java.io.File output)
- Parameters:
output
- the output file value to be set
getProject
public final org.apache.maven.project.MavenProject getProject()
- Returns:
- a MavenProject object of the current build
setProject
public final void setProject(org.apache.maven.project.MavenProject project)
- Parameters:
project
- the project value to be set
getSettings
public final org.apache.maven.settings.Settings getSettings()
setSettings
public final void setSettings(org.apache.maven.settings.Settings settings)
getVersion
public final java.lang.String getVersion()
- Returns:
- a String that contains the value of the version parameter
setVersion
public final void setVersion(java.lang.String version)
- Parameters:
version
- the version parameter value to be set
Copyright © 2001-2009 Apache Software Foundation. All Rights Reserved.