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
A Maven plugin to create archives of your project's sources, classes, dependencies etc. from flexible assembly descriptors.
There is a newer version: 3.7.1
Show newest version
/*
 * $Id$
 */

package org.apache.maven.plugin.assembly.model;

  //---------------------------------/
 //- Imported classes and packages -/
//---------------------------------/

import java.util.Date;

/**
 * 
 *         A fileSet allows the inclusion of groups of files into
 * the assembly.
 *       
 * 
 * @version $Revision$ $Date$
 */
public class FileSet extends SetBase 
implements java.io.Serializable
{


      //--------------------------/
     //- Class/Member Variables -/
    //--------------------------/

    /**
     * 
     *             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.
     *           
     */
    private boolean filtered = false;


      //-----------/
     //- Methods -/
    //-----------/

    /**
     * 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 
     *             
     *             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 
     *           Whether to filter symbols in the files as they are
     * copied, using
     *           properties from the build configuration.
     *           
     * 
     * @return boolean
     */
    public boolean isFiltered()
    {
        return this.filtered;
    } //-- boolean isFiltered() 

    /**
     * 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 
     *           Whether to filter symbols in the files as they are
     * copied, using
     *           properties from the build configuration.
     *           
     * 
     * @param filtered
     */
    public void setFiltered(boolean filtered)
    {
        this.filtered = filtered;
    } //-- void setFiltered(boolean) 

    /**
     * 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) 


    private String modelEncoding = "UTF-8";

    /**
     * Set an encoding used for reading/writing the model.
     *
     * @param modelEncoding the encoding used when reading/writing the model.
     */
    public void setModelEncoding( String modelEncoding )
    {
        this.modelEncoding = modelEncoding;
    }

    /**
     * @return the current encoding used when reading/writing this model.
     */
    public String getModelEncoding()
    {
        return modelEncoding;
    }
}