Class FileSet
- java.lang.Object
-
- org.apache.maven.plugins.assembly.model.FileSet
-
- All Implemented Interfaces:
java.io.Serializable
public class FileSet extends java.lang.Object implements java.io.Serializable
A fileSet allows the inclusion of groups of files into the assembly.- Version:
- $Revision$ $Date$
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
directory
Sets the absolute or relative location from the module's directory.private java.lang.String
directoryMode
Similar to a UNIX permission, sets the directory mode of the directories included.private java.util.List<java.lang.String>
excludes
Field excludes.private java.lang.String
fileMode
Similar to a UNIX permission, sets the file mode of the files included.private boolean
filtered
Whether to filter symbols in the files as they are copied, using properties from the build configuration.private java.util.List<java.lang.String>
includes
Field includes.private java.lang.String
lineEnding
Sets the line-endings of the files in this fileSet.private java.lang.String
outputDirectory
Sets the output directory relative to the root of the root directory of the assembly.private boolean
useDefaultExcludes
Whether standard exclusion patterns, such as those matching CVS and Subversion metadata files, should be used when calculating the files affected by this set.
-
Constructor Summary
Constructors Constructor Description FileSet()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addExclude(java.lang.String string)
Method addExclude.void
addInclude(java.lang.String string)
Method addInclude.java.lang.String
getDirectory()
Get sets the absolute or relative location from the module's directory.java.lang.String
getDirectoryMode()
Get similar to a UNIX permission, sets the directory mode of the directories included.java.util.List<java.lang.String>
getExcludes()
Method getExcludes.java.lang.String
getFileMode()
Get similar to a UNIX permission, sets the file mode of the files included.java.util.List<java.lang.String>
getIncludes()
Method getIncludes.java.lang.String
getLineEnding()
Get sets the line-endings of the files in this fileSet.java.lang.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(java.lang.String string)
Method removeExclude.void
removeInclude(java.lang.String string)
Method removeInclude.void
setDirectory(java.lang.String directory)
Set sets the absolute or relative location from the module's directory.void
setDirectoryMode(java.lang.String directoryMode)
Set similar to a UNIX permission, sets the directory mode of the directories included.void
setExcludes(java.util.List<java.lang.String> excludes)
Set when <exclude> subelements are present, they define a set of files and directory to exclude.void
setFileMode(java.lang.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(java.util.List<java.lang.String> includes)
Set when <include> subelements are present, they define a set of files and directory to include.void
setLineEnding(java.lang.String lineEnding)
Set sets the line-endings of the files in this fileSet.void
setOutputDirectory(java.lang.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.
-
-
-
Field Detail
-
useDefaultExcludes
private boolean useDefaultExcludes
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) .
-
outputDirectory
private java.lang.String outputDirectory
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.
-
includes
private java.util.List<java.lang.String> includes
Field includes.
-
excludes
private java.util.List<java.lang.String> excludes
Field excludes.
-
fileMode
private java.lang.String fileMode
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)
-
directoryMode
private java.lang.String directoryMode
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)
-
directory
private java.lang.String directory
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.
-
lineEnding
private java.lang.String lineEnding
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
-
filtered
private boolean filtered
Whether to filter symbols in the files as they are copied, using properties from the build configuration. (Since 2.2) .
-
-
Method Detail
-
addExclude
public void addExclude(java.lang.String string)
Method addExclude.- Parameters:
string
-
-
addInclude
public void addInclude(java.lang.String string)
Method addInclude.- Parameters:
string
-
-
getDirectory
public java.lang.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 java.lang.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 java.util.List<java.lang.String> getExcludes()
Method getExcludes.- Returns:
- List
-
getFileMode
public java.lang.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 java.util.List<java.lang.String> getIncludes()
Method getIncludes.- Returns:
- List
-
getLineEnding
public java.lang.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
-
getOutputDirectory
public java.lang.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(java.lang.String string)
Method removeExclude.- Parameters:
string
-
-
removeInclude
public void removeInclude(java.lang.String string)
Method removeInclude.- Parameters:
string
-
-
setDirectory
public void setDirectory(java.lang.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
-
-
setDirectoryMode
public void setDirectoryMode(java.lang.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
-
-
setExcludes
public void setExcludes(java.util.List<java.lang.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
-
-
setFileMode
public void setFileMode(java.lang.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
-
-
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
-
-
setIncludes
public void setIncludes(java.util.List<java.lang.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
-
-
setLineEnding
public void setLineEnding(java.lang.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
-
-
setOutputDirectory
public void setOutputDirectory(java.lang.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
-
-
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
-
-
-