org.apache.ant.compress.resources
Class DumpFileSet

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.types.DataType
          extended by org.apache.tools.ant.types.AbstractFileSet
              extended by org.apache.tools.ant.types.FileSet
                  extended by org.apache.tools.ant.types.ArchiveFileSet
                      extended by org.apache.ant.compress.resources.DumpFileSet
All Implemented Interfaces:
java.lang.Cloneable, org.apache.tools.ant.types.ResourceCollection, org.apache.tools.ant.types.selectors.SelectorContainer

public class DumpFileSet
extends org.apache.tools.ant.types.ArchiveFileSet

A DumpFileSet is a FileSet with extra attributes useful in the context of Dump tasks. A DumpFileSet extends FileSets with the ability to extract a subset of the entries of a Dump file for inclusion in another Dump file. It also includes a prefix attribute which is prepended to each entry in the output Dump file.

Since:
Apache Compress Antlib 1.1

Field Summary
 
Fields inherited from class org.apache.tools.ant.types.ArchiveFileSet
DEFAULT_DIR_MODE, DEFAULT_FILE_MODE
 
Fields inherited from class org.apache.tools.ant.types.DataType
checked, ref
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
 
Constructor Summary
  DumpFileSet()
          Constructor for DumpFileSet
protected DumpFileSet(DumpFileSet fileset)
          Constructor using a dumpfileset arguement.
protected DumpFileSet(org.apache.tools.ant.types.FileSet fileset)
          Constructor using a fileset arguement.
 
Method Summary
 java.lang.Object clone()
          Return a DumpFileSet that has the same properties as this one.
protected  void configureFileSet(org.apache.tools.ant.types.ArchiveFileSet zfs)
          Configure a fileset based on this fileset.
 int getGid()
           
protected  org.apache.tools.ant.types.AbstractFileSet getRef(org.apache.tools.ant.Project p)
          A DumpFileset accepts another DumpFileSet or a FileSet as reference FileSets are often used by the war task for the lib attribute
 int getUid()
           
 boolean hasGroupIdBeenSet()
           
 boolean hasUserIdBeenSet()
           
protected  org.apache.tools.ant.types.ArchiveScanner newArchiveScanner()
          Create a new scanner.
 void setGid(int gid)
          The GID for the dump entry; optional, default="0" This is not the same as the group name.
 void setRefid(org.apache.tools.ant.types.Reference r)
          Makes this instance in effect a reference to another instance.
 void setSkipUnreadableEntries(boolean b)
          Whether to skip entries that Commons Compress signals it cannot read.
 void setUid(int uid)
          The uid for the dump entry This is not the same as the User name.
 
Methods inherited from class org.apache.tools.ant.types.ArchiveFileSet
addConfigured, dieOnCircularReference, getCheckedRef, getDirectoryScanner, getDirMode, getDirMode, getFileMode, getFileMode, getFullpath, getFullpath, getPrefix, getPrefix, getSrc, getSrc, hasDirModeBeenSet, hasFileModeBeenSet, integerSetDirMode, integerSetFileMode, isFilesystemOnly, iterator, setDir, setDirMode, setErrorOnMissingArchive, setFileMode, setFullpath, setPrefix, setSrc, setSrcResource, size, toString
 
Methods inherited from class org.apache.tools.ant.types.AbstractFileSet
add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addReadable, addSelector, addSize, addType, addWritable, appendExcludes, appendIncludes, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDefaultexcludes, getDir, getDir, getDirectoryScanner, getErrorOnMissingDir, getMaxLevelsOfSymlinks, getSelectors, hasPatterns, hasSelectors, isCaseSensitive, isFollowSymlinks, mergeExcludes, mergeIncludes, mergePatterns, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setErrorOnMissingDir, setExcludes, setExcludesfile, setFile, setFollowSymlinks, setIncludes, setIncludesfile, setMaxLevelsOfSymlinks, setupDirectoryScanner, setupDirectoryScanner
 
Methods inherited from class org.apache.tools.ant.types.DataType
checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DumpFileSet

public DumpFileSet()
Constructor for DumpFileSet


DumpFileSet

protected DumpFileSet(org.apache.tools.ant.types.FileSet fileset)
Constructor using a fileset arguement.

Parameters:
fileset - the fileset to use

DumpFileSet

protected DumpFileSet(DumpFileSet fileset)
Constructor using a dumpfileset arguement.

Parameters:
fileset - the dumpfileset to use
Method Detail

setUid

public void setUid(int uid)
The uid for the dump entry This is not the same as the User name.

Parameters:
uid - the id of the user for the dump entry.

getUid

public int getUid()
Returns:
the uid for the dump entry

hasUserIdBeenSet

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

setGid

public void setGid(int gid)
The GID for the dump 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.

setSkipUnreadableEntries

public void setSkipUnreadableEntries(boolean b)
Whether to skip entries that Commons Compress signals it cannot read.


newArchiveScanner

protected org.apache.tools.ant.types.ArchiveScanner newArchiveScanner()
Create a new scanner.

Specified by:
newArchiveScanner in class org.apache.tools.ant.types.ArchiveFileSet
Returns:
the created scanner.

setRefid

public void setRefid(org.apache.tools.ant.types.Reference r)
              throws org.apache.tools.ant.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 org.apache.tools.ant.types.AbstractFileSet
Parameters:
r - the Reference to use.
Throws:
org.apache.tools.ant.BuildException - on error

getRef

protected org.apache.tools.ant.types.AbstractFileSet getRef(org.apache.tools.ant.Project p)
A DumpFileset accepts another DumpFileSet or a FileSet as reference FileSets are often used by the war task for the lib attribute

Overrides:
getRef in class org.apache.tools.ant.types.AbstractFileSet
Parameters:
p - the project to use
Returns:
the abstract fileset instance

configureFileSet

protected void configureFileSet(org.apache.tools.ant.types.ArchiveFileSet zfs)
Configure a fileset based on this fileset. If the fileset is a DumpFileSet copy in the dumpfileset specific attributes.

Overrides:
configureFileSet in class org.apache.tools.ant.types.ArchiveFileSet
Parameters:
zfs - the archive fileset to configure.

clone

public java.lang.Object clone()
Return a DumpFileSet that has the same properties as this one.

Overrides:
clone in class org.apache.tools.ant.types.ArchiveFileSet
Returns:
the cloned dumpFileSet