org.apache.tools.ant.taskdefs.optional.image
Class Image
- Cloneable, SelectorContainer
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.
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.
|
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 |
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 |
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
add
public void add(ImageOperation instr)
Add an ImageOperation to chain.
instr
- The ImageOperation to append to the chain.
addDraw
public void addDraw(Draw instr)
Add a Draw ImageOperation to the chain. DrawOperation
DataType objects can be nested inside the Draw object.
instr
- The Draw operation to add to the chain.
addFileset
public void addFileset(FileSet set)
Add a set of files to be deleted.
set
- the FileSet to add.
addImageOperation
public void addImageOperation(ImageOperation instr)
Add an ImageOperation to chain.
instr
- The ImageOperation to append to the chain.
addRotate
public void addRotate(Rotate instr)
Add a Rotate ImageOperation to the chain.
instr
- The Rotate operation to add to the chain.
addScale
public void addScale(Scale instr)
Add a Scale ImageOperation to the chain.
instr
- The Scale operation to add to the chain.
processFile
public void processFile(File file)
Executes all the chained ImageOperations on the file
specified.
file
- The file to be processed.
setDestDir
public void setDestDir(File destDir)
Set the destination directory for manipulated images.
destDir
- The destination directory.
setEncoding
public void setEncoding(String encoding)
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.
failonerror
- true or false.
setGc
public void setGc(boolean gc)
Set whether to invoke Garbage Collection after each image processed.
Defaults to false.
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.
overwrite
- whether to overwrite.
setSrcdir
public void setSrcdir(File srcDir)
Set the source dir to find the image files.
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.