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

Class Image

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

Method Summary
void	addDraw(Draw instr) Adds a Draw ImageOperation to the chain.
void	addFileset(FileSet set) Adds a set of files to be deleted.
void	addImageOperation(ImageOperation instr) Adds an ImageOperation to chain.
void	addRotate(Rotate instr) Adds a Rotate ImageOperation to the chain
void	addScale(Scale instr) Adds 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) Sets the destination directory for manipulated images.
void	setEncoding(String encoding) Set the image encoding type.
void	setFailOnError(boolean failonerror) If false, note errors to the output but keep going.
void	setGc(boolean gc) Enables Garbage Collection after each image processed.
void	setOverwrite(boolean overwrite) Sets whether or not 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.

Field Detail

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 Detail

addDraw

public void addDraw(Draw instr)

Adds 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

See Also: Draw DrawOperation

addFileset

public void addFileset(FileSet set)

Adds a set of files to be deleted.

addImageOperation

public void addImageOperation(ImageOperation instr)

Adds an ImageOperation to chain.

Parameters: instr The ImageOperation to append to the chain

addRotate

public void addRotate(Rotate instr)

Adds 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)

Adds a Scale ImageOperation to the chain

Parameters: instr The Scale operation to add to the chain

See Also: Scale

execute

public void execute()

Executes the Task

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)

Sets the destination directory for manipulated images.

Parameters: destDir The destination directory

setEncoding

public void setEncoding(String encoding)

Set the image encoding type. See this table in the JAI Programming Guide.

setFailOnError

public void setFailOnError(boolean failonerror)

If false, note errors to the output but keep going.

Parameters: failonerror true or false

setGc

public void setGc(boolean gc)

Enables Garbage Collection after each image processed. Defaults to false.

setOverwrite

public void setOverwrite(boolean overwrite)

Sets whether or not to overwrite a file if there is a naming conflict.

setSrcdir

public void setSrcdir(File srcDir)

Set the source dir to find the image files.

validateAttributes

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.

Copyright