org.apache.maven.plugin.assembly.model
Class ModuleBinaries

java.lang.Object
  org.apache.maven.plugin.assembly.model.SetBase
      org.apache.maven.plugin.assembly.model.ModuleBinaries

All Implemented Interfaces:

java.io.Serializable

public class ModuleBinaries

extends SetBase

implements java.io.Serializable

Contains configuration options for including the binary files of a project module in an assembly.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

ModuleBinaries()

Method Summary

void	addDependencySet(DependencySet dependencySet) Method addDependencySet.
java.lang.String	getAttachmentClassifier() Get When specified, the attachmentClassifier will cause the assembler to look at artifacts attached to the module instead of the main project artifact.
java.util.List	getDependencySets() Method getDependencySets.
java.lang.String	getOutputFileNameMapping() Get Sets the mapping pattern for all NON-UNPACKED dependencies included in this assembly.
UnpackOptions	getUnpackOptions() Get Allows the specification of includes and excludes, along with filtering options, for items unpacked from a module artifact.
boolean	isIncludeDependencies() Get If set to true, the plugin will include the direct and transitive dependencies of of the project modules included here.
boolean	isUnpack() Get If set to true, this property will unpack all module packages into the specified output directory.
void	removeDependencySet(DependencySet dependencySet) Method removeDependencySet.
void	setAttachmentClassifier(java.lang.String attachmentClassifier) Set When specified, the attachmentClassifier will cause the assembler to look at artifacts attached to the module instead of the main project artifact.
void	setDependencySets(java.util.List dependencySets) Set Specifies which dependencies of the module to include in the assembly.
void	setIncludeDependencies(boolean includeDependencies) Set If set to true, the plugin will include the direct and transitive dependencies of of the project modules included here.
void	setOutputFileNameMapping(java.lang.String outputFileNameMapping) Set Sets the mapping pattern for all NON-UNPACKED dependencies included in this assembly.
void	setUnpack(boolean unpack) Set If set to true, this property will unpack all module packages into the specified output directory.
void	setUnpackOptions(UnpackOptions unpackOptions) Set Allows the specification of includes and excludes, along with filtering options, for items unpacked from a module artifact.

Methods inherited from class org.apache.maven.plugin.assembly.model.SetBase

addExclude, addInclude, getDirectoryMode, getExcludes, getFileMode, getIncludes, getOutputDirectory, isUseDefaultExcludes, isUseStrictFiltering, removeExclude, removeInclude, setDirectoryMode, setExcludes, setFileMode, setIncludes, setOutputDirectory, setUseDefaultExcludes, setUseStrictFiltering

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleBinaries

public ModuleBinaries()

Method Detail

addDependencySet

public void addDependencySet(DependencySet dependencySet)

Method addDependencySet.

Parameters:

dependencySet -

getAttachmentClassifier

public java.lang.String getAttachmentClassifier()

Get When specified, the attachmentClassifier will cause the assembler to look at artifacts attached to the module instead of the main project artifact. If it can find an attached artifact matching the specified classifier, it will use it; otherwise, it will throw an exception. (Since 2.2) .

Returns:

String

getDependencySets

public java.util.List getDependencySets()

Method getDependencySets.

Returns:

List

getOutputFileNameMapping

public java.lang.String getOutputFileNameMapping()

Get Sets the mapping pattern for all NON-UNPACKED dependencies included in this assembly. Default is ${module.artifactId}-${module.version}${dashClassifier?}.${module.extension}. (Since 2.2-beta-2; 2.2-beta-1 uses ${artifactId}-${version}${dashClassifier?}.${extension}) NOTE: If the dependencySet specifies unpack == true, outputFileNameMapping WILL NOT BE USED; in these cases, use outputDirectory.

Returns:

String

getUnpackOptions

public UnpackOptions getUnpackOptions()

Get Allows the specification of includes and excludes, along with filtering options, for items unpacked from a module artifact. (Since 2.2) .

Returns:

UnpackOptions

isIncludeDependencies

public boolean isIncludeDependencies()

Get If set to true, the plugin will include the direct and transitive dependencies of of the project modules included here. Otherwise, it will only include the module packages only. Default value is true.

Returns:

boolean

isUnpack

public boolean isUnpack()

Get If set to true, this property will unpack all module packages into the specified output directory. When set to false module packages will be included as archives (jars). Default value is true.

Returns:

boolean

removeDependencySet

public void removeDependencySet(DependencySet dependencySet)

Method removeDependencySet.

Parameters:

dependencySet -

setAttachmentClassifier

public void setAttachmentClassifier(java.lang.String attachmentClassifier)

Set When specified, the attachmentClassifier will cause the assembler to look at artifacts attached to the module instead of the main project artifact. If it can find an attached artifact matching the specified classifier, it will use it; otherwise, it will throw an exception. (Since 2.2) .

Parameters:

attachmentClassifier -

setDependencySets

public void setDependencySets(java.util.List dependencySets)

Set Specifies which dependencies of the module to include in the assembly. A dependencySet is specified by providing one or more of <dependencySet> subelements. (Since 2.2) .

Parameters:

dependencySets -

setIncludeDependencies

public void setIncludeDependencies(boolean includeDependencies)

Set If set to true, the plugin will include the direct and transitive dependencies of of the project modules included here. Otherwise, it will only include the module packages only. Default value is true.

Parameters:

includeDependencies -

setOutputFileNameMapping

public void setOutputFileNameMapping(java.lang.String outputFileNameMapping)

Set Sets the mapping pattern for all NON-UNPACKED dependencies included in this assembly. Default is ${module.artifactId}-${module.version}${dashClassifier?}.${module.extension}. (Since 2.2-beta-2; 2.2-beta-1 uses ${artifactId}-${version}${dashClassifier?}.${extension}) NOTE: If the dependencySet specifies unpack == true, outputFileNameMapping WILL NOT BE USED; in these cases, use outputDirectory.

Parameters:

outputFileNameMapping -

setUnpack

public void setUnpack(boolean unpack)

Set If set to true, this property will unpack all module packages into the specified output directory. When set to false module packages will be included as archives (jars). Default value is true.

Parameters:

unpack -

setUnpackOptions

public void setUnpackOptions(UnpackOptions unpackOptions)

Set Allows the specification of includes and excludes, along with filtering options, for items unpacked from a module artifact. (Since 2.2) .

Parameters:

unpackOptions -