org.apache.tools.ant.taskdefs

Class Unpack

public abstract class Unpack extends Task

Abstract Base class for unpack tasks.

Since: Ant 1.5

Field Summary
protected Filedest
protected Filesource
protected ResourcesrcResource
Method Summary
voidaddConfigured(ResourceCollection a)
Set the source Archive resource.
voidexecute()
Execute the task.
protected abstract voidextract()
Do the uncompressing.
protected abstract StringgetDefaultExtension()
Get the extension.
voidsetDest(String dest)
voidsetDest(File dest)
The destination file or directory; optional.
voidsetSrc(String src)
voidsetSrc(File src)
The file to expand; required.
voidsetSrcResource(Resource src)
The resource to expand; required.
protected booleansupportsNonFileResources()
Whether this task can deal with non-file resources.

Field Detail

dest

protected File dest

source

protected File source

srcResource

protected Resource srcResource

Method Detail

addConfigured

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

Parameters: a the archive as a single element Resource collection.

execute

public void execute()
Execute the task.

Throws: BuildException on error

extract

protected abstract void extract()
Do the uncompressing. This is to be overridden by subclasses.

getDefaultExtension

protected abstract String getDefaultExtension()
Get the extension. This is to be overridden by subclasses.

Returns: the default extension.

setDest

public void setDest(String dest)

Deprecated: since 1.5.x. setDest(String) is deprecated and is replaced with setDest(File) to make Ant's Introspection mechanism do the work and also to encapsulate operations on the type in its own class.

Parameters: dest a String value

UNKNOWN: ignore="true"

setDest

public void setDest(File dest)
The destination file or directory; optional.

Parameters: dest destination file or directory

setSrc

public void setSrc(String src)

Deprecated: since 1.5.x. setSrc(String) is deprecated and is replaced with setSrc(File) to make Ant's Introspection mechanism do the work and also to encapsulate operations on the type in its own class.

Parameters: src a String value

UNKNOWN: ignore="true"

setSrc

public void setSrc(File src)
The file to expand; required.

Parameters: src file to expand

setSrcResource

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

Parameters: src resource to expand

supportsNonFileResources

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

This implementation returns false.

Returns: false for this task.

Since: Ant 1.7