io.reactiverse.vertx.maven.plugin.mojos

Class FileSet

java.lang.Object

io.reactiverse.vertx.maven.plugin.mojos.FileSet

public class FileSet
extends Object

A fileSet allows the inclusion of groups of files into the archive.

Author:

Clement Escoffier

Field Summary

Fields

Modifier and Type	Field and Description
private String	directory Sets the absolute or relative location from the module's directory.
private List<String>	excludes Set of excludes excludes.
private List<String>	includes Set of includes.
private String	outputDirectory Sets the output directory relative to the root of the root directory of the archive.
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 and Description
FileSet()

Method Summary

Modifier and Type	Method and Description
FileSet	addExclude(String pattern) Adds an exclusion
FileSet	addInclude(String pattern) Adds an inclusion
String	getDirectory() Get sets the absolute or relative location from the module's directory.
List<String>	getExcludes()
List<String>	getIncludes()
String	getOutputDirectory() Get sets the output directory relative to the root of the root directory of the archive.
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.
FileSet	removeExclude(String pattern) Removes an exclusion pattern.
FileSet	removeInclude(String pattern) Removes an inclusion pattern.
FileSet	setDirectory(String directory) Set sets the absolute or relative location from the module's directory.
FileSet	setExcludes(List<String> excludes) Set when <exclude> subelements are present, they define a set of files and directory to exclude.
FileSet	setIncludes(List<String> includes) Set when <include> subelements are present, they define a set of files and directory to include.
FileSet	setOutputDirectory(String outputDirectory) Set sets the output directory relative to the root of the root directory of the archive.
FileSet	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

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. The default value is true.

outputDirectory

private String outputDirectory

Sets the output directory relative to the root of the root directory of the archive. For example, "bin" will put the specified files in the bin directory into the archive.

includes

private List<String> includes

Set of includes.

excludes

private List<String> excludes

Set of excludes excludes.

directory

private 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 file set is defined.

Constructor Detail

FileSet

public FileSet()

Method Detail

addExclude

public FileSet addExclude(String pattern)

Adds an exclusion

Parameters:

pattern - the exclusion

addInclude

public FileSet addInclude(String pattern)

Adds an inclusion

Parameters:

pattern - the pattern

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 set is defined.

Returns:

the directory

getExcludes

public List<String> getExcludes()

Returns:

the list of exclusion patterns, empty if not set.

getIncludes

public List<String> getIncludes()

Returns:

the list of inclusion patterns, empty if not set.

getOutputDirectory

public String getOutputDirectory()

Get sets the output directory relative to the root of the root directory of the archive. For example, "bin" will put the specified files in the bin directory.

Returns:

the output directory

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. The default value is true.

Returns:

whether or not the default excluded should be added to the set of exclusion patterns

removeExclude

public FileSet removeExclude(String pattern)

Removes an exclusion pattern.

Parameters:

pattern - the pattern

removeInclude

public FileSet removeInclude(String pattern)

Removes an inclusion pattern.

Parameters:

pattern - the pattern

setDirectory

public FileSet 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 set is defined.

Parameters:

directory - the directory

setExcludes

public FileSet 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 - the set of exclusions

setIncludes

public FileSet 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 - the set of inclusions

setOutputDirectory

public FileSet setOutputDirectory(String outputDirectory)

Set sets the output directory relative to the root of the root directory of the archive. For example, "bin" will put the specified files in the bin directory.

Parameters:

outputDirectory - the output directory

setUseDefaultExcludes

public FileSet 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. the default value is true.

Parameters:

useDefaultExcludes - whether or not the default excluded should be added to the set of exclusions