FileSet (Apache Maven Assembly Plugin 3.4.2 API)

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

All Implemented Interfaces:

Serializable
```
public class FileSet
extends Object
implements Serializable
```
A fileSet allows the inclusion of groups of files into the assembly.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

FileSet()

Constructors
Constructor and Description
`FileSet()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExclude(String string)` Method addExclude.
`void`	`addInclude(String string)` Method addInclude.
`void`	`addNonFilteredFileExtension(String string)` Method addNonFilteredFileExtension.
`String`	`getDirectory()` Get sets the absolute or relative location from the module's directory.
`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<String>`	`getIncludes()` Method getIncludes.
`String`	`getLineEnding()` Get sets the line-endings of the files in this fileSet.
`List<String>`	`getNonFilteredFileExtensions()` Method getNonFilteredFileExtensions.
`String`	`getOutputDirectory()` Get sets the output directory relative to the root of the root directory of the assembly.
`boolean`	`isFiltered()` Get whether to filter symbols in the files as they are copied, using properties from the build configuration.
`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`	`removeInclude(String string)` Method removeInclude.
`void`	`removeNonFilteredFileExtension(String string)` Method removeNonFilteredFileExtension.
`void`	`setDirectory(String directory)` Set sets the absolute or relative location from the module's directory.
`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`	`setFileMode(String fileMode)` Set similar to a UNIX permission, sets the file mode of the files included.
`void`	`setFiltered(boolean filtered)` Set whether to filter symbols in the files as they are copied, using properties from the build configuration.
`void`	`setIncludes(List<String> includes)` Set when <include> subelements are present, they define a set of files and directory to include.
`void`	`setLineEnding(String lineEnding)` Set sets the line-endings of the files in this fileSet.
`void`	`setNonFilteredFileExtensions(List<String> nonFilteredFileExtensions)` Set additional file extensions to not apply filtering (Since 3.2.0).
`void`	`setOutputDirectory(String outputDirectory)` Set sets the output directory relative to the root of the root directory of the 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
  - FileSet
```
public FileSet()
```
- Method Detail
  - addExclude
```
public void addExclude(String string)
```
    Method addExclude.
    
    Parameters:
    
    string - a string object.
  - addInclude
```
public void addInclude(String string)
```
    Method addInclude.
    
    Parameters:
    
    string - a string object.
  - addNonFilteredFileExtension
```
public void addNonFilteredFileExtension(String string)
```
    Method addNonFilteredFileExtension.
    
    Parameters:
    
    string - a string object.
  - getDirectory
```
public String getDirectory()
```
    Get sets the absolute or relative location from the module's directory. For example, "src/main/bin" would select this subdirectory of the project in which this dependency is defined.
    
    Returns:
    
    String
  - 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
  - getIncludes
```
public List<String> getIncludes()
```
    Method getIncludes.
    
    Returns:
    
    List
  - getLineEnding
```
public String getLineEnding()
```
    Get sets the line-endings of the files in this fileSet. Valid values:
    - "keep" - Preserve all line endings
    - "unix" - Use Unix-style line endings
    - "lf" - Use a single line-feed line endings
    - "dos" - Use DOS-style line endings
    - "crlf" - Use Carraige-return, line-feed line endings
    Returns:
    
    String
  - getNonFilteredFileExtensions
```
public List<String> getNonFilteredFileExtensions()
```
    Method getNonFilteredFileExtensions.
    
    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
  - isFiltered
```
public boolean isFiltered()
```
    Get whether to filter symbols in the files as they are copied, using properties from the build configuration. (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.
  - removeInclude
```
public void removeInclude(String string)
```
    Method removeInclude.
    
    Parameters:
    
    string - a string object.
  - removeNonFilteredFileExtension
```
public void removeNonFilteredFileExtension(String string)
```
    Method removeNonFilteredFileExtension.
    
    Parameters:
    
    string - a string object.
  - setDirectory
```
public void setDirectory(String directory)
```
    Set sets the absolute or relative location from the module's directory. For example, "src/main/bin" would select this subdirectory of the project in which this dependency is defined.
    
    Parameters:
    
    directory - a directory 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.
  - 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.
  - setFiltered
```
public void setFiltered(boolean filtered)
```
    Set whether to filter symbols in the files as they are copied, using properties from the build configuration. (Since 2.2).
    
    Parameters:
    
    filtered - a filtered 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.
  - setLineEnding
```
public void setLineEnding(String lineEnding)
```
    Set sets the line-endings of the files in this fileSet. Valid values:
    - "keep" - Preserve all line endings
    - "unix" - Use Unix-style line endings
    - "lf" - Use a single line-feed line endings
    - "dos" - Use DOS-style line endings
    - "crlf" - Use Carraige-return, line-feed line endings
    Parameters:
    
    lineEnding - a lineEnding object.
  - setNonFilteredFileExtensions
```
public void setNonFilteredFileExtensions(List<String> nonFilteredFileExtensions)
```
    Set additional file extensions to not apply filtering (Since 3.2.0).
    
    Parameters:
    
    nonFilteredFileExtensions - a nonFilteredFileExtensions 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.
  - 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 FileSet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FileSet

Method Detail

addExclude

addInclude

addNonFilteredFileExtension

getDirectory

getDirectoryMode

getExcludes

getFileMode

getIncludes

getLineEnding

getNonFilteredFileExtensions

getOutputDirectory

isFiltered

isUseDefaultExcludes

removeExclude

removeInclude

removeNonFilteredFileExtension

setDirectory

setDirectoryMode

setExcludes

setFileMode

setFiltered

setIncludes

setLineEnding

setNonFilteredFileExtensions

setOutputDirectory

setUseDefaultExcludes