| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
  |
  +--org.apache.tools.ant.ProjectComponent
        |
        +--org.apache.tools.ant.Task
              |
              +--org.apache.tools.ant.taskdefs.MatchingTask
                    |
                    +--org.apache.tools.ant.taskdefs.Tar
Creates a tar archive.
| Nested Class Summary | |
| static class | Tar.TarCompressionMethodValid Modes for Compression attribute to Tar Task | 
| static class | Tar.TarFileSetThis is a FileSet with the option to specify permissions and other attributes. | 
| static class | Tar.TarLongFileModeSet of options for long file handling in the task. | 
| Field Summary | |
| static java.lang.String | FAILDeprecated. Tar.FAIL is deprecated and is replaced with Tar.TarLongFileMode.FAIL | 
| static java.lang.String | GNUDeprecated. Tar.GNU is deprecated and is replaced with Tar.TarLongFileMode.GNU | 
| static java.lang.String | OMITDeprecated. Tar.OMIT is deprecated and is replaced with Tar.TarLongFileMode.OMIT | 
| static java.lang.String | TRUNCATEDeprecated. Tar.TRUNCATE is deprecated and is replaced with Tar.TarLongFileMode.TRUNCATE | 
| static java.lang.String | WARNDeprecated. Tar.WARN is deprecated and is replaced with Tar.TarLongFileMode.WARN | 
| Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask | 
| fileset | 
| Fields inherited from class org.apache.tools.ant.Task | 
| description, location, target, taskName, taskType, wrapper | 
| Fields inherited from class org.apache.tools.ant.ProjectComponent | 
| project | 
| Constructor Summary | |
| Tar() | |
| Method Summary | |
| protected  boolean | archiveIsUpToDate(java.lang.String[] files)Deprecated. 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. | 
|  Tar.TarFileSet | createTarFileSet()Add a new fileset with the option to specify permissions | 
|  void | execute()do the business | 
|  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. 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. for consistency with other tasks, please use setDestFile() | 
| protected  void | tarFile(java.io.File file,
        TarOutputStream tOut,
        java.lang.String vPath,
        Tar.TarFileSet tarFileSet)tar a file | 
| Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask | 
| 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 | 
| Methods inherited from class org.apache.tools.ant.Task | 
| getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType | 
| Methods inherited from class org.apache.tools.ant.ProjectComponent | 
| getProject | 
| Methods inherited from class java.lang.Object | 
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
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
| Constructor Detail | 
public Tar()
| Method Detail | 
public Tar.TarFileSet createTarFileSet()
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 TaskBuildException - on error
protected 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 boolean archiveIsUpToDate(java.lang.String[] files)
files - the files to check
protected boolean archiveIsUpToDate(java.lang.String[] files,
                                    java.io.File dir)
files - the files to checkdir - the base directory for the files.
| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||