org.apache.tools.ant.taskdefs

Class Unpack

Implemented Interfaces:
Cloneable
Known Direct Subclasses:
BUnzip2, GUnzip

public abstract class Unpack
extends Task

Abstract Base class for unpack tasks.
Since:
Ant 1.5

Field Summary

protected File
dest
protected File
source
protected Resource
srcResource

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Method Summary

void
addConfigured(ResourceCollection a)
Set the source Archive resource.
void
execute()
Execute the task.
protected abstract void
extract()
Do the uncompressing.
protected abstract String
getDefaultExtension()
Get the extension.
void
setDest(File dest)
The destination file or directory; optional.
void
setDest(String dest)
Deprecated. since 1.5.x.
void
setSrc(File src)
The file to expand; required.
void
setSrc(String src)
Deprecated. since 1.5.x.
void
setSrcResource(Resource src)
The resource to expand; required.
protected boolean
supportsNonFileResources()
Whether this task can deal with non-file resources.

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject

Field Details

dest

protected File dest

source

protected File source

srcResource

protected Resource srcResource

Method Details

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()
            throws BuildException
Execute the task.
Overrides:
execute in interface 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(File dest)
The destination file or directory; optional.
Parameters:
dest - destination file or directory

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

setSrc

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

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

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