Class Cab
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.MatchingTask
org.apache.tools.ant.taskdefs.optional.Cab
-
Field Summary
FieldsFields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
filesetFields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddFileset(FileSet fileset) Adds a set of files to archive.protected voidappendFiles(Vector<String> files, DirectoryScanner ds) Append all files found by a directory scanner to a vector.protected voidCheck if the attributes and nested elements are correct.protected ExecTaskCreate a new exec delegate.protected FilecreateListFile(Vector<String> files) Creates a list file.voidexecute()execute this task.Get the complete list of files to be included in the cab.protected booleanisUpToDate(Vector<String> files) Check to see if the target is up to date with respect to input files.voidsetBasedir(File baseDir) Base directory to look in for files to CAB.voidsetCabfile(File cabFile) The name/location of where to create the .cab file.voidsetCompress(boolean compress) If true, compress the files otherwise only store them.voidsetOptions(String options) Sets additional cabarc options that are not supported directly.voidsetVerbose(boolean verbose) If true, display cabarc output.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, XsetItemsMethods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation
-
Field Details
-
archiveType
-
-
Constructor Details
-
Cab
public Cab()
-
-
Method Details
-
setCabfile
The name/location of where to create the .cab file.- Parameters:
cabFile- the location of the cab file.
-
setBasedir
Base directory to look in for files to CAB.- Parameters:
baseDir- base directory for files to cab.
-
setCompress
public void setCompress(boolean compress) If true, compress the files otherwise only store them.- Parameters:
compress- abooleanvalue.
-
setVerbose
public void setVerbose(boolean verbose) If true, display cabarc output.- Parameters:
verbose- abooleanvalue.
-
setOptions
Sets additional cabarc options that are not supported directly.- Parameters:
options- cabarc command line options.
-
addFileset
Adds a set of files to archive.- Parameters:
fileset- a set of files to archive.
-
checkConfiguration
Check if the attributes and nested elements are correct.- Throws:
BuildException- on error.
-
createExec
Create a new exec delegate. The delegate task is populated so that it appears in the logs to be the same task as this one.- Returns:
- the delegate.
- Throws:
BuildException- on error.
-
isUpToDate
-
createListFile
Creates a list file. This temporary file contains a list of all files to be included in the cab, one file per line.This method expects to only be called on Windows and thus quotes the file names.
- Parameters:
files- the list of files to use.- Returns:
- the list file created.
- Throws:
IOException- if there is an error.
-
appendFiles
Append all files found by a directory scanner to a vector.- Parameters:
files- the vector to append the files to.ds- the scanner to get the files from.
-
getFileList
Get the complete list of files to be included in the cab. Filenames are gathered from the fileset if it has been added, otherwise from the traditional include parameters.- Returns:
- the list of files.
- Throws:
BuildException- if there is an error.
-
execute
execute this task.- Overrides:
executein classTask- Throws:
BuildException- on error.
-