Class UnpackOptions

java.lang.Object
org.apache.maven.plugins.assembly.model.UnpackOptions
All Implemented Interfaces:
Serializable
public class UnpackOptions extends Object implements Serializable
Specifies options for including/excluding/filtering items extracted from an archive. (Since 2.2) .
Version:
$Revision$ $Date$
See Also:

  • Constructor Details

    • UnpackOptions

      public UnpackOptions()

  • 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.

    • addNonFilteredFileExtension

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

    • getEncoding

      public String getEncoding()
      Get allows to specify the encoding to use when unpacking archives, for unarchivers that support specifying encoding. If unspecified, archiver default will be used. Archiver defaults generally represent sane (modern) values.
      Returns:
      String

    • getExcludes

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

    • getIncludes

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

    • getLineEnding

      public String getLineEnding()
      Get sets the line-endings of the files. (Since 2.2) 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
      Returns:
      String

    • getNonFilteredFileExtensions

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

    • isFiltered

      public boolean isFiltered()
      Get whether to filter symbols in the files as they are unpacked from the archive, using properties from the build configuration. (Since 2.2).
      Returns:
      boolean

    • 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. For backward compatibility, the default value is true. (Since 2.2).
      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.

    • removeNonFilteredFileExtension

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

    • setEncoding

      public void setEncoding(String encoding)
      Set allows to specify the encoding to use when unpacking archives, for unarchivers that support specifying encoding. If unspecified, archiver default will be used. Archiver defaults generally represent sane (modern) values.
      Parameters:
      encoding - a encoding object.

    • setExcludes

      public void setExcludes(List<String> excludes)
      Set set of file and/or directory patterns for matching items to be excluded from an archive as it is unpacked. Each item is specified as <exclude>some/path</exclude> (Since 2.2).
      Parameters:
      excludes - a excludes object.

    • setFiltered

      public void setFiltered(boolean filtered)
      Set whether to filter symbols in the files as they are unpacked from the archive, using properties from the build configuration. (Since 2.2).
      Parameters:
      filtered - a filtered object.

    • setIncludes

      public void setIncludes(List<String> includes)
      Set set of file and/or directory patterns for matching items to be included from an archive as it is unpacked. Each item is specified as <include>some/path</include> (Since 2.2).
      Parameters:
      includes - a includes object.

    • setLineEnding

      public void setLineEnding(String lineEnding)
      Set sets the line-endings of the files. (Since 2.2) 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
      Parameters:
      lineEnding - a lineEnding object.

    • setNonFilteredFileExtensions

      public void setNonFilteredFileExtensions(List<String> nonFilteredFileExtensions)
      Set additional file extensions to not apply filtering (Since 3.2.0).
      Parameters:
      nonFilteredFileExtensions - a nonFilteredFileExtensions object.

    • setUseDefaultExcludes

      public void 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. For backward compatibility, the default value is true. (Since 2.2).
      Parameters:
      useDefaultExcludes - a useDefaultExcludes object.