AbstractAssemblyMojo (Maven Assembly Plugin 2.2.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.maven.plugin.assembly.mojos
Class AbstractAssemblyMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.plugin.assembly.mojos.AbstractAssemblyMojo

All Implemented Interfaces:: AssemblerConfigurationSource, org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:: AbstractDirectoryMojo, AssemblyMojo, AttachedAssemblyMojo, SingleAssemblyMojo

public abstract class AbstractAssemblyMojo
extends org.apache.maven.plugin.AbstractMojo
implements AssemblerConfigurationSource
extends org.apache.maven.plugin.AbstractMojo
implements AssemblerConfigurationSource

Version:: $Id: AbstractAssemblyMojo.java 1207724 2011-11-29 00:56:09Z bimargulies $
Author:: Brett Porter, Vincent Siveton

Field Summary
`protected boolean`	`appendAssemblyId` Set to false to exclude the assembly id from the assembly final name.
`protected String`	`descriptor` Deprecated. Please use descriptors instead
`protected String`	`descriptorId` Deprecated. Please use descriptorRefs instead
`protected String`	`encoding` The character encoding scheme to be applied when filtering resources.
`protected List<String>`	`filters`
`protected boolean`	`ignoreMissingDescriptor` Set to true in order to not fail when a descriptor is missing.

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

Constructor Summary
`AbstractAssemblyMojo()`

Method Summary
`void`	`execute()` Create the binary distribution.
`File`	`getArchiveBaseDirectory()`
`String`	`getArchiverConfig()`
`protected AssemblyArchiver`	`getAssemblyArchiver()`
`protected AssemblyReader`	`getAssemblyReader()`
`File`	`getBasedir()`
`String`	`getClassifier()`
`String`	`getDescriptor()` Deprecated. This has been replaced by `getDescriptors()`
`String`	`getDescriptorId()` Deprecated. This has been replaced by `getDescriptorReferences()`
`String[]`	`getDescriptorReferences()`
`String[]`	`getDescriptors()`
`File`	`getDescriptorSourceDirectory()`
`String`	`getEncoding()`
`List<String>`	`getFilters()`
`String`	`getFinalName()`
`org.apache.maven.archiver.MavenArchiveConfiguration`	`getJarArchiveConfiguration()`
`org.apache.maven.artifact.repository.ArtifactRepository`	`getLocalRepository()`
`org.apache.maven.shared.filtering.MavenFileFilter`	`getMavenFileFilter()`
`org.apache.maven.execution.MavenSession`	`getMavenSession()`
`File`	`getOutputDirectory()`
`abstract org.apache.maven.project.MavenProject`	`getProject()`
`protected org.apache.maven.project.MavenProjectHelper`	`getProjectHelper()`
`List<org.apache.maven.project.MavenProject>`	`getReactorProjects()`
`List<org.apache.maven.artifact.repository.ArtifactRepository>`	`getRemoteRepositories()`
`File`	`getSiteDirectory()`
`String`	`getTarLongFileMode()`
`File`	`getTemporaryRootDirectory()`
`File`	`getWorkingDirectory()`
`boolean`	`isAssemblyIdAppended()`
`boolean`	`isDryRun()`
`boolean`	`isIgnoreDirFormatExtensions()`
`boolean`	`isIgnoreMissingDescriptor()`
`boolean`	`isIgnorePermissions()`
`boolean`	`isSiteIncluded()`
`protected boolean`	`isThisTheExecutionRoot()` Returns true if the current project is located at the Execution Root Directory (where mvn was launched)
`boolean`	`isUpdateOnly()`
`boolean`	`isUseJvmChmod()`
`void`	`setAppendAssemblyId(boolean appendAssemblyId)`
`void`	`setArchive(org.apache.maven.archiver.MavenArchiveConfiguration archive)`
`void`	`setArchiveBaseDirectory(File archiveBaseDirectory)`
`void`	`setAssemblyArchiver(AssemblyArchiver assemblyArchiver)`
`void`	`setAssemblyReader(AssemblyReader assemblyReader)`
`void`	`setBasedir(File basedir)`
`void`	`setClassifier(String classifier)`
`void`	`setDescriptor(String descriptor)` Deprecated. This has been replaced by `setDescriptors(String[])`
`void`	`setDescriptorId(String descriptorId)` Deprecated. This has been replaced by `setDescriptorRefs(String[])`
`void`	`setDescriptorRefs(String[] descriptorRefs)`
`void`	`setDescriptors(String[] descriptors)`
`void`	`setDescriptorSourceDirectory(File descriptorSourceDirectory)`
`void`	`setFilters(List<String> filters)`
`void`	`setFinalName(String finalName)`
`void`	`setIgnoreMissingDescriptor(boolean ignoreMissingDescriptor)`
`void`	`setIncludeSite(boolean includeSite)`
`void`	`setLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository localRepository)`
`void`	`setOutputDirectory(File outputDirectory)`
`void`	`setProjectHelper(org.apache.maven.project.MavenProjectHelper projectHelper)`
`void`	`setReactorProjects(List<org.apache.maven.project.MavenProject> reactorProjects)`
`void`	`setSiteDirectory(File siteDirectory)`
`void`	`setTarLongFileMode(String tarLongFileMode)`
`void`	`setTempRoot(File tempRoot)`
`void`	`setWorkDirectory(File workDirectory)`

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

encoding

protected String encoding

The character encoding scheme to be applied when filtering resources.

Is defined by:

expression:: ${encoding}
default-value:: ${project.build.sourceEncoding}

descriptorId

@Deprecated
protected String descriptorId

Deprecated. Please use descriptorRefs instead

Predefined Assembly Descriptor Id's. You can select bin, jar-with-dependencies, or src.

Is defined by:

expression:: ${descriptorId}

descriptor

@Deprecated
protected String descriptor

Deprecated. Please use descriptors instead

Assembly XML Descriptor file. This must be the path to your customized descriptor file.

Is defined by:

expression:: ${descriptor}

appendAssemblyId

protected boolean appendAssemblyId

Set to false to exclude the assembly id from the assembly final name.

Is defined by:

expression:: ${assembly.appendAssemblyId}
default-value:: true

ignoreMissingDescriptor

protected boolean ignoreMissingDescriptor

Set to true in order to not fail when a descriptor is missing.

Is defined by:

expression:: ${assembly.ignoreMissingDescriptor}
default-value:: false

filters

protected List<String> filters

Is defined by:

Constructor Detail