Class SetBase

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    FileSet

    public class SetBase
    extends java.lang.Object
    implements java.io.Serializable
    Class SetBase.
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.String directoryMode
      Similar to a UNIX permission.
      private java.util.List<java.lang.String> excludes
      Field excludes.
      private java.lang.String fileMode
      Similar to a UNIX permission.
      private boolean followSymlinks
      Specifies whether symbolic links should be traversed, or handled as-is.
      private java.util.List<java.lang.String> includes
      Field includes.
      private Mapper mapper
      Specifies the mapper used.
      private java.lang.String outputDirectory
      Specifies the output directory relative to the root of the root directory of the assembly.
      private boolean useDefaultExcludes
      Whether to include exclusion patterns for common temporary and SCM control files (true by default).
    • Constructor Summary

      Constructors 
      Constructor Description
      SetBase()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addExclude​(java.lang.String string)
      Method addExclude.
      void addInclude​(java.lang.String string)
      Method addInclude.
      java.lang.String getDirectoryMode()
      Get similar to a UNIX permission.
      java.util.List<java.lang.String> getExcludes()
      Method getExcludes.
      java.lang.String[] getExcludesArray()  
      java.lang.String getFileMode()
      Get similar to a UNIX permission.
      java.util.List<java.lang.String> getIncludes()
      Method getIncludes.
      java.lang.String[] getIncludesArray()  
      Mapper getMapper()
      Get specifies the mapper used.
      java.lang.String getOutputDirectory()
      Get specifies the output directory relative to the root of the root directory of the assembly.
      boolean isFollowSymlinks()
      Get specifies whether symbolic links should be traversed, or handled as-is.
      boolean isUseDefaultExcludes()
      Get whether to include exclusion patterns for common temporary and SCM control files (true by default).
      void removeExclude​(java.lang.String string)
      Method removeExclude.
      void removeInclude​(java.lang.String string)
      Method removeInclude.
      void setDirectoryMode​(java.lang.String directoryMode)
      Set similar to a UNIX permission.
      void setExcludes​(java.util.List<java.lang.String> excludes)
      Set when <exclude> subelements are present, they define a set of files and directory to exclude.
      void setFileMode​(java.lang.String fileMode)
      Set similar to a UNIX permission.
      void setFollowSymlinks​(boolean followSymlinks)
      Set specifies whether symbolic links should be traversed, or handled as-is.
      void setIncludes​(java.util.List<java.lang.String> includes)
      Set when <include> subelements are present, they define a set of files and directory to include.
      void setMapper​(Mapper mapper)
      Set specifies the mapper used.
      void setOutputDirectory​(java.lang.String outputDirectory)
      Set specifies the output directory relative to the root of the root directory of the assembly.
      void setUseDefaultExcludes​(boolean useDefaultExcludes)
      Set whether to include exclusion patterns for common temporary and SCM control files (true by default).
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • followSymlinks

        private boolean followSymlinks
        Specifies whether symbolic links should be traversed, or handled as-is.
      • outputDirectory

        private java.lang.String outputDirectory
        Specifies 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.
      • useDefaultExcludes

        private boolean useDefaultExcludes
        Whether to include exclusion patterns for common temporary and SCM control files (true by default).
      • includes

        private java.util.List<java.lang.String> includes
        Field includes.
      • excludes

        private java.util.List<java.lang.String> excludes
        Field excludes.
      • fileMode

        private java.lang.String fileMode
        Similar to a UNIX permission. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the default value of 0644 translates to User read-write, Group and Other read-only. (more on unix-style permissions)
      • directoryMode

        private java.lang.String directoryMode
        Similar to a UNIX permission. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the default value of 0755 translates to User read-write, Group and Other read-only. (more on unix-style permissions)
      • mapper

        private Mapper mapper
        Specifies the mapper used.
    • Constructor Detail

      • SetBase

        public SetBase()
    • Method Detail

      • addExclude

        public void addExclude​(java.lang.String string)
        Method addExclude.
        Parameters:
        string -
      • addInclude

        public void addInclude​(java.lang.String string)
        Method addInclude.
        Parameters:
        string -
      • getDirectoryMode

        public java.lang.String getDirectoryMode()
        Get similar to a UNIX permission. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the default value of 0755 translates to User read-write, Group and Other read-only. (more on unix-style permissions)
        Returns:
        String
      • getExcludes

        public java.util.List<java.lang.String> getExcludes()
        Method getExcludes.
        Returns:
        List
      • getFileMode

        public java.lang.String getFileMode()
        Get similar to a UNIX permission. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the default value of 0644 translates to User read-write, Group and Other read-only. (more on unix-style permissions)
        Returns:
        String
      • getIncludes

        public java.util.List<java.lang.String> getIncludes()
        Method getIncludes.
        Returns:
        List
      • getMapper

        public Mapper getMapper()
        Get specifies the mapper used.
        Returns:
        Mapper
      • getOutputDirectory

        public java.lang.String getOutputDirectory()
        Get specifies 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.
        Returns:
        String
      • isFollowSymlinks

        public boolean isFollowSymlinks()
        Get specifies whether symbolic links should be traversed, or handled as-is.
        Returns:
        boolean
      • isUseDefaultExcludes

        public boolean isUseDefaultExcludes()
        Get whether to include exclusion patterns for common temporary and SCM control files (true by default).
        Returns:
        boolean
      • removeExclude

        public void removeExclude​(java.lang.String string)
        Method removeExclude.
        Parameters:
        string -
      • removeInclude

        public void removeInclude​(java.lang.String string)
        Method removeInclude.
        Parameters:
        string -
      • setDirectoryMode

        public void setDirectoryMode​(java.lang.String directoryMode)
        Set similar to a UNIX permission. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the default value of 0755 translates to User read-write, Group and Other read-only. (more on unix-style permissions)
        Parameters:
        directoryMode -
      • setExcludes

        public void setExcludes​(java.util.List<java.lang.String> excludes)
        Set when <exclude> subelements are present, they define a set of files and directory to exclude.
        Parameters:
        excludes -
      • setFileMode

        public void setFileMode​(java.lang.String fileMode)
        Set similar to a UNIX permission. Format: (User)(Group)(Other) where each component is a sum of Read = 4, Write = 2, and Execute = 1. For example, the default value of 0644 translates to User read-write, Group and Other read-only. (more on unix-style permissions)
        Parameters:
        fileMode -
      • setFollowSymlinks

        public void setFollowSymlinks​(boolean followSymlinks)
        Set specifies whether symbolic links should be traversed, or handled as-is.
        Parameters:
        followSymlinks -
      • setIncludes

        public void setIncludes​(java.util.List<java.lang.String> includes)
        Set when <include> subelements are present, they define a set of files and directory to include.
        Parameters:
        includes -
      • setMapper

        public void setMapper​(Mapper mapper)
        Set specifies the mapper used.
        Parameters:
        mapper -
      • setOutputDirectory

        public void setOutputDirectory​(java.lang.String outputDirectory)
        Set specifies 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.
        Parameters:
        outputDirectory -
      • setUseDefaultExcludes

        public void setUseDefaultExcludes​(boolean useDefaultExcludes)
        Set whether to include exclusion patterns for common temporary and SCM control files (true by default).
        Parameters:
        useDefaultExcludes -
      • getIncludesArray

        public java.lang.String[] getIncludesArray()
        Returns:
        the file-set inclusion rules in array form.
      • getExcludesArray

        public java.lang.String[] getExcludesArray()
        Returns:
        the file-set exclusion rules in array form.