org.apache.maven.archetype.metadata

Class FileSet

java.lang.Object

org.apache.maven.archetype.metadata.FileSet

All Implemented Interfaces:

java.io.Serializable

public class FileSet
extends java.lang.Object
implements java.io.Serializable

A fileset defines the way the project's files located in the jar file are used by the Archetype Plugin to generate a project. If file or directory name contains __property__ pattern, it is replaced with corresponding property value.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	directory The directory where the files will be searched for, which is also the directory where the project's files will be generated.
private java.lang.String	encoding Encoding to use when filtering content.
private java.util.List<java.lang.String>	excludes Field excludes.
private boolean	filtered Filesets can be filtered, which means the selected files will be used as Velocity templates.
private java.util.List<java.lang.String>	includes Field includes.
private boolean	packaged Filesets can be packaged, which means the selected files will be generated/copied in a directory structure that is prepended by the package property.

Constructor Summary

Constructors

Constructor and Description
FileSet()

Method Summary

Modifier and Type	Method and Description
void	addExclude(java.lang.String string) Method addExclude.
void	addInclude(java.lang.String string) Method addInclude.
java.lang.String	getDirectory() Get the directory where the files will be searched for, which is also the directory where the project's files will be generated.
java.lang.String	getEncoding() Get encoding to use when filtering content.
java.util.List<java.lang.String>	getExcludes() Method getExcludes.
java.util.List<java.lang.String>	getIncludes() Method getIncludes.
boolean	isFiltered() Get filesets can be filtered, which means the selected files will be used as Velocity templates.
boolean	isPackaged() Get filesets can be packaged, which means the selected files will be generated/copied in a directory structure that is prepended by the package property.
void	removeExclude(java.lang.String string) Method removeExclude.
void	removeInclude(java.lang.String string) Method removeInclude.
void	setDirectory(java.lang.String directory) Set the directory where the files will be searched for, which is also the directory where the project's files will be generated.
void	setEncoding(java.lang.String encoding) Set encoding to use when filtering content.
void	setExcludes(java.util.List<java.lang.String> excludes) Set exclusion definition "à la" Ant.
void	setFiltered(boolean filtered) Set filesets can be filtered, which means the selected files will be used as Velocity templates.
void	setIncludes(java.util.List<java.lang.String> includes) Set inclusion definition "à la" Ant.
void	setPackaged(boolean packaged) Set filesets can be packaged, which means the selected files will be generated/copied in a directory structure that is prepended by the package property.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

filtered

private boolean filtered

Filesets can be filtered, which means the selected files will be used as Velocity templates. They can be non-filtered, which means the selected files will be copied without modification.

packaged

private boolean packaged

Filesets can be packaged, which means the selected files will be generated/copied in a directory structure that is prepended by the package property. They can be non-packaged, which means that the selected files will be generated/copied without that prepend.

encoding

private java.lang.String encoding

Encoding to use when filtering content.

directory

private java.lang.String directory

The directory where the files will be searched for, which is also the directory where the project's files will be generated.

includes

private java.util.List<java.lang.String> includes

Field includes.

excludes

private java.util.List<java.lang.String> excludes

Field excludes.

Constructor Detail

FileSet

public FileSet()

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 the directory where the files will be searched for, which is also the directory where the project's files will be generated.

Returns:

String

getEncoding

public java.lang.String getEncoding()

Get encoding to use when filtering content.

Returns:

String

getExcludes

public java.util.List<java.lang.String> getExcludes()

Method getExcludes.

Returns:

List

getIncludes

public java.util.List<java.lang.String> getIncludes()

Method getIncludes.

Returns:

List

isFiltered

public boolean isFiltered()

Get filesets can be filtered, which means the selected files will be used as Velocity templates. They can be non-filtered, which means the selected files will be copied without modification.

Returns:

boolean

isPackaged

public boolean isPackaged()

Get filesets can be packaged, which means the selected files will be generated/copied in a directory structure that is prepended by the package property. They can be non-packaged, which means that the selected files will be generated/copied without that prepend.

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 the directory where the files will be searched for, which is also the directory where the project's files will be generated.

Parameters:

directory -

setEncoding

public void setEncoding(java.lang.String encoding)

Set encoding to use when filtering content.

Parameters:

encoding -

setExcludes

public void setExcludes(java.util.List<java.lang.String> excludes)

Set exclusion definition "à la" Ant.

Parameters:

excludes -

setFiltered

public void setFiltered(boolean filtered)

Set filesets can be filtered, which means the selected files will be used as Velocity templates. They can be non-filtered, which means the selected files will be copied without modification.

Parameters:

filtered -

setIncludes

public void setIncludes(java.util.List<java.lang.String> includes)

Set inclusion definition "à la" Ant.

Parameters:

includes -

setPackaged

public void setPackaged(boolean packaged)

Set filesets can be packaged, which means the selected files will be generated/copied in a directory structure that is prepended by the package property. They can be non-packaged, which means that the selected files will be generated/copied without that prepend.

Parameters:

packaged -

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object