|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
org.apache.tools.ant.types.AbstractFileSet
org.apache.tools.ant.types.FileSet
org.apache.tools.ant.types.ArchiveFileSet
org.apache.ant.compress.resources.TarFileSet
public class TarFileSet
A TarFileSet is a FileSet with extra attributes useful in the context of Tar 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 |
protected |
TarFileSet(org.apache.tools.ant.types.FileSet fileset)
Constructor using a fileset arguement. |
protected |
TarFileSet(TarFileSet fileset)
Constructor using a tarfileset arguement. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Return a TarFileSet 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()
|
java.lang.String |
getGroup()
|
protected org.apache.tools.ant.types.AbstractFileSet |
getRef(org.apache.tools.ant.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()
|
java.lang.String |
getUserName()
|
boolean |
hasGroupBeenSet()
|
boolean |
hasGroupIdBeenSet()
|
boolean |
hasUserIdBeenSet()
|
boolean |
hasUserNameBeenSet()
|
protected org.apache.tools.ant.types.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(java.lang.String groupName)
The groupname for the tar entry; optional, default="" This is not the same as the GID. |
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 tar entry This is not the same as the User name. |
void |
setUserName(java.lang.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, 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 |
---|
public TarFileSet()
protected TarFileSet(org.apache.tools.ant.types.FileSet fileset)
fileset
- the fileset to useprotected TarFileSet(TarFileSet fileset)
fileset
- the tarfileset to useMethod Detail |
---|
public void setUserName(java.lang.String userName)
userName
- the user name for the tar entry.public java.lang.String getUserName()
public boolean hasUserNameBeenSet()
public void setUid(int uid)
uid
- the id of the user for the tar entry.public int getUid()
public boolean hasUserIdBeenSet()
public void setGroup(java.lang.String groupName)
groupName
- the group name string.public java.lang.String getGroup()
public boolean hasGroupBeenSet()
public void setGid(int gid)
gid
- the group id.public int getGid()
public boolean hasGroupIdBeenSet()
public void setSkipUnreadableEntries(boolean b)
protected org.apache.tools.ant.types.ArchiveScanner newArchiveScanner()
newArchiveScanner
in class org.apache.tools.ant.types.ArchiveFileSet
public void setRefid(org.apache.tools.ant.types.Reference r) throws org.apache.tools.ant.BuildException
You must not set another attribute or nest elements inside this element if you make it a reference.
setRefid
in class org.apache.tools.ant.types.AbstractFileSet
r
- the Reference
to use.
org.apache.tools.ant.BuildException
- on errorprotected org.apache.tools.ant.types.AbstractFileSet getRef(org.apache.tools.ant.Project p)
getRef
in class org.apache.tools.ant.types.AbstractFileSet
p
- the project to use
protected void configureFileSet(org.apache.tools.ant.types.ArchiveFileSet zfs)
configureFileSet
in class org.apache.tools.ant.types.ArchiveFileSet
zfs
- the archive fileset to configure.public java.lang.Object clone()
clone
in class org.apache.tools.ant.types.ArchiveFileSet
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |