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 FiledestDir
protected Vectorfilesets
protected booleangarbage_collect
protected Vectorinstructions
protected booleanoverwrite
protected FilesrcDir
protected Stringstr_encoding
Method Summary
voidadd(ImageOperation instr)
Add an ImageOperation to chain.
voidadd(FileNameMapper fileNameMapper)
Add a nested filenamemapper.
voidaddDraw(Draw instr)
Add a Draw ImageOperation to the chain.
voidaddFileset(FileSet set)
Add a set of files to be deleted.
voidaddImageOperation(ImageOperation instr)
Add an ImageOperation to chain.
voidaddRotate(Rotate instr)
Add a Rotate ImageOperation to the chain.
voidaddScale(Scale instr)
Add a Scale ImageOperation to the chain.
MappercreateMapper()
Defines the mapper to map source to destination files.
voidexecute()
Executes the Task.
intprocessDir(File srcDir, String[] srcNames, File dstDir, FileNameMapper mapper)
Executes all the chained ImageOperations on the files inside the directory.
voidprocessFile(File file)
Executes all the chained ImageOperations on the file specified.
voidprocessFile(File file, File newFile)
Executes all the chained ImageOperations on the file specified.
voidsetDestDir(File destDir)
Set the destination directory for manipulated images.
voidsetEncoding(String encoding)
Set the image encoding type.
voidsetFailOnError(boolean failonerror)
Set whether to fail on error.
voidsetGc(boolean gc)
Set whether to invoke Garbage Collection after each image processed.
voidsetOverwrite(boolean overwrite)
Set whether to overwrite a file if there is a naming conflict.
voidsetSrcdir(File srcDir)
Set the source dir to find the image files.
protected voidvalidateAttributes()
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

add

public void add(ImageOperation instr)
Add an ImageOperation to chain.

Parameters: instr The ImageOperation to append to the chain.

Since: Ant 1.7

add

public void add(FileNameMapper fileNameMapper)
Add a nested filenamemapper.

Parameters: fileNameMapper the mapper to add.

Since: Ant 1.8.0

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.

See Also: Draw DrawOperation

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

createMapper

public Mapper createMapper()
Defines the mapper to map source to destination files.

Returns: a mapper to be configured

Throws: BuildException if more than one mapper is defined

Since: Ant 1.8.0

execute

public void execute()
Executes the Task.

Throws: BuildException on error.

processDir

public int processDir(File srcDir, String[] srcNames, File dstDir, FileNameMapper mapper)
Executes all the chained ImageOperations on the files inside the directory.

Since: Ant 1.8.0

processFile

public void processFile(File file)

Deprecated: this method isn't used anymore

Executes all the chained ImageOperations on the file specified.

Parameters: file The file to be processed.

processFile

public void processFile(File file, File newFile)
Executes all the chained ImageOperations on the file specified.

Parameters: file The file to be processed. newFile The file to write to.

Since: Ant 1.8.0

setDestDir

public void setDestDir(File destDir)
Set 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.

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()
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.