org.apache.maven.plugins.assembly.mojos

Class SingleAssemblyMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.assembly.mojos.AbstractAssemblyMojo

org.apache.maven.plugins.assembly.mojos.SingleAssemblyMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, AssemblerConfigurationSource

@Mojo(name="single",
      inheritByDefault=false,
      requiresDependencyResolution=COMPILE,
      threadSafe=true)
public class SingleAssemblyMojo
extends AbstractAssemblyMojo

Assemble an application bundle or distribution from an assembly descriptor. This goal is suitable either for binding to the lifecycle or calling directly from the command line (provided all required files are available before the build starts, or are produced by another goal specified before this one on the command line).
Note that the parameters descriptors, descriptorRefs, and descriptorSourceDirectory are disjoint, i.e., they are not combined during descriptor location calculation.

Version:

$Id: SingleAssemblyMojo.java 1781812 2017-02-05 21:33:53Z michaelo $

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.maven.plugin.descriptor.PluginDescriptor	plugin
private org.apache.maven.project.MavenProject	project

Fields inherited from class org.apache.maven.plugins.assembly.mojos.AbstractAssemblyMojo

appendAssemblyId, commanndLinePropertiesInterpolator, envInterpolator, mainProjectInterpolator, rootInterpolator

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
SingleAssemblyMojo()

Method Summary

Modifier and Type	Method and Description
void	execute() Create the binary distribution.
org.apache.maven.project.MavenProject	getProject()
private void	verifyRemovedParameter(java.lang.String paramName)

Methods inherited from class org.apache.maven.plugins.assembly.mojos.AbstractAssemblyMojo

getArchiveBaseDirectory, getArchiverConfig, getBasedir, getCommandLinePropsInterpolator, getDelimiters, getDescriptorReferences, getDescriptors, getDescriptorSourceDirectory, getEncoding, getEnvInterpolator, getEscapeString, getFilters, getFinalName, getJarArchiveConfiguration, getLocalRepository, getMainProjectInterpolator, getMavenReaderFilter, getMavenSession, getMergeManifestMode, getOutputDirectory, getReactorProjects, getRemoteRepositories, getRepositoryInterpolator, getSiteDirectory, getTarLongFileMode, getTemporaryRootDirectory, getWorkingDirectory, isAssemblyIdAppended, isDryRun, isIgnoreDirFormatExtensions, isIgnoreMissingDescriptor, isIgnorePermissions, isIncludeProjectBuildFilters, isRecompressZippedFiles, isThisTheExecutionRoot, isUpdateOnly, isUseJvmChmod, mainProjectInterpolator, setAppendAssemblyId, setArchive, setBasedir, setDelimiters, setDescriptorRefs, setDescriptors, setFilters, setFinalName, setLocalRepository, setOutputDirectory, setReactorProjects, setSiteDirectory, setTarLongFileMode, setTempRoot, setWorkDirectory

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

Field Detail

plugin

@Parameter(defaultValue="${plugin}",
           readonly=true)
private org.apache.maven.plugin.descriptor.PluginDescriptor plugin

project

@Parameter(defaultValue="${project}",
           readonly=true,
           required=true)
private org.apache.maven.project.MavenProject project

Constructor Detail

SingleAssemblyMojo

public SingleAssemblyMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Description copied from class: AbstractAssemblyMojo

Create the binary distribution.

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class AbstractAssemblyMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

verifyRemovedParameter

private void verifyRemovedParameter(java.lang.String paramName)

getProject

public org.apache.maven.project.MavenProject getProject()

Specified by:

getProject in interface AssemblerConfigurationSource

Specified by:

getProject in class AbstractAssemblyMojo

Returns:

The Maven Project.