Package org.apache.maven.archetype.metadata

Class FileSet

java.lang.Object
org.apache.maven.archetype.metadata.FileSet
All Implemented Interfaces:
Serializable
public class FileSet extends Object implements 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:

  • Constructor Details

    • FileSet

      public FileSet()

  • Method Details

    • addExclude

      public void addExclude(String string)
      Method addExclude.
      Parameters:
      string - a string object.

    • addInclude

      public void addInclude(String string)
      Method addInclude.
      Parameters:
      string - a string object.

    • getDirectory

      public 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 String getEncoding()
      Get encoding to use when filtering content.
      Returns:
      String

    • getExcludes

      public List<String> getExcludes()
      Method getExcludes.
      Returns:
      List

    • getIncludeCondition

      public String getIncludeCondition()
      Get a string value that should resolve to a boolean value to conditionally include filesets. This condition should be either a boolean as String or a velocity template language statement that resolves to a boolean value. If the descriptor contains includeCondition="${shouldInclude}" and the archetype has a (required) property like shouldInclude=true the fileset is included.
      Returns:
      String

    • getIncludes

      public List<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(String string)
      Method removeExclude.
      Parameters:
      string - a string object.

    • removeInclude

      public void removeInclude(String string)
      Method removeInclude.
      Parameters:
      string - a string object.

    • setDirectory

      public void setDirectory(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 - a directory object.

    • setEncoding

      public void setEncoding(String encoding)
      Set encoding to use when filtering content.
      Parameters:
      encoding - a encoding object.

    • setExcludes

      public void setExcludes(List<String> excludes)
      Set exclusion definition "à la" Ant.
      Parameters:
      excludes - a excludes object.

    • 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 - a filtered object.

    • setIncludeCondition

      public void setIncludeCondition(String includeCondition)
      Set a string value that should resolve to a boolean value to conditionally include filesets. This condition should be either a boolean as String or a velocity template language statement that resolves to a boolean value. If the descriptor contains includeCondition="${shouldInclude}" and the archetype has a (required) property like shouldInclude=true the fileset is included.
      Parameters:
      includeCondition - a includeCondition object.

    • setIncludes

      public void setIncludes(List<String> includes)
      Set inclusion definition "à la" Ant.
      Parameters:
      includes - a includes object.

    • 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 - a packaged object.

    • toString

      public String toString()
      Overrides:
      toString in class Object