ModuleSources (Apache Maven Assembly Plugin 3.4.2 API)

java.lang.Object
- org.apache.maven.plugins.assembly.model.ModuleSources

All Implemented Interfaces:

Serializable
```
public class ModuleSources
extends Object
implements 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

Constructors
Constructor and Description

ModuleSources()

Constructors
Constructor and Description
`ModuleSources()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExclude(String string)` Method addExclude.
`void`	`addFileSet(FileSet fileSet)` Method addFileSet.
`void`	`addInclude(String string)` Method addInclude.
`String`	`getDirectoryMode()` Get similar to a UNIX permission, sets the directory mode of the directories included.
`List<String>`	`getExcludes()` Method getExcludes.
`String`	`getFileMode()` Get similar to a UNIX permission, sets the file mode of the files included.
`List<FileSet>`	`getFileSets()` Method getFileSets.
`List<String>`	`getIncludes()` Method getIncludes.
`String`	`getOutputDirectory()` Get sets the output directory relative to the root of the root directory of the assembly.
`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.
`boolean`	`isUseDefaultExcludes()` Get whether standard exclusion patterns, such as those matching CVS and Subversion metadata files, should be used when calculating the files affected by this set.
`void`	`removeExclude(String string)` Method removeExclude.
`void`	`removeFileSet(FileSet fileSet)` Method removeFileSet.
`void`	`removeInclude(String string)` Method removeInclude.
`void`	`setDirectoryMode(String directoryMode)` Set similar to a UNIX permission, sets the directory mode of the directories included.
`void`	`setExcludes(List<String> excludes)` Set when <exclude> subelements are present, they define a set of files and directory to exclude.
`void`	`setExcludeSubModuleDirectories(boolean excludeSubModuleDirectories)` Set specifies whether sub-module directories below the current module should be excluded from fileSets applied to that module.
`void`	`setFileMode(String fileMode)` Set similar to a UNIX permission, sets the file mode of the files included.
`void`	`setFileSets(List<FileSet> 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`	`setIncludes(List<String> includes)` Set when <include> subelements are present, they define a set of files and directory to include.
`void`	`setOutputDirectory(String outputDirectory)` Set sets the output directory relative to the root of the root directory of the assembly.
`void`	`setOutputDirectoryMapping(String outputDirectoryMapping)` Set sets the mapping pattern for all module base-directories included in this assembly.
`void`	`setUseDefaultExcludes(boolean useDefaultExcludes)` Set whether standard exclusion patterns, such as those matching CVS and Subversion metadata files, should be used when calculating the files affected by this set.

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
  - addExclude
```
public void addExclude(String string)
```
    Method addExclude.
    
    Parameters:
    
    string - a string object.
  - addFileSet
```
public void addFileSet(FileSet fileSet)
```
    Method addFileSet.
    
    Parameters:
    
    fileSet - a fileSet object.
  - addInclude
```
public void addInclude(String string)
```
    Method addInclude.
    
    Parameters:
    
    string - a string object.
  - getDirectoryMode
```
public String getDirectoryMode()
```
    Get similar to a UNIX permission, sets the directory mode of the directories included. THIS IS AN OCTAL VALUE. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the value 0755 translates to User read-write, Group and Other read-only. The default value is 0755. (more on unix-style permissions)
    
    Returns:
    
    String
  - getExcludes
```
public List<String> getExcludes()
```
    Method getExcludes.
    
    Returns:
    
    List
  - getFileMode
```
public String getFileMode()
```
    Get similar to a UNIX permission, sets the file mode of the files included. THIS IS AN OCTAL VALUE. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the value 0644 translates to User read-write, Group and Other read-only. The default value is 0644. (more on unix-style permissions)
    
    Returns:
    
    String
  - getFileSets
```
public List<FileSet> getFileSets()
```
    Method getFileSets.
    
    Returns:
    
    List
  - getIncludes
