Package org.apache.maven.plugins.assembly.model

Class 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:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      UnpackOptions()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addExclude​(String string)
      Method addExclude.
      void addInclude​(String string)
      Method addInclude.
      String getEncoding()
      Get allows to specify the encoding to use when unpacking archives, for unarchivers that support specifying encoding.
      List<String> getExcludes()
      Method getExcludes.
      List<String> getIncludes()
      Method getIncludes.
      String getLineEnding()
      Get sets the line-endings of the files.
      boolean isFiltered()
      Get whether to filter symbols in the files as they are unpacked from the archive, using properties from the build configuration.
      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.
      void removeExclude​(String string)
      Method removeExclude.
      void removeInclude​(String string)
      Method removeInclude.
      void setEncoding​(String encoding)
      Set allows to specify the encoding to use when unpacking archives, for unarchivers that support specifying encoding.
      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.
      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.
      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.
      void setLineEnding​(String lineEnding)
      Set sets the line-endings of the files.
      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.

    • Constructor Detail

      • UnpackOptions

        public UnpackOptions()

    • Method Detail

      • addExclude

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

      • addInclude

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

      • 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

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

      • removeInclude

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

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

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

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

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

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

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