Apache Ant Core 1.10.14 · org.apache.tools.ant.taskdefs.optional.Cab

Modifier and Type	Field and Description
protected String	archiveType
private File	baseDir
private File	cabFile
private String	cmdOptions
private static final int	DEFAULT_RESULT
private boolean	doCompress
private boolean	doVerbose
private static final FileUtils	FILE_UTILS
private boolean	filesetAdded

Access	Constructor and Description
public	Cab()

Method Summary

Modifier and Type	Method and Description
public void	addFileset(FileSet a set of files to archive. fileset) Adds a set of files to archive.
protected void	appendFiles(Vector<String> the vector to append the files to. files, DirectoryScanner the scanner to get the files from. ds) Append all files found by a directory scanner to a vector.
protected void	checkConfiguration() Check if the attributes and nested elements are correct.
protected ExecTask	Returns: the delegate. createExec() Create a new exec delegate.
protected File	Returns: the list file created. createListFile(Vector<String> the list of files to use. files) Creates a list file.
public void	execute() Overrides org.apache.tools.ant.Task.execute. execute this task.
protected Vector<String>	Returns: the list of files. getFileList() Get the complete list of files to be included in the cab.
protected boolean	Returns: true if the cab file is newer than its dependents. isUpToDate(Vector<String> the list of files to check. files) Check to see if the target is up to date with respect to input files.
public void	setBasedir(File base directory for files to cab. baseDir) Base directory to look in for files to CAB.
public void	setCabfile(File the location of the cab file. cabFile) The name/location of where to create the .cab file.
public void	setCompress(boolean a `boolean` value. compress) If true, compress the files otherwise only store them.
public void	setOptions(String cabarc command line options. options) Sets additional cabarc options that are not supported directly.
public void	setVerbose(boolean a `boolean` value. verbose) If true, display cabarc output.

archiveType	back to summary
protected String archiveType

baseDir	back to summary
private File baseDir

cabFile	back to summary
private File cabFile

cmdOptions	back to summary
private String cmdOptions

DEFAULT_RESULT	back to summary
private static final int DEFAULT_RESULT

doCompress	back to summary
private boolean doCompress

doVerbose	back to summary
private boolean doVerbose

FILE_UTILS	back to summary
private static final FileUtils FILE_UTILS

filesetAdded	back to summary
private boolean filesetAdded

Cab	back to summary
public Cab()

Method Detail

addFileset	back to summary
public void addFileset(FileSet fileset) Adds a set of files to archive. Parameters fileset:FileSet a set of files to archive.

addFileset

back to summary

public void addFileset(FileSet fileset)

Adds a set of files to archive.

Parameters

fileset:FileSet: a set of files to archive.

appendFiles	back to summary
protected void appendFiles(Vector<String> files, DirectoryScanner ds) Append all files found by a directory scanner to a vector. Parameters files:Vector<String> the vector to append the files to. ds:DirectoryScanner the scanner to get the files from.

appendFiles

back to summary

protected void appendFiles(Vector<String> files, DirectoryScanner ds)

Append all files found by a directory scanner to a vector.

Parameters

files:Vector<String>: the vector to append the files to.
ds:DirectoryScanner: the scanner to get the files from.

checkConfiguration	back to summary
protected void checkConfiguration() throws BuildException Check if the attributes and nested elements are correct. Exceptions BuildException: on error.

checkConfiguration

back to summary

protected void checkConfiguration() throws BuildException

Check if the attributes and nested elements are correct.

Exceptions

BuildException:: on error.

createExec	back to summary
protected ExecTask createExec() throws BuildException 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:ExecTask the delegate. Exceptions BuildException: on error.

createExec

back to summary

protected ExecTask createExec() throws BuildException

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:ExecTask

the delegate.

Exceptions

BuildException:: on error.

createListFile	back to summary
protected File createListFile(Vector<String> files) throws IOException 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:Vector<String> the list of files to use. Returns:File the list file created. Exceptions IOException: if there is an error.

createListFile

back to summary

protected File createListFile(Vector<String> files) throws IOException

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:Vector<String>: the list of files to use.

Returns:File

the list file created.

Exceptions

IOException:: if there is an error.

execute	back to summary
public void execute() throws BuildException Overrides org.apache.tools.ant.Task.execute. execute this task. Annotations @Override Exceptions BuildException: on error.

execute

back to summary

public void execute() throws BuildException

Overrides org.apache.tools.ant.Task.execute.

execute this task.

Annotations

@Override

Exceptions

BuildException:: on error.

getFileList	back to summary
protected Vector<String> getFileList() throws BuildException 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:Vector<String> the list of files. Exceptions BuildException: if there is an error.

getFileList

back to summary

protected Vector<String> getFileList() throws BuildException

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:Vector<String>

the list of files.

Exceptions

BuildException:: if there is an error.

isUpToDate	back to summary
protected boolean isUpToDate(Vector<String> files) Check to see if the target is up to date with respect to input files. Parameters files:Vector<String> the list of files to check. Returns:boolean true if the cab file is newer than its dependents.

isUpToDate

back to summary

protected boolean isUpToDate(Vector<String> files)

Check to see if the target is up to date with respect to input files.

Parameters

files:Vector<String>: the list of files to check.

Returns:boolean

true if the cab file is newer than its dependents.

setBasedir	back to summary
public void setBasedir(File baseDir) Base directory to look in for files to CAB. Parameters baseDir:File base directory for files to cab.

setBasedir

back to summary

public void setBasedir(File baseDir)

Base directory to look in for files to CAB.

Parameters

baseDir:File: base directory for files to cab.

setCabfile	back to summary
public void setCabfile(File cabFile) The name/location of where to create the .cab file. Parameters cabFile:File the location of the cab file.

setCabfile

back to summary

public void setCabfile(File cabFile)

The name/location of where to create the .cab file.

Parameters

cabFile:File: the location of the cab file.

setCompress back to summary

setCompress	back to summary
public void setCompress(boolean compress) If true, compress the files otherwise only store them. Parameters compress:boolean a `boolean` value.

public void setCompress(boolean compress)

If true, compress the files otherwise only store them.

Parameters

compress:boolean: a boolean value.

setOptions	back to summary
public void setOptions(String options) Sets additional cabarc options that are not supported directly. Parameters options:String cabarc command line options.

setOptions

back to summary

public void setOptions(String options)

Sets additional cabarc options that are not supported directly.

Parameters

options:String: cabarc command line options.

setVerbose back to summary

setVerbose	back to summary
public void setVerbose(boolean verbose) If true, display cabarc output. Parameters verbose:boolean a `boolean` value.

public void setVerbose(boolean verbose)

If true, display cabarc output.

Parameters

verbose:boolean: a boolean value.

public Class Cab

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail