Package org.apache.tools.ant.taskdefs
Class Checksum
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.MatchingTask
org.apache.tools.ant.taskdefs.Checksum
- All Implemented Interfaces:
- Cloneable,- Condition,- SelectorContainer
Used to create or verify file checksums.
- Since:
- Ant 1.5
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionstatic classHelper class for the format attribute.
- 
Field SummaryFields inherited from class org.apache.tools.ant.taskdefs.MatchingTaskfilesetFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidAdd a resource collection.voidaddFileset(FileSet set) Files to generate checksums for.static byte[]decodeHex(char[] data) Converts an array of characters representing hexadecimal values into an array of bytes of those same values.booleaneval()Calculate the checksum(s)voidexecute()Calculate the checksum(s).voidsetAlgorithm(String algorithm) Specifies the algorithm to be used to compute the checksum.voidSets the file for which the checksum is to be calculated.voidsetFileext(String fileext) Sets the file extension that is be to used to create or identify destination file.voidsetForceOverwrite(boolean forceOverwrite) Whether or not to overwrite existing file irrespective of whether it is newer than the source file.voidSelect the in/output pattern via a well know format name.voidsetPattern(String pattern) Specify the pattern to use as a MessageFormat pattern.voidsetProperty(String property) Sets the property to hold the generated checksum.voidsetProvider(String provider) Sets the MessageDigest algorithm provider to be used to calculate the checksum.voidsetReadBufferSize(int size) The size of the read buffer to use.voidSets the root directory where checksum files will be written/readvoidsetTotalproperty(String totalproperty) Sets the property to hold the generated total checksum for all files.voidsetVerifyproperty(String verifyProperty) Sets the verify property.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, XsetItemsMethods 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, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation
- 
Constructor Details- 
Checksumpublic Checksum()
 
- 
- 
Method Details- 
setFileSets the file for which the checksum is to be calculated.- Parameters:
- file- a- Filevalue
 
- 
setTodirSets the root directory where checksum files will be written/read- Parameters:
- todir- the directory to write to
- Since:
- Ant 1.6
 
- 
setAlgorithmSpecifies the algorithm to be used to compute the checksum. Defaults to "MD5". Other popular algorithms like "SHA" may be used as well.- Parameters:
- algorithm- a- Stringvalue
 
- 
setProviderSets the MessageDigest algorithm provider to be used to calculate the checksum.- Parameters:
- provider- a- Stringvalue
 
- 
setFileextSets the file extension that is be to used to create or identify destination file.- Parameters:
- fileext- a- Stringvalue
 
- 
setPropertySets the property to hold the generated checksum.- Parameters:
- property- a- Stringvalue
 
- 
setTotalpropertySets the property to hold the generated total checksum for all files.- Parameters:
- totalproperty- a- Stringvalue
- Since:
- Ant 1.6
 
- 
setVerifypropertySets the verify property. This project property holds the result of a checksum verification - "true" or "false"- Parameters:
- verifyProperty- a- Stringvalue
 
- 
setForceOverwritepublic void setForceOverwrite(boolean forceOverwrite) Whether or not to overwrite existing file irrespective of whether it is newer than the source file. Defaults to false.- Parameters:
- forceOverwrite- a- booleanvalue
 
- 
setReadBufferSizepublic void setReadBufferSize(int size) The size of the read buffer to use.- Parameters:
- size- an- intvalue
 
- 
setFormatSelect the in/output pattern via a well know format name.- Parameters:
- e- an- enumeratedvalue
- Since:
- 1.7.0
 
- 
setPatternSpecify the pattern to use as a MessageFormat pattern.{0} gets replaced by the checksum, {1} by the filename. - Parameters:
- pattern- a- Stringvalue
- Since:
- 1.7.0
 
- 
addFilesetFiles to generate checksums for.- Parameters:
- set- a fileset of files to generate checksums for.
 
- 
addAdd a resource collection.- Parameters:
- rc- the ResourceCollection to add.
 
- 
executeCalculate the checksum(s).- Overrides:
- executein class- Task
- Throws:
- BuildException- on error
 
- 
evalCalculate the checksum(s)- Specified by:
- evalin interface- Condition
- Returns:
- Returns true if the checksum verification test passed, false otherwise.
- Throws:
- BuildException- on error
 
- 
decodeHexConverts an array of characters representing hexadecimal values into an array of bytes of those same values. The returned array will be half the length of the passed array, as it takes two characters to represent any given byte. An exception is thrown if the passed char array has an odd number of elements. NOTE: This code is copied from jakarta-commons codec.- Parameters:
- data- an array of characters representing hexadecimal values
- Returns:
- the converted array of bytes
- Throws:
- BuildException- on error
 
 
-