Class Pack

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.Pack

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

BZip2, GZip, Xz

public abstract class Pack
extends Task

Abstract Base class for pack tasks.

Since:

Ant 1.5

Field Summary

Fields

Modifier and Type	Field	Description
protected File	source
protected File	zipFile

Fields inherited from class Task

target, taskName, taskType, wrapper

Modifier and Type	Field	Description
protected Target	target	Deprecated. since 1.6.x.
protected String	taskName	Deprecated. since 1.6.x.
protected String	taskType	Deprecated. since 1.6.x.
protected RuntimeConfigurable	wrapper	Deprecated. since 1.6.x.

Fields inherited from class ProjectComponent

description, location, project

Modifier and Type	Field	Description
protected String	description	Deprecated. since 1.6.x.
protected Location	location	Deprecated. since 1.6.x.
protected Project	project	Deprecated. since 1.6.x.

Constructor Summary

Constructors

Constructor	Description
Pack()

Method Summary

Modifier and Type	Method	Description
void	addConfigured(ResourceCollection a)	Set the source resource.
void	execute()	validate, then hand off to the subclass
Resource	getSrcResource()	The source resource.
protected abstract void	pack()	subclasses must implement this method to do their compression
void	setDestfile(File zipFile)	the required destination file.
void	setSrc(File src)	the file to compress; required.
void	setSrcResource(Resource src)	The resource to pack; required.
void	setZipfile(File zipFile)	the required destination file.
protected boolean	supportsNonFileResources()	Whether this task can deal with non-file resources.
protected void	zipFile(File file, OutputStream zOut)	zip a file to an output stream
protected void	zipResource(Resource resource, OutputStream zOut)	zip a resource to an output stream

Methods inherited from class Task

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

Modifier and Type	Method	Description
final void	bindToOwner(Task owner)	Bind a task to another; use this when configuring a newly created task to do work on behalf of another.
Target	getOwningTarget()	Returns the container target of this task.
RuntimeConfigurable	getRuntimeConfigurableWrapper()	Returns the wrapper used for runtime configuration.
String	getTaskName()	Returns the name to use in logging messages.
String	getTaskType()	Return the type of task.
protected RuntimeConfigurable	getWrapper()	Return the runtime configurable structure for this task.
protected void	handleErrorFlush(String output)	Handles an error line by logging it with the WARN priority.
protected void	handleErrorOutput(String output)	Handles an error output by logging it with the WARN priority.
protected void	handleFlush(String output)	Handles output by logging it with the INFO priority.
protected int	handleInput(byte[] buffer, int offset, int length)	Handle an input request by this task.
protected void	handleOutput(String output)	Handles output by logging it with the INFO priority.
void	init()	Called by the project to let the task initialize properly.
protected final boolean	isInvalid()	Has this task been marked invalid?
void	log(String msg)	Logs a message with the default (INFO) priority.
void	log(String msg, int msgLevel)	Logs a message with the given priority.
void	log(String msg, Throwable t, int msgLevel)	Logs a message with the given priority.
void	log(Throwable t, int msgLevel)	Logs a message with the given priority.
void	maybeConfigure()	Configures this task - if it hasn't been done already.
final void	perform()	Performs this task if it's still valid, or gets a replacement version and performs that otherwise.
void	reconfigure()	Force the task to be reconfigured from its RuntimeConfigurable.
void	setOwningTarget(Target target)	Sets the target container of this task.
void	setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)	Sets the wrapper to be used for runtime configuration.
void	setTaskName(String name)	Sets the name to use in logging messages.
void	setTaskType(String type)	Sets the name with which the task has been invoked.

Methods inherited from class ProjectComponent

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

Modifier and Type	Method	Description
Object	clone()
String	getDescription()	Returns the description of the current action.
Location	getLocation()	Returns the file/location where this task was defined.
Project	getProject()	Returns the project to which this component belongs.
void	setDescription(String desc)	Sets a description of the current action.
void	setLocation(Location location)	Sets the file/location where this task was defined.
void	setProject(Project project)	Sets the project object of this component.

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

zipFile

protected File zipFile

source

protected File source

Constructor Details

Pack

public Pack()

Method Details

setZipfile

public void setZipfile(File zipFile)

the required destination file.

Parameters:

zipFile - the destination file

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

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()
             throws BuildException

validate, then hand off to the subclass

Overrides:

execute in class Task

Throws:

BuildException - on error

zipFile

protected void zipFile(File file,
 OutputStream zOut)
                throws IOException

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)
                    throws IOException

zip a resource to an output stream

Parameters:

resource - the resource to zip

zOut - the output stream

Throws:

IOException - on error

pack

protected abstract void pack()

subclasses must implement this method to do their compression

getSrcResource

public Resource getSrcResource()

The source resource.

Returns:

the source.

Since:

Ant 1.7

supportsNonFileResources

protected boolean supportsNonFileResources()

Whether this task can deal with non-file resources.

This implementation returns false.

Returns:

false.

Since:

Ant 1.7