```
public List<String> getIncludes()
```
    Method getIncludes.
    
    Returns:
    
    List
  - getOutputDirectory
```
public String getOutputDirectory()
```
    Get sets the output directory relative to the root of the root directory of the assembly. For example, "log" will put the specified files in the log directory.
    
    Returns:
    
    String
  - getOutputDirectoryMapping
```
public 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
  - isUseDefaultExcludes
```
public boolean isUseDefaultExcludes()
```
    Get whether standard exclusion patterns, such as those matching CVS and Subversion metadata files, should be used when calculating the files affected by this set. For backward compatibility, the default value is true. (Since 2.2).
    
    Returns:
    
    boolean
  - removeExclude
```
public void removeExclude(String string)
```
    Method removeExclude.
    
    Parameters:
    
    string - a string object.
  - removeFileSet
```
public void removeFileSet(FileSet fileSet)
```
    Method removeFileSet.
    
    Parameters:
    
    fileSet - a fileSet object.
  - removeInclude
```
public void removeInclude(String string)
```
    Method removeInclude.
    
    Parameters:
    
    string - a string object.
  - setDirectoryMode
```
public void setDirectoryMode(String directoryMode)
```
    Set similar to a UNIX permission, sets the directory mode of the directories included. THIS IS AN OCTAL VALUE. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the value 0755 translates to User read-write, Group and Other read-only. The default value is 0755. (more on unix-style permissions)
    
    Parameters:
    
    directoryMode - a directoryMode object.
  - 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 - a excludeSubModuleDirectories object.
  - setExcludes
```
public void setExcludes(List<String> excludes)
```
    Set when <exclude> subelements are present, they define a set of files and directory to exclude. If none is present, then <excludes> represents no exclusions.
    
    Parameters:
    
    excludes - a excludes object.
  - setFileMode
```
public void setFileMode(String fileMode)
```
    Set similar to a UNIX permission, sets the file mode of the files included. THIS IS AN OCTAL VALUE. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the value 0644 translates to User read-write, Group and Other read-only. The default value is 0644. (more on unix-style permissions)
    
    Parameters:
    
    fileMode - a fileMode object.
  - setFileSets
```
public void setFileSets(List<FileSet> 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 - a fileSets object.
  - 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 - a includeModuleDirectory object
  - setIncludes
```
public void setIncludes(List<String> includes)
```
    Set when <include> subelements are present, they define a set of files and directory to include. If none is present, then <includes> represents all valid values.
    
    Parameters:
    
    includes - a includes object.
  - setOutputDirectory
```
public void setOutputDirectory(String outputDirectory)
```
    Set sets the output directory relative to the root of the root directory of the assembly. For example, "log" will put the specified files in the log directory.
    
    Parameters:
    
    outputDirectory - a outputDirectory object.
  - setOutputDirectoryMapping
```
public void setOutputDirectoryMapping(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 - a outputDirectoryMapping object
  - setUseDefaultExcludes
```
public void setUseDefaultExcludes(boolean useDefaultExcludes)
```
    Set whether standard exclusion patterns, such as those matching CVS and Subversion metadata files, should be used when calculating the files affected by this set. For backward compatibility, the default value is true. (Since 2.2).
    
    Parameters:
    
    useDefaultExcludes - a useDefaultExcludes object.

Class ModuleSources

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ModuleSources

Method Detail

addExclude

addFileSet

addInclude

getDirectoryMode

getExcludes

getFileMode

getFileSets

getIncludes

getOutputDirectory

getOutputDirectoryMapping

isExcludeSubModuleDirectories

isIncludeModuleDirectory

isUseDefaultExcludes

removeExclude

removeFileSet

removeInclude

setDirectoryMode

setExcludeSubModuleDirectories

setExcludes

setFileMode

setFileSets

setIncludeModuleDirectory

setIncludes

setOutputDirectory

setOutputDirectoryMapping

setUseDefaultExcludes