Class ImageIOTask
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.MatchingTask
org.apache.tools.ant.taskdefs.optional.image.ImageIOTask
- All Implemented Interfaces:
Cloneable,SelectorContainer
A MatchingTask which relies on Java ImageIO to read existing image files
and write the results of AWT image manipulation operations.
The operations are represented as ImageOperation DataType objects.
The task replaces a JAI-based Image task which no longer works with Java 9+.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classdefines acceptable image formats. -
Field Summary
Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask
filesetFields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidadd(ImageOperation instr) Add an ImageOperation to chain.voidadd(FileNameMapper fileNameMapper) Add a nested filenamemapper.voidAdd 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.voidAdd a Rotate ImageOperation to the chain.voidAdd a Scale ImageOperation to the chain.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) Deprecated.this method isn't used anymorevoidprocessFile(File file, File newFile) Executes all the chained ImageOperations on the file specified.voidsetDestDir(File destDir) Set the destination directory for manipulated images.voidsetFailOnError(boolean flag) Set whether to fail on error.voidsetFormat(ImageIOTask.ImageFormat format) Set the output image format.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.voidSet the source dir to find the image files.protected voidEnsure 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
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, XsetIgnore, XsetItemsMethods 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
-
Constructor Details
-
ImageIOTask
public ImageIOTask()
-
-
Method Details
-
addFileset
Add a set of files to be deleted.- Parameters:
set- the FileSet to add.
-
setFailOnError
public void setFailOnError(boolean flag) Set whether to fail on error. If false, note errors to the output but keep going.- Parameters:
flag- true or false.
-
setSrcdir
Set the source dir to find the image files.- Parameters:
srcDir- the directory in which the image files reside.
-
setFormat
Set the output image format.- Parameters:
format- an ImageFormat.
-
setOverwrite
public void setOverwrite(boolean overwrite) Set whether to overwrite a file if there is a naming conflict.- Parameters:
overwrite- whether to overwrite.
-
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.
-
setDestDir
Set the destination directory for manipulated images.- Parameters:
destDir- The destination directory.
-
addImageOperation
Add an ImageOperation to chain.- Parameters:
instr- The ImageOperation to append to the chain.
-
addRotate
Add a Rotate ImageOperation to the chain.- Parameters:
instr- The Rotate operation to add to the chain.- See Also:
-
addScale
Add a Scale ImageOperation to the chain.- Parameters:
instr- The Scale operation to add to the chain.- See Also:
-
addDraw
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:
-
add
Add an ImageOperation to chain.- Parameters:
instr- The ImageOperation to append to the chain.- Since:
- Ant 1.7
-
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
-
add
Add a nested filenamemapper.- Parameters:
fileNameMapper- the mapper to add.- Since:
- Ant 1.8.0
-
processDir
Executes all the chained ImageOperations on the files inside the directory.- Parameters:
srcDir- FilesrcNames- String[]dstDir- Filemapper- FileNameMapper- Returns:
- int
- Since:
- Ant 1.8.0
-
processFile
Deprecated.this method isn't used anymoreExecutes all the chained ImageOperations on the file specified.- Parameters:
file- The file to be processed.
-
processFile
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
-
execute
Executes the Task.- Overrides:
executein classTask- Throws:
BuildException- on error.
-
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.
-