org.apache.maven.plugins.assembly.model
Class Assembly

java.lang.Object
  org.apache.maven.plugins.assembly.model.Assembly

All Implemented Interfaces:

java.io.Serializable

public class Assembly
extends java.lang.Object
implements java.io.Serializable

Describes the assembly layout and packaging.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Assembly()

Method Summary

void	addComponentDescriptor(java.lang.String string) Method addComponentDescriptor
void	addDependencySet(DependencySet dependencySet) Method addDependencySet
void	addFile(FileItem fileItem) Method addFile
void	addFileSet(FileSet fileSet) Method addFileSet
void	addFormat(java.lang.String string) Method addFormat
void	addModuleSet(ModuleSet moduleSet) Method addModuleSet
void	addRepository(Repository repository) Method addRepository
java.util.List	getComponentDescriptors() Method getComponentDescriptors
java.util.List	getDependencySets() Method getDependencySets
java.util.List	getFiles() Method getFiles
java.util.List	getFileSets() Method getFileSets
java.util.List	getFormats() Method getFormats
java.lang.String	getId() Get The id of this assembly.
java.lang.String	getModelEncoding()
java.util.List	getModuleSets() Method getModuleSets
java.util.List	getRepositories() Method getRepositories
boolean	isIncludeBaseDirectory() Get Includes a base directory in the final archive.
boolean	isIncludeSiteDirectory() Get null
void	removeComponentDescriptor(java.lang.String string) Method removeComponentDescriptor
void	removeDependencySet(DependencySet dependencySet) Method removeDependencySet
void	removeFile(FileItem fileItem) Method removeFile
void	removeFileSet(FileSet fileSet) Method removeFileSet
void	removeFormat(java.lang.String string) Method removeFormat
void	removeModuleSet(ModuleSet moduleSet) Method removeModuleSet
void	removeRepository(Repository repository) Method removeRepository
void	setComponentDescriptors(java.util.List componentDescriptors) Set File relative to basedir containing Component.
void	setDependencySets(java.util.List dependencySets) Set Specify assembly behavior for sets of dependencies.
void	setFiles(java.util.List files) Set Specify assembly parameters for single files.
void	setFileSets(java.util.List fileSets) Set Specify assembly parameters for groups of files.
void	setFormats(java.util.List formats) Set Specify the formats of the assembly.
void	setId(java.lang.String id) Set The id of this assembly.
void	setIncludeBaseDirectory(boolean includeBaseDirectory) Set Includes a base directory in the final archive.
void	setIncludeSiteDirectory(boolean includeSiteDirectory) Set null
void	setModelEncoding(java.lang.String modelEncoding)
void	setModuleSets(java.util.List moduleSets) Set Specify which modules source files to include in the assembly
void	setRepositories(java.util.List repositories) Set Specify assembly behavior for sets of repositories.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Assembly

public Assembly()

Method Detail

addComponentDescriptor

public void addComponentDescriptor(java.lang.String string)

Method addComponentDescriptor

Parameters:

string -

addDependencySet

public void addDependencySet(DependencySet dependencySet)

Method addDependencySet

Parameters:

dependencySet -

addFile

public void addFile(FileItem fileItem)

Method addFile

Parameters:

fileItem -

addFileSet

public void addFileSet(FileSet fileSet)

Method addFileSet

Parameters:

fileSet -

addFormat

public void addFormat(java.lang.String string)

Method addFormat

Parameters:

string -

addModuleSet

public void addModuleSet(ModuleSet moduleSet)

Method addModuleSet

Parameters:

moduleSet -

addRepository

public void addRepository(Repository repository)

Method addRepository

Parameters:

repository -

getComponentDescriptors

public java.util.List getComponentDescriptors()

Method getComponentDescriptors

getDependencySets

public java.util.List getDependencySets()

Method getDependencySets

getFileSets

public java.util.List getFileSets()

Method getFileSets

getFiles

public java.util.List getFiles()

Method getFiles

getFormats

public java.util.List getFormats()

Method getFormats

getId

public java.lang.String getId()

Get The id of this assembly. This is a symbolic name for a particular assembly of files from this project.

getModuleSets

public java.util.List getModuleSets()

Method getModuleSets

getRepositories

public java.util.List getRepositories()

Method getRepositories

isIncludeBaseDirectory

public boolean isIncludeBaseDirectory()

Get Includes a base directory in the final archive. For example, if you are creating an assembly named "your-app", setting includeBaseDirectory to true will create an archive that includes this base directory. If this option is set to false the archive created will unzip its content to the current directory.

isIncludeSiteDirectory

public boolean isIncludeSiteDirectory()

Get null

removeComponentDescriptor

public void removeComponentDescriptor(java.lang.String string)

Method removeComponentDescriptor

Parameters:

string -

removeDependencySet

public void removeDependencySet(DependencySet dependencySet)

Method removeDependencySet

Parameters:

dependencySet -

removeFile

public void removeFile(FileItem fileItem)

Method removeFile

Parameters:

fileItem -

removeFileSet

public void removeFileSet(FileSet fileSet)

Method removeFileSet

Parameters:

fileSet -

removeFormat

public void removeFormat(java.lang.String string)

Method removeFormat

Parameters:

string -

removeModuleSet

public void removeModuleSet(ModuleSet moduleSet)

Method removeModuleSet

Parameters:

moduleSet -

removeRepository

public void removeRepository(Repository repository)

Method removeRepository

Parameters:

repository -

setComponentDescriptors

public void setComponentDescriptors(java.util.List componentDescriptors)

Set File relative to basedir containing Component.

Parameters:

componentDescriptors -

setDependencySets

public void setDependencySets(java.util.List dependencySets)

Set Specify assembly behavior for sets of dependencies.

Parameters:

dependencySets -

setFileSets

public void setFileSets(java.util.List fileSets)

Set Specify assembly parameters for groups of files.

Parameters:

fileSets -

setFiles

public void setFiles(java.util.List files)

Set Specify assembly parameters for single files.

Parameters:

files -

setFormats

public void setFormats(java.util.List formats)

Set Specify the formats of the assembly. A format is specified by supplying one of the following values in a <format> subelement:

• "zip" - Creates a ZIP file format
• "gz" - Creates a GZIP format
• "tar" - Creates a TAR format
• "tar.gz" - Creates a gzip'd TAR format
• "tar.bz2 - Creates a bzip'd TAR format

Parameters:

formats -

setId

public void setId(java.lang.String id)

Set The id of this assembly. This is a symbolic name for a particular assembly of files from this project.

Parameters:

id -

setIncludeBaseDirectory

public void setIncludeBaseDirectory(boolean includeBaseDirectory)

Set Includes a base directory in the final archive. For example, if you are creating an assembly named "your-app", setting includeBaseDirectory to true will create an archive that includes this base directory. If this option is set to false the archive created will unzip its content to the current directory.

Parameters:

includeBaseDirectory -

setIncludeSiteDirectory

public void setIncludeSiteDirectory(boolean includeSiteDirectory)

Set null

Parameters:

includeSiteDirectory -

setModuleSets

public void setModuleSets(java.util.List moduleSets)

Set Specify which modules source files to include in the assembly

Parameters:

moduleSets -

setRepositories

public void setRepositories(java.util.List repositories)

Set Specify assembly behavior for sets of repositories.

Parameters:

repositories -

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)

getModelEncoding

public java.lang.String getModelEncoding()