Class TarFileSet

  • All Implemented Interfaces:
    java.lang.Cloneable, java.lang.Iterable<Resource>, ResourceCollection, SelectorContainer
    Direct Known Subclasses:
    Tar.TarFileSet

    public class TarFileSet
    extends ArchiveFileSet
    A TarFileSet is a FileSet with extra attributes useful in the context of Tar/Jar tasks. A TarFileSet extends FileSets with the ability to extract a subset of the entries of a Tar file for inclusion in another Tar file. It also includes a prefix attribute which is prepended to each entry in the output Tar file.
    • Constructor Detail

      • TarFileSet

        public TarFileSet()
        Constructor for TarFileSet
      • TarFileSet

        protected TarFileSet​(FileSet fileset)
        Constructor using a fileset argument.
        Parameters:
        fileset - the fileset to use
      • TarFileSet

        protected TarFileSet​(TarFileSet fileset)
        Constructor using a tarfileset argument.
        Parameters:
        fileset - the tarfileset to use
    • Method Detail

      • setUserName

        public void setUserName​(java.lang.String userName)
        The username for the tar entry This is not the same as the UID.
        Parameters:
        userName - the user name for the tar entry.
      • getUserName

        public java.lang.String getUserName()
        Returns:
        the user name for the tar entry
      • hasUserNameBeenSet

        public boolean hasUserNameBeenSet()
        Returns:
        whether the user name has been explicitly set.
      • setUid

        public void setUid​(int uid)
        The uid for the tar entry This is not the same as the User name.
        Parameters:
        uid - the id of the user for the tar entry.
      • getUid

        public int getUid()
        Returns:
        the uid for the tar entry
      • hasUserIdBeenSet

        public boolean hasUserIdBeenSet()
        Returns:
        whether the user id has been explicitly set.
      • setGroup

        public void setGroup​(java.lang.String groupName)
        The groupname for the tar entry; optional, default="" This is not the same as the GID.
        Parameters:
        groupName - the group name string.
      • getGroup

        public java.lang.String getGroup()
        Returns:
        the group name string.
      • hasGroupBeenSet

        public boolean hasGroupBeenSet()
        Returns:
        whether the group name has been explicitly set.
      • setGid

        public void setGid​(int gid)
        The GID for the tar entry; optional, default="0" This is not the same as the group name.
        Parameters:
        gid - the group id.
      • getGid

        public int getGid()
        Returns:
        the group identifier.
      • hasGroupIdBeenSet

        public boolean hasGroupIdBeenSet()
        Returns:
        whether the group id has been explicitly set.
      • setRefid

        public void setRefid​(Reference r)
                      throws BuildException
        Makes this instance in effect a reference to another instance.

        You must not set another attribute or nest elements inside this element if you make it a reference.

        Overrides:
        setRefid in class AbstractFileSet
        Parameters:
        r - the Reference to use.
        Throws:
        BuildException - on error
      • getRef

        protected AbstractFileSet getRef​(Project p)
        A TarFileset accepts another TarFileSet or a FileSet as reference FileSets are often used by the war task for the lib attribute
        Overrides:
        getRef in class FileSet
        Parameters:
        p - the project to use
        Returns:
        the abstract fileset instance
      • getRef

        protected AbstractFileSet getRef()
        A TarFileset accepts another TarFileSet or a FileSet as reference FileSets are often used by the war task for the lib attribute
        Overrides:
        getRef in class ArchiveFileSet
        Returns:
        the abstract fileset instance
      • configureFileSet

        protected void configureFileSet​(ArchiveFileSet zfs)
        Configure a fileset based on this fileset. If the fileset is a TarFileSet copy in the tarfileset specific attributes.
        Overrides:
        configureFileSet in class ArchiveFileSet
        Parameters:
        zfs - the archive fileset to configure.
      • clone

        public java.lang.Object clone()
        Return a TarFileSet that has the same properties as this one.
        Overrides:
        clone in class ArchiveFileSet
        Returns:
        the cloned tarFileSet