public class Tar extends MatchingTask
Modifier and Type | Class and Description |
---|---|
static class |
Tar.TarCompressionMethod
Valid Modes for Compression attribute to Tar Task
|
static class |
Tar.TarFileSet
This is a FileSet with the option to specify permissions
and other attributes.
|
static class |
Tar.TarLongFileMode
Set of options for long file handling in the task.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
FAIL
Deprecated.
since 1.5.x.
Tar.FAIL is deprecated and is replaced with
Tar.TarLongFileMode.FAIL
|
static java.lang.String |
GNU
Deprecated.
since 1.5.x.
Tar.GNU is deprecated and is replaced with
Tar.TarLongFileMode.GNU
|
static java.lang.String |
OMIT
Deprecated.
since 1.5.x.
Tar.OMIT is deprecated and is replaced with
Tar.TarLongFileMode.OMIT
|
static java.lang.String |
TRUNCATE
Deprecated.
since 1.5.x.
Tar.TRUNCATE is deprecated and is replaced with
Tar.TarLongFileMode.TRUNCATE
|
static java.lang.String |
WARN
Deprecated.
since 1.5.x.
Tar.WARN is deprecated and is replaced with
Tar.TarLongFileMode.WARN
|
fileset
description, location, project
Constructor and Description |
---|
Tar() |
Modifier and Type | Method and Description |
---|---|
void |
add(ResourceCollection res)
Add a collection of resources to archive.
|
protected boolean |
archiveIsUpToDate(Resource r)
Is the archive up to date in relationship to a list of files.
|
protected boolean |
archiveIsUpToDate(java.lang.String[] files)
Deprecated.
since 1.5.x.
use the two-arg version instead.
|
protected boolean |
archiveIsUpToDate(java.lang.String[] files,
java.io.File dir)
Is the archive up to date in relationship to a list of files.
|
protected Tar.TarFileSet |
asTarFileSet(ArchiveFileSet archiveFileSet)
Copies fullpath, prefix and permission attributes from the
ArchiveFileSet to a new TarFileSet (or returns it unchanged if
it already is a TarFileSet).
|
protected boolean |
check(java.io.File basedir,
java.lang.String[] files)
Checks whether the archive is out-of-date with respect to the
given files, ensures that the archive won't contain itself.
|
protected boolean |
check(ResourceCollection rc)
Checks whether the archive is out-of-date with respect to the resources
of the given collection.
|
Tar.TarFileSet |
createTarFileSet()
Add a new fileset with the option to specify permissions
|
void |
execute()
do the business
|
protected static java.lang.String[] |
getFileNames(FileSet fs)
Grabs all included files and directors from the FileSet and
returns them as an array of (relative) file names.
|
protected static boolean |
isFileFileSet(ResourceCollection rc)
whether the given resource collection is a (subclass of)
FileSet that only contains file system resources.
|
void |
setBasedir(java.io.File baseDir)
This is the base directory to look in for things to tar.
|
void |
setCompression(Tar.TarCompressionMethod mode)
Set compression method.
|
void |
setDestFile(java.io.File destFile)
Set is the name/location of where to create the tar file.
|
void |
setLongfile(java.lang.String mode)
Deprecated.
since 1.5.x.
setLongFile(String) is deprecated and is replaced with
setLongFile(Tar.TarLongFileMode) to make Ant's Introspection
mechanism do the work and also to encapsulate operations on
the mode in its own class.
|
void |
setLongfile(Tar.TarLongFileMode mode)
Set how to handle long files, those with a path>100 chars.
|
void |
setTarfile(java.io.File tarFile)
Deprecated.
since 1.5.x.
For consistency with other tasks, please use setDestFile().
|
protected boolean |
supportsNonFileResources()
Whether this task can deal with non-file resources.
|
protected void |
tar(ResourceCollection rc,
TarOutputStream tOut)
Adds the resources contained in this collection to the archive.
|
protected void |
tarFile(java.io.File file,
TarOutputStream tOut,
java.lang.String vPath,
Tar.TarFileSet tarFileSet)
tar a file
|
protected void |
tarResource(Resource r,
TarOutputStream tOut,
java.lang.String vPath,
Tar.TarFileSet tarFileSet)
tar a resource
|
add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
clone, getDescription, getLocation, getProject, setDescription, setLocation
public static final java.lang.String WARN
public static final java.lang.String FAIL
public static final java.lang.String TRUNCATE
public static final java.lang.String GNU
public static final java.lang.String OMIT
public Tar.TarFileSet createTarFileSet()
public void add(ResourceCollection res)
res
- a resource collection to archive.public void setTarfile(java.io.File tarFile)
tarFile
- the location of the tar file.public void setDestFile(java.io.File destFile)
destFile
- The output of the tarpublic void setBasedir(java.io.File baseDir)
baseDir
- the base directory.public void setLongfile(java.lang.String mode)
Allowable values are
mode
- the mode string to handle long files.public void setLongfile(Tar.TarLongFileMode mode)
Allowable values are
mode
- the mode to handle long file names.public void setCompression(Tar.TarCompressionMethod mode)
mode
- the compression method.public void execute() throws BuildException
execute
in class Task
BuildException
- on errorprotected void tarFile(java.io.File file, TarOutputStream tOut, java.lang.String vPath, Tar.TarFileSet tarFileSet) throws java.io.IOException
file
- the file to tartOut
- the output streamvPath
- the path name of the file to tartarFileSet
- the fileset that the file came from.java.io.IOException
- on errorprotected void tarResource(Resource r, TarOutputStream tOut, java.lang.String vPath, Tar.TarFileSet tarFileSet) throws java.io.IOException
r
- the resource to tartOut
- the output streamvPath
- the path name of the file to tartarFileSet
- the fileset that the file came from, may be null.java.io.IOException
- on errorprotected boolean archiveIsUpToDate(java.lang.String[] files)
files
- the files to checkprotected boolean archiveIsUpToDate(java.lang.String[] files, java.io.File dir)
files
- the files to checkdir
- the base directory for the files.protected boolean archiveIsUpToDate(Resource r)
r
- the files to checkprotected boolean supportsNonFileResources()
This implementation returns true only if this task is <tar>. Any subclass of this class that also wants to support non-file resources needs to override this method. We need to do so for backwards compatibility reasons since we can't expect subclasses to support resources.
protected boolean check(ResourceCollection rc)
Also checks that either all collections only contain file resources or this class supports non-file collections.
And - in case of file-collections - ensures that the archive won't contain itself.
rc
- the resource collection to checkprotected boolean check(java.io.File basedir, java.lang.String[] files)
basedir
- base directory for file namesfiles
- array of relative file namesprotected void tar(ResourceCollection rc, TarOutputStream tOut) throws java.io.IOException
Uses the file based methods for file resources for backwards compatibility.
rc
- the collection containing resources to addtOut
- stream writing to the archive.java.io.IOException
- on error.protected static boolean isFileFileSet(ResourceCollection rc)
rc
- the resource collection to check.protected static java.lang.String[] getFileNames(FileSet fs)
fs
- the fileset to operate on.protected Tar.TarFileSet asTarFileSet(ArchiveFileSet archiveFileSet)
archiveFileSet
- fileset to copy attributes from, may be null