org.apache.maven.plugin.assembly.model.FileSet Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-assembly-plugin Show documentation
Show all versions of maven-assembly-plugin Show documentation
A Maven plugin to create archives of your project's sources, classes, dependencies etc. from flexible assembly descriptors.
// =================== DO NOT EDIT THIS FILE ====================
// Generated by Modello 1.8.1,
// any modifications will be overwritten.
// ==============================================================
package org.apache.maven.plugin.assembly.model;
/**
*
* A fileSet allows the inclusion of groups of files into
* the assembly.
*
*
* @version $Revision$ $Date$
*/
@SuppressWarnings( "all" )
public class FileSet
implements java.io.Serializable
{
//--------------------------/
//- Class/Member Variables -/
//--------------------------/
/**
*
* 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)
* .
*/
private boolean useDefaultExcludes = true;
/**
*
* 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.
*
*/
private String outputDirectory;
/**
* Field includes.
*/
private java.util.List includes;
/**
* Field excludes.
*/
private java.util.List excludes;
/**
*
*
* 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.
* (more
* on unix-style permissions)
*
*
*/
private String fileMode;
/**
*
*
* 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.
* (more
* on unix-style permissions)
*
*
*/
private String directoryMode;
/**
*
* 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.
*
*/
private String directory;
/**
*
*
* 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
*
*
*
*/
private String lineEnding;
/**
*
* Whether to filter symbols in the files as they are
* copied, using
* properties from the build configuration. (Since
* 2.2)
* .
*/
private boolean filtered = false;
//-----------/
//- Methods -/
//-----------/
/**
* Method addExclude.
*
* @param string
*/
public void addExclude( String string )
{
getExcludes().add( string );
} //-- void addExclude( String )
/**
* Method addInclude.
*
* @param string
*/
public void addInclude( String string )
{
getIncludes().add( string );
} //-- void addInclude( String )
/**
* 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.
*
* @return String
*/
public String getDirectory()
{
return this.directory;
} //-- String getDirectory()
/**
* 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.
* (more
* on unix-style permissions)
*
* @return String
*/
public String getDirectoryMode()
{
return this.directoryMode;
} //-- String getDirectoryMode()
/**
* Method getExcludes.
*
* @return List
*/
public java.util.List getExcludes()
{
if ( this.excludes == null )
{
this.excludes = new java.util.ArrayList();
}
return this.excludes;
} //-- java.util.List getExcludes()
/**
* 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.
* (more
* on unix-style permissions)
*
* @return String
*/
public String getFileMode()
{
return this.fileMode;
} //-- String getFileMode()
/**
* Method getIncludes.
*
* @return List
*/
public java.util.List getIncludes()
{
if ( this.includes == null )
{
this.includes = new java.util.ArrayList();
}
return this.includes;
} //-- java.util.List getIncludes()
/**
* 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
*
*
* @return String
*/
public String getLineEnding()
{
return this.lineEnding;
} //-- String getLineEnding()
/**
* 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.
*
* @return String
*/
public String getOutputDirectory()
{
return this.outputDirectory;
} //-- String getOutputDirectory()
/**
* Get whether to filter symbols in the files as they are
* copied, using
* properties from the build configuration. (Since
* 2.2).
*
* @return boolean
*/
public boolean isFiltered()
{
return this.filtered;
} //-- boolean isFiltered()
/**
* 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).
*
* @return boolean
*/
public boolean isUseDefaultExcludes()
{
return this.useDefaultExcludes;
} //-- boolean isUseDefaultExcludes()
/**
* Method removeExclude.
*
* @param string
*/
public void removeExclude( String string )
{
getExcludes().remove( string );
} //-- void removeExclude( String )
/**
* Method removeInclude.
*
* @param string
*/
public void removeInclude( String string )
{
getIncludes().remove( string );
} //-- void removeInclude( String )
/**
* 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.
*
* @param directory
*/
public void setDirectory( String directory )
{
this.directory = directory;
} //-- void setDirectory( String )
/**
* 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.
* (more
* on unix-style permissions)
*
* @param directoryMode
*/
public void setDirectoryMode( String directoryMode )
{
this.directoryMode = directoryMode;
} //-- void setDirectoryMode( String )
/**
* 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.
*
* @param excludes
*/
public void setExcludes( java.util.List excludes )
{
this.excludes = excludes;
} //-- void setExcludes( java.util.List )
/**
* 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.
* (more
* on unix-style permissions)
*
* @param fileMode
*/
public void setFileMode( String fileMode )
{
this.fileMode = fileMode;
} //-- void setFileMode( String )
/**
* Set whether to filter symbols in the files as they are
* copied, using
* properties from the build configuration. (Since
* 2.2).
*
* @param filtered
*/
public void setFiltered( boolean filtered )
{
this.filtered = filtered;
} //-- void setFiltered( boolean )
/**
* 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.
*
* @param includes
*/
public void setIncludes( java.util.List includes )
{
this.includes = includes;
} //-- void setIncludes( java.util.List )
/**
* 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
*
*
* @param lineEnding
*/
public void setLineEnding( String lineEnding )
{
this.lineEnding = lineEnding;
} //-- void setLineEnding( String )
/**
* 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.
*
* @param outputDirectory
*/
public void setOutputDirectory( String outputDirectory )
{
this.outputDirectory = outputDirectory;
} //-- void setOutputDirectory( String )
/**
* 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).
*
* @param useDefaultExcludes
*/
public void setUseDefaultExcludes( boolean useDefaultExcludes )
{
this.useDefaultExcludes = useDefaultExcludes;
} //-- void setUseDefaultExcludes( boolean )
}