org.apache.maven.plugins.assembly.model.Assembly Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-assembly-plugin Show documentation
Show all versions of maven-assembly-plugin Show documentation
A Maven plugin to create archives of your project's sources, classes, dependencies etc. from flexible assembly descriptors.
// =================== DO NOT EDIT THIS FILE ====================
// Generated by Modello 2.0.0,
// any modifications will be overwritten.
// ==============================================================
package org.apache.maven.plugins.assembly.model;
/**
*
*
* An assembly defines a collection of files usually
* distributed in an
* archive format such as zip, tar, or tar.gz that is
* generated from a
* project. For example, a project could produce a ZIP
* assembly which
* contains a project's JAR artifact in the root directory,
* the
* runtime dependencies in a lib/ directory, and a shell
* script to launch
* a stand-alone application.
*
*
*
* @version $Revision$ $Date$
*/
@SuppressWarnings( "all" )
public class Assembly
implements java.io.Serializable
{
//--------------------------/
//- Class/Member Variables -/
//--------------------------/
/**
*
* Sets the id of this assembly. This is a symbolic
* name for a
* particular assembly of files from this project.
* Also, aside from
* being used to distinctly name the assembled
* package by attaching
* its value to the generated archive, the id is
* used as your
* artifact's classifier when deploying.
*
*/
private String id;
/**
* Field formats.
*/
private java.util.List formats;
/**
*
* 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.
*
*/
private boolean includeBaseDirectory = true;
/**
*
* Sets the base directory of the resulting
* assembly archive. If this is not
* set and includeBaseDirectory == true,
* ${project.build.finalName} will be used instead.
* (Since 2.2-beta-1)
* .
*/
private String baseDirectory;
/**
*
* Includes a site directory in the final archive.
* The site directory
* location of a project is determined by the
* siteDirectory parameter
* of the Assembly Plugin.
*
*/
private boolean includeSiteDirectory = false;
/**
* Field containerDescriptorHandlers.
*/
private java.util.List containerDescriptorHandlers;
/**
* Field moduleSets.
*/
private java.util.List moduleSets;
/**
* Field fileSets.
*/
private java.util.List fileSets;
/**
* Field files.
*/
private java.util.List files;
/**
* Field dependencySets.
*/
private java.util.List dependencySets;
/**
* Field repositories.
*/
private java.util.List repositories;
/**
* Field componentDescriptors.
*/
private java.util.List componentDescriptors;
/**
* Field modelEncoding.
*/
private String modelEncoding = "UTF-8";
//-----------/
//- Methods -/
//-----------/
/**
* Method addComponentDescriptor.
*
* @param string a string object.
*/
public void addComponentDescriptor( String string )
{
getComponentDescriptors().add( string );
} //-- void addComponentDescriptor( String )
/**
* Method addContainerDescriptorHandler.
*
* @param containerDescriptorHandlerConfig a
* containerDescriptorHandlerConfig object.
*/
public void addContainerDescriptorHandler( ContainerDescriptorHandlerConfig containerDescriptorHandlerConfig )
{
getContainerDescriptorHandlers().add( containerDescriptorHandlerConfig );
} //-- void addContainerDescriptorHandler( ContainerDescriptorHandlerConfig )
/**
* Method addDependencySet.
*
* @param dependencySet a dependencySet object.
*/
public void addDependencySet( DependencySet dependencySet )
{
getDependencySets().add( dependencySet );
} //-- void addDependencySet( DependencySet )
/**
* Method addFile.
*
* @param fileItem a fileItem object.
*/
public void addFile( FileItem fileItem )
{
getFiles().add( fileItem );
} //-- void addFile( FileItem )
/**
* Method addFileSet.
*
* @param fileSet a fileSet object.
*/
public void addFileSet( FileSet fileSet )
{
getFileSets().add( fileSet );
} //-- void addFileSet( FileSet )
/**
* Method addFormat.
*
* @param string a string object.
*/
public void addFormat( String string )
{
getFormats().add( string );
} //-- void addFormat( String )
/**
* Method addModuleSet.
*
* @param moduleSet a moduleSet object.
*/
public void addModuleSet( ModuleSet moduleSet )
{
getModuleSets().add( moduleSet );
} //-- void addModuleSet( ModuleSet )
/**
* Method addRepository.
*
* @param repository a repository object.
*/
public void addRepository( Repository repository )
{
getRepositories().add( repository );
} //-- void addRepository( Repository )
/**
* Get sets the base directory of the resulting assembly
* archive. If this is not
* set and includeBaseDirectory == true,
* ${project.build.finalName} will be used instead.
* (Since 2.2-beta-1).
*
* @return String
*/
public String getBaseDirectory()
{
return this.baseDirectory;
} //-- String getBaseDirectory()
/**
* Method getComponentDescriptors.
*
* @return List
*/
public java.util.List getComponentDescriptors()
{
if ( this.componentDescriptors == null )
{
this.componentDescriptors = new java.util.ArrayList();
}
return this.componentDescriptors;
} //-- java.util.List getComponentDescriptors()
/**
* Method getContainerDescriptorHandlers.
*
* @return List
*/
public java.util.List getContainerDescriptorHandlers()
{
if ( this.containerDescriptorHandlers == null )
{
this.containerDescriptorHandlers = new java.util.ArrayList();
}
return this.containerDescriptorHandlers;
} //-- java.util.List getContainerDescriptorHandlers()
/**
* Method getDependencySets.
*
* @return List
*/
public java.util.List getDependencySets()
{
if ( this.dependencySets == null )
{
this.dependencySets = new java.util.ArrayList();
}
return this.dependencySets;
} //-- java.util.List getDependencySets()
/**
* Method getFileSets.
*
* @return List
*/
public java.util.List getFileSets()
{
if ( this.fileSets == null )
{
this.fileSets = new java.util.ArrayList();
}
return this.fileSets;
} //-- java.util.List getFileSets()
/**
* Method getFiles.
*
* @return List
*/
public java.util.List getFiles()
{
if ( this.files == null )
{
this.files = new java.util.ArrayList();
}
return this.files;
} //-- java.util.List getFiles()
/**
* Method getFormats.
*
* @return List
*/
public java.util.List getFormats()
{
if ( this.formats == null )
{
this.formats = new java.util.ArrayList();
}
return this.formats;
} //-- java.util.List getFormats()
/**
* Get sets the id of this assembly. This is a symbolic name
* for a
* particular assembly of files from this project.
* Also, aside from
* being used to distinctly name the assembled
* package by attaching
* its value to the generated archive, the id is
* used as your
* artifact's classifier when deploying.
*
* @return String
*/
public String getId()
{
return this.id;
} //-- String getId()
/**
* Get the modelEncoding field.
*
* @return String
*/
public String getModelEncoding()
{
return this.modelEncoding;
} //-- String getModelEncoding()
/**
* Method getModuleSets.
*
* @return List
*/
public java.util.List getModuleSets()
{
if ( this.moduleSets == null )
{
this.moduleSets = new java.util.ArrayList();
}
return this.moduleSets;
} //-- java.util.List getModuleSets()
/**
* Method getRepositories.
*
* @return List
*/
public java.util.List getRepositories()
{
if ( this.repositories == null )
{
this.repositories = new java.util.ArrayList();
}
return this.repositories;
} //-- java.util.List getRepositories()
/**
* 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.
*
* @return boolean
*/
public boolean isIncludeBaseDirectory()
{
return this.includeBaseDirectory;
} //-- boolean isIncludeBaseDirectory()
/**
* Get includes a site directory in the final archive. The site
* directory
* location of a project is determined by the
* siteDirectory parameter
* of the Assembly Plugin.
*
* @return boolean
*/
public boolean isIncludeSiteDirectory()
{
return this.includeSiteDirectory;
} //-- boolean isIncludeSiteDirectory()
/**
* Method removeComponentDescriptor.
*
* @param string a string object.
*/
public void removeComponentDescriptor( String string )
{
getComponentDescriptors().remove( string );
} //-- void removeComponentDescriptor( String )
/**
* Method removeContainerDescriptorHandler.
*
* @param containerDescriptorHandlerConfig a
* containerDescriptorHandlerConfig object.
*/
public void removeContainerDescriptorHandler( ContainerDescriptorHandlerConfig containerDescriptorHandlerConfig )
{
getContainerDescriptorHandlers().remove( containerDescriptorHandlerConfig );
} //-- void removeContainerDescriptorHandler( ContainerDescriptorHandlerConfig )
/**
* Method removeDependencySet.
*
* @param dependencySet a dependencySet object.
*/
public void removeDependencySet( DependencySet dependencySet )
{
getDependencySets().remove( dependencySet );
} //-- void removeDependencySet( DependencySet )
/**
* Method removeFile.
*
* @param fileItem a fileItem object.
*/
public void removeFile( FileItem fileItem )
{
getFiles().remove( fileItem );
} //-- void removeFile( FileItem )
/**
* Method removeFileSet.
*
* @param fileSet a fileSet object.
*/
public void removeFileSet( FileSet fileSet )
{
getFileSets().remove( fileSet );
} //-- void removeFileSet( FileSet )
/**
* Method removeFormat.
*
* @param string a string object.
*/
public void removeFormat( String string )
{
getFormats().remove( string );
} //-- void removeFormat( String )
/**
* Method removeModuleSet.
*
* @param moduleSet a moduleSet object.
*/
public void removeModuleSet( ModuleSet moduleSet )
{
getModuleSets().remove( moduleSet );
} //-- void removeModuleSet( ModuleSet )
/**
* Method removeRepository.
*
* @param repository a repository object.
*/
public void removeRepository( Repository repository )
{
getRepositories().remove( repository );
} //-- void removeRepository( Repository )
/**
* Set sets the base directory of the resulting assembly
* archive. If this is not
* set and includeBaseDirectory == true,
* ${project.build.finalName} will be used instead.
* (Since 2.2-beta-1).
*
* @param baseDirectory a baseDirectory object.
*/
public void setBaseDirectory( String baseDirectory )
{
this.baseDirectory = baseDirectory;
} //-- void setBaseDirectory( String )
/**
* Set specifies the shared components xml file locations to
* include in the
* assembly. The locations specified must be
* relative to the base location
* of the descriptor. If the descriptor was found
* via a <descriptorRef/>
* element in the
* classpath, any components it specifies will also
* be found on the classpath.
* If it is found by pathname via a
* <descriptor/> element
* the value here will be interpreted
* as a path relative to the project basedir.
* When multiple componentDescriptors are found,
* their
* contents are merged. Check out the
* descriptor components for more information.
* A
* componentDescriptor is specified by providing
* one or more of
* <componentDescriptor> subelements.
*
* @param componentDescriptors a componentDescriptors object.
*/
public void setComponentDescriptors( java.util.List componentDescriptors )
{
this.componentDescriptors = componentDescriptors;
} //-- void setComponentDescriptors( java.util.List )
/**
* Set set of components which filter various container
* descriptors out of
* the normal archive stream, so they can be
* aggregated then added.
*
* @param containerDescriptorHandlers a
* containerDescriptorHandlers object.
*/
public void setContainerDescriptorHandlers( java.util.List containerDescriptorHandlers )
{
this.containerDescriptorHandlers = containerDescriptorHandlers;
} //-- void setContainerDescriptorHandlers( java.util.List )
/**
* Set specifies which dependencies to include in the assembly.
* A
* dependencySet is specified by providing one or
* more of
* <dependencySet> subelements.
*
* @param dependencySets a dependencySets object.
*/
public void setDependencySets( java.util.List dependencySets )
{
this.dependencySets = dependencySets;
} //-- void setDependencySets( java.util.List )
/**
* Set specifies which groups of files to include in the
* assembly. A
* fileSet is specified by providing one or more of
* <fileSet>
* subelements.
*
* @param fileSets a fileSets object.
*/
public void setFileSets( java.util.List fileSets )
{
this.fileSets = fileSets;
} //-- void setFileSets( java.util.List )
/**
* Set specifies which single files to include in the assembly.
* A file
* is specified by providing one or more of
* <file>
* subelements.
*
* @param files a files object.
*/
public void setFiles( java.util.List files )
{
this.files = files;
} //-- void setFiles( java.util.List )
/**
* Set specifies the formats of the assembly.
*
* It is often better to specify the formats via
* the goal parameter rather
* than here. For example, that allows different
* profiles to generate
* different types of archives.
*
* Multiple formats can be
* supplied and the Assembly Plugin will generate
* an archive for each
* of the desired formats. When deploying your
* project, all file formats
* specified will also be deployed. A format is
* specified by supplying
* one of the following values in a <format>
* subelement:
*
* - "zip" - Creates a ZIP file
* format
* - "tar" - Creates a TAR format
* - "tar.gz" or "tgz" - Creates
* a gzip'd TAR format
* - "tar.bz2" or "tbz2" -
* Creates a bzip'd TAR format
* - "tar.snappy" - Creates a snappy'd
* TAR format
* - "tar.xz" or "txz" - Creates
* a xz'd TAR format
* - "jar" - Creates a JAR format
* - "dir" - Creates an exploded
* directory format
* - "war" - Creates a WAR format
*
*
* @param formats a formats object.
*/
public void setFormats( java.util.List formats )
{
this.formats = formats;
} //-- void setFormats( java.util.List )
/**
* Set sets the id of this assembly. This is a symbolic name
* for a
* particular assembly of files from this project.
* Also, aside from
* being used to distinctly name the assembled
* package by attaching
* its value to the generated archive, the id is
* used as your
* artifact's classifier when deploying.
*
* @param id a id object.
*/
public void setId( String id )
{
this.id = id;
} //-- void setId( String )
/**
* 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.
*
* @param includeBaseDirectory a includeBaseDirectory object.
*/
public void setIncludeBaseDirectory( boolean includeBaseDirectory )
{
this.includeBaseDirectory = includeBaseDirectory;
} //-- void setIncludeBaseDirectory( boolean )
/**
* Set includes a site directory in the final archive. The site
* directory
* location of a project is determined by the
* siteDirectory parameter
* of the Assembly Plugin.
*
* @param includeSiteDirectory a includeSiteDirectory object.
*/
public void setIncludeSiteDirectory( boolean includeSiteDirectory )
{
this.includeSiteDirectory = includeSiteDirectory;
} //-- void setIncludeSiteDirectory( boolean )
/**
* Set the modelEncoding field.
*
* @param modelEncoding a modelEncoding object.
*/
public void setModelEncoding( String modelEncoding )
{
this.modelEncoding = modelEncoding;
} //-- void setModelEncoding( String )
/**
* Set specifies which module files to include in the assembly.
* A moduleSet
* is specified by providing one or more of
* <moduleSet>
* subelements.
*
* @param moduleSets a moduleSets object.
*/
public void setModuleSets( java.util.List moduleSets )
{
this.moduleSets = moduleSets;
} //-- void setModuleSets( java.util.List )
/**
* Set Deprecated since model version 2.1.1.
* Specifies which repository files to include in
* the assembly. A
* repository is specified by providing one or more
* of
* <repository> subelements.
*
* @param repositories a repositories object.
*/
public void setRepositories( java.util.List repositories )
{
this.repositories = repositories;
} //-- void setRepositories( java.util.List )
}