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

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

All Implemented Interfaces:

java.io.Serializable

public class ModuleSources

extends SetBase

implements java.io.Serializable

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

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

ModuleSources()

Method Summary

void	addFileSet(FileSet fileSet) Method addFileSet.
java.util.List	getFileSets() Method getFileSets.
java.lang.String	getModelEncoding()
java.lang.String	getOutputDirectoryMapping() Get Sets the mapping pattern for all module base-directories included in this assembly.
boolean	isExcludeSubModuleDirectories() Get Specifies whether sub-module directories below the current module should be excluded from fileSets applied to that module.
boolean	isIncludeModuleDirectory() Get Specifies whether the module's finalName should be prepended to the outputDirectory values of any fileSets applied to it.
void	removeFileSet(FileSet fileSet) Method removeFileSet.
void	setExcludeSubModuleDirectories(boolean excludeSubModuleDirectories) Set Specifies whether sub-module directories below the current module should be excluded from fileSets applied to that module.
void	setFileSets(java.util.List fileSets) Set Specifies which groups of files from each included module to include in the assembly.
void	setIncludeModuleDirectory(boolean includeModuleDirectory) Set Specifies whether the module's finalName should be prepended to the outputDirectory values of any fileSets applied to it.
void	setModelEncoding(java.lang.String modelEncoding) Set an encoding used for reading/writing the model.
void	setOutputDirectoryMapping(java.lang.String outputDirectoryMapping) Set Sets the mapping pattern for all module base-directories included in this assembly.

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

ModuleSources

public ModuleSources()

Method Detail

addFileSet

public void addFileSet(FileSet fileSet)

Method addFileSet.

Parameters:

fileSet -

getFileSets

public java.util.List getFileSets()

Method getFileSets.

Returns:

java.util.List

getOutputDirectoryMapping

public java.lang.String getOutputDirectoryMapping()

Get Sets the mapping pattern for all module base-directories included in this assembly. NOTE: This field is only used if includeModuleDirectory == true. Default is the module's ${artifactId} in 2.2-beta-1, and ${module.artifactId} in subsequent versions. (Since 2.2) .

Returns:

String

isExcludeSubModuleDirectories

public boolean isExcludeSubModuleDirectories()

Get Specifies whether sub-module directories below the current module should be excluded from fileSets applied to that module. This might be useful if you only mean to copy the sources for the exact module list matched by this ModuleSet, ignoring (or processing separately) the modules which exist in directories below the current one. Default value is true. (Since 2.2) .

Returns:

boolean

isIncludeModuleDirectory

public boolean isIncludeModuleDirectory()

Get Specifies whether the module's finalName should be prepended to the outputDirectory values of any fileSets applied to it. Default value is true. (Since 2.2) .

Returns:

boolean

removeFileSet

public void removeFileSet(FileSet fileSet)

Method removeFileSet.

Parameters:

fileSet -

setExcludeSubModuleDirectories

public void setExcludeSubModuleDirectories(boolean excludeSubModuleDirectories)

Set Specifies whether sub-module directories below the current module should be excluded from fileSets applied to that module. This might be useful if you only mean to copy the sources for the exact module list matched by this ModuleSet, ignoring (or processing separately) the modules which exist in directories below the current one. Default value is true. (Since 2.2) .

Parameters:

excludeSubModuleDirectories -

setFileSets

public void setFileSets(java.util.List fileSets)

Set Specifies which groups of files from each included module to include in the assembly. A fileSet is specified by providing one or more of <fileSet> subelements. (Since 2.2) .

Parameters:

fileSets -

setIncludeModuleDirectory

public void setIncludeModuleDirectory(boolean includeModuleDirectory)

Set Specifies whether the module's finalName should be prepended to the outputDirectory values of any fileSets applied to it. Default value is true. (Since 2.2) .

Parameters:

includeModuleDirectory -

setOutputDirectoryMapping

public void setOutputDirectoryMapping(java.lang.String outputDirectoryMapping)

Set Sets the mapping pattern for all module base-directories included in this assembly. NOTE: This field is only used if includeModuleDirectory == true. Default is the module's ${artifactId} in 2.2-beta-1, and ${module.artifactId} in subsequent versions. (Since 2.2) .

Parameters:

outputDirectoryMapping -

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)

Set an encoding used for reading/writing the model.

Overrides:

setModelEncoding in class SetBase

Parameters:

modelEncoding - the encoding used when reading/writing the model.

getModelEncoding

public java.lang.String getModelEncoding()

Overrides:

getModelEncoding in class SetBase

Returns:

the current encoding used when reading/writing this model.