FileSet

A definition of a file-set. This model defines how file-sets can be captured, using directory, includes, and excludes. 

<fileSet>
  <directory/>
  <lineEnding/>
  <followSymlinks/>
  <outputDirectory/>
  <useDefaultExcludes/>
  <includes/>
  <excludes/>
  <fileMode/>
  <directoryMode/>
  <mapper>
    <type/>
    <from/>
    <to/>
    <classname/>
  </mapper>
</fileSet>

fileSet

Defines the rules for matching and working with files in a given base directory.

Element Type Description
directory String Absolute or relative from the module's directory. For example, "src/main/bin" would select this subdirectory of the project in which this dependency is defined.
lineEnding String Controls the line-endings of 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
followSymlinks boolean Specifies whether symbolic links should be traversed, or handled as-is.
Default value is: false.
outputDirectory String Specifies 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.
useDefaultExcludes boolean Whether to include exclusion patterns for common temporary and SCM control files (true by default).
Default value is: true.
includes/include* List<String> (Many) When <include> subelements are present, they define a set of files and directory to include.
excludes/exclude* List<String> (Many) When <exclude> subelements are present, they define a set of files and directory to exclude.
fileMode String Similar to a UNIX permission. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the default value of 0644 translates to User read-write, Group and Other read-only. (more on unix-style permissions)
Default value is: 0644.
directoryMode String Similar to a UNIX permission. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the default value of 0755 translates to User read-write, Group and Other read-only. (more on unix-style permissions)
Default value is: 0755.
mapper Mapper Specifies the mapper used.

mapper

No description.

Element Type Description
type String Specifies a built-in mapper implementation.
Valid values:
  • "flatten" - The target file name is identical to the source file name, with all leading directory information stripped off. Both to and from will be ignored.
  • "glob" - Both to and from define patterns that may contain at most one *. For each source file that matches the from pattern, a target file name will be constructed from the to pattern by substituting the * in the to pattern with the text that matches the * in the from pattern. Source file names that don't match the from pattern will be ignored.
  • "regexp" - Both to and from define regular expressions. If the source file name matches the from pattern, the target file name will be constructed from the to pattern, using \0 to \9 as back-references for the full match (\0) or the matches of the subexpressions in parentheses. Source files not matching the from pattern will be ignored.
  • "merge" - The target file name will always be the same, as defined by to. from will be ignored.
  • "package" - Sharing the same syntax as the glob mapper, the package mapper replaces directory separators found in the matched source pattern with dots in the target pattern placeholder.
  • "unpackage" - This mapper is the inverse of the package mapper. It replaces the dots in a package name with directory separators. This is useful for matching XML formatter results against their JUnit test test cases. The mapper shares the sample syntax as the glob mapper.

Default value is: identity.
from String Specifies a type-specific pattern for matching source paths which should be mapped.
to String Specifies a type-specific pattern for producing paths based on source paths.
classname String Allows specification of a custom mapper implementation. The class must be of type org.apache.maven.shared.model.fileset.mappers.FileNameMapper, from the artifact org.apache.maven.shared:file-management.