Package org.apache.tools.ant.taskdefs
Class Pack
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.Pack
- All Implemented Interfaces:
java.lang.Cloneable
public abstract class Pack extends Task
Abstract Base class for pack tasks.
- Since:
- Ant 1.5
-
Field Summary
-
Constructor Summary
Constructors Constructor Description Pack() -
Method Summary
Modifier and Type Method Description voidaddConfigured(ResourceCollection a)Set the source resource.voidexecute()validate, then hand off to the subclassResourcegetSrcResource()The source resource.protected abstract voidpack()subclasses must implement this method to do their compressionvoidsetDestfile(java.io.File zipFile)the required destination file.voidsetSrc(java.io.File src)the file to compress; required.voidsetSrcResource(Resource src)The resource to pack; required.voidsetZipfile(java.io.File zipFile)the required destination file.protected booleansupportsNonFileResources()Whether this task can deal with non-file resources.protected voidzipFile(java.io.File file, java.io.OutputStream zOut)zip a file to an output streamprotected voidzipResource(Resource resource, java.io.OutputStream zOut)zip a resource to an output streamMethods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
-
Field Details
-
Constructor Details
-
Pack
public Pack()
-
-
Method Details
-
setZipfile
public void setZipfile(java.io.File zipFile)the required destination file.- Parameters:
zipFile- the destination file
-
setDestfile
public void setDestfile(java.io.File zipFile)the required destination file.- Parameters:
zipFile- the destination file
-
setSrc
public void setSrc(java.io.File src)the file to compress; required.- Parameters:
src- the source file
-
setSrcResource
The resource to pack; required.- Parameters:
src- resource to expand
-
addConfigured
Set the source resource.- Parameters:
a- the resource to pack as a single element Resource collection.
-
execute
validate, then hand off to the subclass- Overrides:
executein classTask- Throws:
BuildException- on error
-
zipFile
protected void zipFile(java.io.File file, java.io.OutputStream zOut) throws java.io.IOExceptionzip a file to an output stream- Parameters:
file- the file to zipzOut- the output stream- Throws:
java.io.IOException- on error
-
zipResource
protected void zipResource(Resource resource, java.io.OutputStream zOut) throws java.io.IOExceptionzip a resource to an output stream- Parameters:
resource- the resource to zipzOut- the output stream- Throws:
java.io.IOException- on error
-
pack
protected abstract void pack()subclasses must implement this method to do their compression -
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
-