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:
- java.lang.Cloneable,- SelectorContainer
 
 public class ImageIOTask extends MatchingTask 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:
- ImageOperation,- DataType
 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classImageIOTask.ImageFormatdefines acceptable image formats.
 - 
Field Summary- 
Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTaskfileset
 - 
Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
 
- 
 - 
Constructor SummaryConstructors Constructor Description ImageIOTask()
 - 
Method SummaryModifier and Type Method Description 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(java.io.File srcDir, java.lang.String[] srcNames, java.io.File dstDir, FileNameMapper mapper)Executes all the chained ImageOperations on the files inside the directory.voidprocessFile(java.io.File file)Deprecated.this method isn't used anymorevoidprocessFile(java.io.File file, java.io.File newFile)Executes all the chained ImageOperations on the file specified.voidsetDestDir(java.io.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.voidsetSrcdir(java.io.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.- 
Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTaskadd, 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, XsetItems
 - 
Methods inherited from class org.apache.tools.ant.TaskbindToOwner, 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.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation
 
- 
 
- 
- 
- 
Method Detail- 
addFilesetpublic void addFileset(FileSet set) Add a set of files to be deleted.- Parameters:
- set- the FileSet to add.
 
 - 
setFailOnErrorpublic 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.
 
 - 
setSrcdirpublic void setSrcdir(java.io.File srcDir) Set the source dir to find the image files.- Parameters:
- srcDir- the directory in which the image files reside.
 
 - 
setFormatpublic void setFormat(ImageIOTask.ImageFormat format) Set the output image format.- Parameters:
- format- an ImageFormat.
 
 - 
setOverwritepublic void setOverwrite(boolean overwrite) Set whether to overwrite a file if there is a naming conflict.- Parameters:
- overwrite- whether to overwrite.
 
 - 
setGcpublic 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.
 
 - 
setDestDirpublic void setDestDir(java.io.File destDir) Set the destination directory for manipulated images.- Parameters:
- destDir- The destination directory.
 
 - 
addImageOperationpublic void addImageOperation(ImageOperation instr) Add an ImageOperation to chain.- Parameters:
- instr- The ImageOperation to append to the chain.
 
 - 
addRotatepublic void addRotate(Rotate instr) Add a Rotate ImageOperation to the chain.- Parameters:
- instr- The Rotate operation to add to the chain.
- See Also:
- Rotate
 
 - 
addScalepublic void addScale(Scale instr) Add a Scale ImageOperation to the chain.- Parameters:
- instr- The Scale operation to add to the chain.
- See Also:
- Scale
 
 - 
addDrawpublic 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
 
 - 
addpublic void add(ImageOperation instr) Add an ImageOperation to chain.- Parameters:
- instr- The ImageOperation to append to the chain.
- Since:
- Ant 1.7
 
 - 
createMapperpublic Mapper createMapper() throws BuildException 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
 
 - 
addpublic void add(FileNameMapper fileNameMapper) Add a nested filenamemapper.- Parameters:
- fileNameMapper- the mapper to add.
- Since:
- Ant 1.8.0
 
 - 
processDirpublic int processDir(java.io.File srcDir, java.lang.String[] srcNames, java.io.File dstDir, FileNameMapper mapper)Executes all the chained ImageOperations on the files inside the directory.- Parameters:
- srcDir- File
- srcNames- String[]
- dstDir- File
- mapper- FileNameMapper
- Returns:
- int
- Since:
- Ant 1.8.0
 
 - 
processFile@Deprecated public void processFile(java.io.File file) Deprecated.this method isn't used anymoreExecutes all the chained ImageOperations on the file specified.- Parameters:
- file- The file to be processed.
 
 - 
processFilepublic void processFile(java.io.File file, java.io.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
 
 - 
executepublic void execute() throws BuildExceptionExecutes the Task.- Overrides:
- executein class- Task
- Throws:
- BuildException- on error.
 
 - 
validateAttributesprotected void validateAttributes() throws BuildExceptionEnsure 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.
 
 
- 
 
-