org.apache.tools.ant.taskdefs

Class Pack

public abstract class Pack extends Task

Abstract Base class for pack tasks.

Since: Ant 1.5

Field Summary
protected Filesource
protected FilezipFile
Method Summary
voidaddConfigured(ResourceCollection a)
Set the source resource.
voidexecute()
validate, then hand off to the subclass
ResourcegetSrcResource()
The source resource.
protected abstract voidpack()
subclasses must implement this method to do their compression
voidsetDestfile(File zipFile)
the required destination file.
voidsetSrc(File src)
the file to compress; required.
voidsetSrcResource(Resource src)
The resource to pack; required.
voidsetZipfile(File zipFile)
the required destination file.
protected booleansupportsNonFileResources()
Whether this task can deal with non-file resources.
protected voidzipFile(File file, OutputStream zOut)
zip a file to an output stream
protected voidzipResource(Resource resource, OutputStream zOut)
zip a resource to an output stream

Field Detail

source

protected File source

zipFile

protected File zipFile

Method Detail

addConfigured

public void addConfigured(ResourceCollection a)
Set the source resource.

Parameters: a the resource to pack as a single element Resource collection.

execute

public void execute()
validate, then hand off to the subclass

Throws: BuildException on error

getSrcResource

public Resource getSrcResource()
The source resource.

Returns: the source.

Since: Ant 1.7

pack

protected abstract void pack()
subclasses must implement this method to do their compression

setDestfile

public void setDestfile(File zipFile)
the required destination file.

Parameters: zipFile the destination file

setSrc

public void setSrc(File src)
the file to compress; required.

Parameters: src the source file

setSrcResource

public void setSrcResource(Resource src)
The resource to pack; required.

Parameters: src resource to expand

setZipfile

public void setZipfile(File zipFile)
the required destination file.

Parameters: zipFile the destination file

supportsNonFileResources

protected boolean supportsNonFileResources()
Whether this task can deal with non-file resources.

This implementation returns false.

Returns: false.

Since: Ant 1.7

zipFile

protected void zipFile(File file, OutputStream zOut)
zip a file to an output stream

Parameters: file the file to zip zOut the output stream

Throws: IOException on error

zipResource

protected void zipResource(Resource resource, OutputStream zOut)
zip a resource to an output stream

Parameters: resource the resource to zip zOut the output stream

Throws: IOException on error