AbstractAssemblyMojo (Maven Assembly Plugin 2.2-beta-4 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

Version:: $Id: AbstractAssemblyMojo.java 775788 2009-05-18 01:09:27Z brianf $
Author:: Brett Porter, Vincent Siveton

Field Summary
`protected boolean`	`appendAssemblyId` Set to false to exclude the assembly id from the assembly final name.
`protected java.lang.String`	`descriptor` Deprecated. Please use descriptors instead
`protected java.lang.String`	`descriptorId` Deprecated. Please use descriptorRefs instead
`protected java.util.List`	`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.
`java.io.File`	`getArchiveBaseDirectory()`
`java.lang.String`	`getArchiverConfig()`
`protected AssemblyArchiver`	`getAssemblyArchiver()`
`protected AssemblyReader`	`getAssemblyReader()`
`java.io.File`	`getBasedir()`
`java.lang.String`	`getClassifier()`
`java.lang.String`	`getDescriptor()`
`java.lang.String`	`getDescriptorId()`
`java.lang.String[]`	`getDescriptorReferences()`
`java.lang.String[]`	`getDescriptors()`
`java.io.File`	`getDescriptorSourceDirectory()`
`java.util.List`	`getFilters()`
`java.lang.String`	`getFinalName()`
`org.apache.maven.archiver.MavenArchiveConfiguration`	`getJarArchiveConfiguration()`
`org.apache.maven.artifact.repository.ArtifactRepository`	`getLocalRepository()`
`org.apache.maven.execution.MavenSession`	`getMavenSession()`
`java.io.File`	`getOutputDirectory()`
`abstract org.apache.maven.project.MavenProject`	`getProject()`
`protected org.apache.maven.project.MavenProjectHelper`	`getProjectHelper()`
`java.util.List`	`getReactorProjects()`
`java.util.List`	`getRemoteRepositories()`
`java.io.File`	`getSiteDirectory()`
`java.lang.String`	`getTarLongFileMode()`
`java.io.File`	`getTemporaryRootDirectory()`
`java.io.File`	`getWorkingDirectory()`
`boolean`	`isAssemblyIdAppended()`
`boolean`	`isDryRun()`
`boolean`	`isIgnoreDirFormatExtensions()`
`boolean`	`isIgnoreMissingDescriptor()`
`boolean`	`isSiteIncluded()`
`protected boolean`	`isThisTheExecutionRoot()` Returns true if the current project is located at the Execution Root Directory (where mvn was launched)
`void`	`setAppendAssemblyId(boolean appendAssemblyId)`
`void`	`setArchive(org.apache.maven.archiver.MavenArchiveConfiguration archive)`
`void`	`setArchiveBaseDirectory(java.io.File archiveBaseDirectory)`
`void`	`setAssemblyArchiver(AssemblyArchiver assemblyArchiver)`
`void`	`setAssemblyReader(AssemblyReader assemblyReader)`
`void`	`setBasedir(java.io.File basedir)`
`void`	`setClassifier(java.lang.String classifier)`
`void`	`setDescriptor(java.lang.String descriptor)`
`void`	`setDescriptorId(java.lang.String descriptorId)`
`void`	`setDescriptorRefs(java.lang.String[] descriptorRefs)`
`void`	`setDescriptors(java.lang.String[] descriptors)`
`void`	`setDescriptorSourceDirectory(java.io.File descriptorSourceDirectory)`
`void`	`setFilters(java.util.List filters)`
`void`	`setFinalName(java.lang.String finalName)`
`void`	`setIgnoreMissingDescriptor(boolean ignoreMissingDescriptor)`
`void`	`setIncludeSite(boolean includeSite)`
`void`	`setLocalRepository(org.apache.maven.artifact.repository.ArtifactRepository localRepository)`
`void`	`setOutputDirectory(java.io.File outputDirectory)`
`void`	`setProjectHelper(org.apache.maven.project.MavenProjectHelper projectHelper)`
`void`	`setReactorProjects(java.util.List reactorProjects)`
`void`	`setSiteDirectory(java.io.File siteDirectory)`
`void`	`setTarLongFileMode(java.lang.String tarLongFileMode)`
`void`	`setTempRoot(java.io.File tempRoot)`
`void`	`setWorkDirectory(java.io.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

descriptorId

protected java.lang.String descriptorId

Deprecated. Please use descriptorRefs instead

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

descriptor

protected java.lang.String descriptor

Deprecated. Please use descriptors instead

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

appendAssemblyId

protected boolean appendAssemblyId

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

ignoreMissingDescriptor

protected boolean ignoreMissingDescriptor

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

filters

protected java.util.List filters

Constructor Detail