SingleAssemblyMojo (Apache Maven Assembly Plugin 3.1.0 API)

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:

ContextEnabled, 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.html 1016737 2017-08-13 12:01:54Z khmarbaise $

Author:

John Casey, Brett Porter

- Field Summary
  - Fields inherited from class org.apache.maven.plugins.assembly.mojos.AbstractAssemblyMojo
    commanndLinePropertiesInterpolator, envInterpolator, mainProjectInterpolator, rootInterpolator
  - Fields inherited from interface org.apache.maven.plugin.Mojo
    ROLE
- Constructor Summary
  
  Constructors
  Constructor and Description
  
  SingleAssemblyMojo()
- Method Summary
  
  Methods
  Modifier and Type Method and Description
  
  void execute()
  Create the binary distribution.
  
  MavenProject getProject()
  - 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, 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

Constructors
Constructor and Description
`SingleAssemblyMojo()`

Methods
Modifier and Type	Method and Description
`void`	`execute()` Create the binary distribution.
`MavenProject`	`getProject()`

- Constructor Detail
  - SingleAssemblyMojo
```
public SingleAssemblyMojo()
```
- Method Detail
  - execute
```
public void execute()
             throws MojoExecutionException,
                    MojoFailureException
```
    Description copied from class: AbstractAssemblyMojo
    
    Create the binary distribution.
    
    Specified by:
    
    execute in interface Mojo
    
    Overrides:
    
    execute in class AbstractAssemblyMojo
    
    Throws:
    
    MojoExecutionException
    
    MojoFailureException
  - getProject
```
public MavenProject getProject()
```
    Specified by:
    
    getProject in interface AssemblerConfigurationSource
    
    Specified by:
    
    getProject in class AbstractAssemblyMojo
    
    Returns:
    The Maven Project.

Class SingleAssemblyMojo

Field Summary

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

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

Constructor Summary

Method Summary

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

Methods inherited from class org.apache.maven.plugin.AbstractMojo

Methods inherited from class java.lang.Object

Constructor Detail

SingleAssemblyMojo

Method Detail

execute

getProject