Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.tools.ant.types

Class TarFileSet

Implemented Interfaces:
Cloneable, ResourceCollection, SelectorContainer
Known Direct 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.

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

TarFileSet()
Constructor for TarFileSet
TarFileSet(FileSet fileset)
Constructor using a fileset arguement.
TarFileSet(TarFileSet fileset)
Constructor using a tarfileset arguement.

Method Summary

Object
clone()
Return a TarFileSet that has the same properties as this one.
protected void
configureFileSet(ArchiveFileSet zfs)
Configure a fileset based on this fileset.
int
getGid()
String
getGroup()
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
int
getUid()
String
getUserName()
boolean
hasGroupBeenSet()
boolean
hasGroupIdBeenSet()
boolean
hasUserIdBeenSet()
boolean
hasUserNameBeenSet()
protected ArchiveScanner
newArchiveScanner()
Create a new scanner.
void
setGid(int gid)
The GID for the tar entry; optional, default="0" This is not the same as the group name.
void
setGroup(String groupName)
The groupname for the tar entry; optional, default="" This is not the same as the GID.
void
setRefid(Reference r)
Makes this instance in effect a reference to another instance.
void
setUid(int uid)
The uid for the tar entry This is not the same as the User name.
void
setUserName(String userName)
The username for the tar entry This is not the same as the UID.

Methods inherited from class org.apache.tools.ant.types.ArchiveFileSet

addConfigured, clone, configureFileSet, getDirMode, getDirMode, getDirectoryScanner, getFileMode, getFileMode, getFullpath, getFullpath, getPrefix, getPrefix, getSrc, getSrc, hasDirModeBeenSet, hasFileModeBeenSet, integerSetDirMode, integerSetFileMode, isFilesystemOnly, iterator, newArchiveScanner, setDir, setDirMode, setFileMode, setFullpath, setPrefix, setSrc, setSrcResource, size, toString

Methods inherited from class org.apache.tools.ant.types.FileSet

clone, isFilesystemOnly, iterator, size

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, addSelector, addSize, addType, appendExcludes, appendIncludes, appendSelector, clone, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDefaultexcludes, getDir, getDir, getDirectoryScanner, getDirectoryScanner, getRef, getSelectors, hasPatterns, hasSelectors, isCaseSensitive, isFollowSymlinks, mergeExcludes, mergeIncludes, mergePatterns, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setDir, setExcludes, setExcludesfile, setFile, setFollowSymlinks, setIncludes, setIncludesfile, setRefid, setupDirectoryScanner, setupDirectoryScanner, toString

Methods inherited from class org.apache.tools.ant.types.DataType

checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, setChecked, setRefid, toString, tooManyAttributes

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject

Constructor Details

TarFileSet

public TarFileSet()
Constructor for TarFileSet

TarFileSet

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

TarFileSet

protected TarFileSet(TarFileSet fileset)
Constructor using a tarfileset arguement.
Parameters:
fileset - the tarfileset to use

Method Details

clone

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

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 interface ArchiveFileSet
Parameters:
zfs - the archive fileset to configure.

getGid

public int getGid()
Returns:
the group identifier.

getGroup

public String getGroup()
Returns:
the group name string.

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 interface AbstractFileSet
Parameters:
p - the project to use
Returns:
the abstract fileset instance

getUid

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

getUserName

public String getUserName()
Returns:
the user name for the tar entry

hasGroupBeenSet

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

hasGroupIdBeenSet

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

hasUserIdBeenSet

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

hasUserNameBeenSet

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

newArchiveScanner

protected ArchiveScanner newArchiveScanner()
Create a new scanner.
Overrides:
newArchiveScanner in interface ArchiveFileSet
Returns:
the created scanner.

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.

setGroup

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

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 interface AbstractFileSet
Parameters:
r - the Reference to use.
Throws:
BuildException - on error

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.

setUserName

public void setUserName(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.

Overview Package Tree Index Deprecated About