org.apache.tools.ant.taskdefs.optional.image

Class Image

Implemented Interfaces:
Cloneable, SelectorContainer

public class Image
extends MatchingTask

A MatchingTask which relies on JAI (Java Advanced Imaging) to perform image manipulation operations on existing images. The operations are represented as ImageOperation DataType objects. The operations are arranged to conform to the Chaining Model of JAI. Check out the JAI Programming Guide.
See Also:
ImageOperation, DataType

Field Summary

protected File
destDir
protected Vector
filesets
protected boolean
garbage_collect
protected Vector
instructions
protected boolean
overwrite
protected File
srcDir
protected String
str_encoding

Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask

fileset

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
add(ImageOperation instr)
Add an ImageOperation to chain.
void
addDraw(Draw instr)
Add a Draw ImageOperation to the chain.
void
addFileset(FileSet set)
Add a set of files to be deleted.
void
addImageOperation(ImageOperation instr)
Add an ImageOperation to chain.
void
addRotate(Rotate instr)
Add a Rotate ImageOperation to the chain.
void
addScale(Scale instr)
Add a Scale ImageOperation to the chain.
void
execute()
Executes the Task.
void
processFile(File file)
Executes all the chained ImageOperations on the file specified.
void
setDestDir(File destDir)
Set the destination directory for manipulated images.
void
setEncoding(String encoding)
Set the image encoding type.
void
setFailOnError(boolean failonerror)
Set whether to fail on error.
void
setGc(boolean gc)
Set whether to invoke Garbage Collection after each image processed.
void
setOverwrite(boolean overwrite)
Set whether to overwrite a file if there is a naming conflict.
void
setSrcdir(File srcDir)
Set the source dir to find the image files.
protected void
validateAttributes()
Ensure we have a consistent and legal set of attributes, and set any internal flags necessary based on different combinations of attributes.

Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask

XsetIgnore, XsetItems, add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject

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

destDir

protected File destDir

filesets

protected Vector filesets

garbage_collect

protected boolean garbage_collect

instructions

protected Vector instructions

overwrite

protected boolean overwrite

srcDir

protected File srcDir

str_encoding

protected String str_encoding

Method Details

add

public void add(ImageOperation instr)
Add an ImageOperation to chain.
Parameters:
instr - The ImageOperation to append to the chain.
Since:
Ant 1.7

addDraw

public void addDraw(Draw instr)
Add a Draw ImageOperation to the chain. DrawOperation DataType objects can be nested inside the Draw object.
Parameters:
instr - The Draw operation to add to the chain.

addFileset

public void addFileset(FileSet set)
Add a set of files to be deleted.
Parameters:
set - the FileSet to add.

addImageOperation

public void addImageOperation(ImageOperation instr)
Add an ImageOperation to chain.
Parameters:
instr - The ImageOperation to append to the chain.

addRotate

public void addRotate(Rotate instr)
Add a Rotate ImageOperation to the chain.
Parameters:
instr - The Rotate operation to add to the chain.
See Also:
Rotate

addScale

public void addScale(Scale instr)
Add a Scale ImageOperation to the chain.
Parameters:
instr - The Scale operation to add to the chain.
See Also:
Scale

execute

public void execute()
            throws BuildException
Executes the Task.
Overrides:
execute in interface Task
Throws:
BuildException - on error.

processFile

public void processFile(File file)
Executes all the chained ImageOperations on the file specified.
Parameters:
file - The file to be processed.

setDestDir

public void setDestDir(File destDir)
Set the destination directory for manipulated images.
Parameters:
destDir - The destination directory.

setEncoding

public void setEncoding(String encoding)
Parameters:
encoding - the String image encoding.

setFailOnError

public void setFailOnError(boolean failonerror)
Set whether to fail on error. If false, note errors to the output but keep going.
Parameters:
failonerror - true or false.

setGc

public void setGc(boolean gc)
Set whether to invoke Garbage Collection after each image processed. Defaults to false.
Parameters:
gc - whether to invoke the garbage collector.

setOverwrite

public void setOverwrite(boolean overwrite)
Set whether to overwrite a file if there is a naming conflict.
Parameters:
overwrite - whether to overwrite.

setSrcdir

public void setSrcdir(File srcDir)
Set the source dir to find the image files.
Parameters:
srcDir - the directory in which the image files reside.

validateAttributes

protected void validateAttributes()
            throws BuildException
Ensure we have a consistent and legal set of attributes, and set any internal flags necessary based on different combinations of attributes.
Throws:
BuildException - on error.