Modifier and Type	Class and Description
private static class	Checksum.FileUnion
public static class	Checksum.FormatElement Helper class for the format attribute.

Field Summary

Modifier and Type	Field and Description
private String	algorithm MessageDigest algorithm to be used.
private Map<File, byte[]>	allDigests Holds checksums for all files (both calculated and cached on disk).
private static final int	BUFFER_SIZE
private static final int	BYTE_MASK
private File	file File for which checksum is to be calculated.
private String	fileext File Extension that is be to used to create or identify destination file
private boolean	forceOverwrite Whether or not to create a new file.
private MessageFormat	format Formatter for the checksum file.
private Hashtable<File, Object>	includeFileMap Stores SourceFile, DestFile pairs and SourceFile, Property String pairs.
private boolean	isCondition is this task being used as a nested condition element?
private MessageDigest	messageDigest Message Digest instance
private static final int	NIBBLE
private String	property Holds generated checksum and gets set as a Project Property.
private String	provider MessageDigest Algorithm provider
private int	readBufferSize Size of the read buffer to use.
private Map<File, String>	relativeFilePaths Holds relative file names for all files (always with a forward slash).
private Checksum.FileUnion	resources Resource Collection.
private File	todir Root directory in which the checksum files will be written.
private String	totalproperty Property where totalChecksum gets set.
private String	verifyProperty Contains the result of a checksum verification.
private static final int	WORD

Inherited from org.apache.tools.ant.taskdefs.MatchingTask:: fileset

Constructor Summary

Access	Constructor and Description
public	Checksum()

Method Summary

Modifier and Type	Method and Description
public void	add(ResourceCollection the ResourceCollection to add. rc) Add a resource collection.
public void	addFileset(FileSet a fileset of files to generate checksums for. set) Files to generate checksums for.
private void	addToIncludeFileMap(File file) Add key-value pair to the hashtable upon which to later operate upon.
private String	createDigestString(byte[] fileDigest)
public static byte[]	Returns: the converted array of bytes decodeHex(char[] an array of characters representing hexadecimal values data) Converts an array of characters representing hexadecimal values into an array of bytes of those same values.
public boolean	Returns: Returns true if the checksum verification test passed, false otherwise. eval() Implements org.apache.tools.ant.taskdefs.condition.Condition.eval. Calculate the checksum(s)
public void	execute() Overrides org.apache.tools.ant.Task.execute. Calculate the checksum(s).
private boolean	generateChecksums() Generate checksum(s) using the message digest created earlier.
private File	getChecksumFile(File file)
private String	getRelativeFilePath(File f)
private String	readChecksum(File f) reads the checksum from a file using the specified format.
public void	setAlgorithm(String a `String` value algorithm) Specifies the algorithm to be used to compute the checksum.
public void	setFile(File a `File` value file) Sets the file for which the checksum is to be calculated.
public void	setFileext(String a `String` value fileext) Sets the file extension that is be to used to create or identify destination file.
public void	setForceOverwrite(boolean a `boolean` value forceOverwrite) Whether or not to overwrite existing file irrespective of whether it is newer than the source file.
public void	setFormat(Checksum.FormatElement an `enumerated` value e) Select the in/output pattern via a well know format name.
public void	setPattern(String a `String` value pattern) Specify the pattern to use as a MessageFormat pattern.
public void	setProperty(String a `String` value property) Sets the property to hold the generated checksum.
public void	setProvider(String a `String` value provider) Sets the MessageDigest algorithm provider to be used to calculate the checksum.
public void	setReadBufferSize(int an `int` value size) The size of the read buffer to use.
public void	setTodir(File the directory to write to todir) Sets the root directory where checksum files will be written/read
public void	setTotalproperty(String a `String` value totalproperty) Sets the property to hold the generated total checksum for all files.
public void	setVerifyproperty(String a `String` value verifyProperty) Sets the verify property.
private boolean	validateAndExecute() Validate attributes and get down to business.

Field Detail

algorithm	back to summary
private String algorithm MessageDigest algorithm to be used.

allDigests	back to summary
private Map<File, byte[]> allDigests Holds checksums for all files (both calculated and cached on disk). Key: java.util.File (source file) Value: java.lang.String (digest)

BUFFER_SIZE	back to summary
private static final int BUFFER_SIZE

BYTE_MASK	back to summary
private static final int BYTE_MASK

file	back to summary
private File file File for which checksum is to be calculated.

fileext	back to summary
private String fileext File Extension that is be to used to create or identify destination file

forceOverwrite	back to summary
private boolean forceOverwrite Whether or not to create a new file. Defaults to `false`.

format	back to summary
private MessageFormat format Formatter for the checksum file.

includeFileMap	back to summary
private Hashtable<File, Object> includeFileMap Stores SourceFile, DestFile pairs and SourceFile, Property String pairs.

isCondition	back to summary
private boolean isCondition is this task being used as a nested condition element?

messageDigest	back to summary
private MessageDigest messageDigest Message Digest instance

NIBBLE	back to summary
private static final int NIBBLE

property	back to summary
private String property Holds generated checksum and gets set as a Project Property.

provider	back to summary
private String provider MessageDigest Algorithm provider

readBufferSize	back to summary
private int readBufferSize Size of the read buffer to use.

relativeFilePaths	back to summary
private Map<File, String> relativeFilePaths Holds relative file names for all files (always with a forward slash). This is used to calculate the total hash. Key: java.util.File (source file) Value: java.lang.String (relative file name)

resources	back to summary
private Checksum.FileUnion resources Resource Collection.

todir	back to summary
private File todir Root directory in which the checksum files will be written. If not specified, the checksum files will be written in the same directory as each file.

totalproperty	back to summary
private String totalproperty Property where totalChecksum gets set.

verifyProperty	back to summary
private String verifyProperty Contains the result of a checksum verification. ("true" or "false")

WORD	back to summary
private static final int WORD

Constructor Detail

Checksum	back to summary
public Checksum()

Method Detail

add	back to summary
public void add(ResourceCollection rc) Add a resource collection. Parameters rc:ResourceCollection the ResourceCollection to add.

add

back to summary

public void add(ResourceCollection rc)

Add a resource collection.

Parameters

rc:ResourceCollection: the ResourceCollection to add.

addFileset	back to summary
public void addFileset(FileSet set) Files to generate checksums for. Parameters set:FileSet a fileset of files to generate checksums for.

addFileset

back to summary

public void addFileset(FileSet set)

Files to generate checksums for.

Parameters

set:FileSet: a fileset of files to generate checksums for.

addToIncludeFileMap	back to summary
private void addToIncludeFileMap(File file) throws BuildException Add key-value pair to the hashtable upon which to later operate upon.

createDigestString	back to summary
private String createDigestString(byte[] fileDigest)

decodeHex	back to summary
public static byte[] decodeHex(char[] data) throws BuildException Converts 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:char[] an array of characters representing hexadecimal values Returns:byte[] the converted array of bytes Exceptions BuildException: on error

decodeHex

back to summary

public static byte[] decodeHex(char[] data) throws BuildException

Converts 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:char[]: an array of characters representing hexadecimal values

Returns:byte[]

the converted array of bytes

Exceptions

BuildException:: on error

eval	back to summary
public boolean eval() throws BuildException Implements org.apache.tools.ant.taskdefs.condition.Condition.eval. Calculate the checksum(s) Returns:boolean Returns true if the checksum verification test passed, false otherwise. Annotations @Override Exceptions BuildException: on error

eval

back to summary

public boolean eval() throws BuildException

Implements org.apache.tools.ant.taskdefs.condition.Condition.eval.

Calculate the checksum(s)

Returns:boolean

Returns true if the checksum verification test passed, false otherwise.

Annotations

@Override

Exceptions

BuildException:: on error

execute	back to summary
public void execute() throws BuildException Overrides org.apache.tools.ant.Task.execute. Calculate the checksum(s). Annotations @Override Exceptions BuildException: on error

execute

back to summary

public void execute() throws BuildException

Overrides org.apache.tools.ant.Task.execute.

Calculate the checksum(s).

Annotations

@Override

Exceptions

BuildException:: on error

generateChecksums	back to summary
private boolean generateChecksums() throws BuildException Generate checksum(s) using the message digest created earlier.

getChecksumFile	back to summary
private File getChecksumFile(File file)

getRelativeFilePath	back to summary
private String getRelativeFilePath(File f) Since Ant 1.8.2

readChecksum	back to summary
private String readChecksum(File f) reads the checksum from a file using the specified format. Since 1.7

readChecksum

back to summary

private String readChecksum(File f)

reads the checksum from a file using the specified format.

Since: 1.7

setAlgorithm back to summary

setAlgorithm	back to summary
public void setAlgorithm(String algorithm) Specifies the algorithm to be used to compute the checksum. Defaults to "MD5". Other popular algorithms like "SHA" may be used as well. Parameters algorithm:String a `String` value

public void setAlgorithm(String algorithm)

Specifies the algorithm to be used to compute the checksum. Defaults to "MD5". Other popular algorithms like "SHA" may be used as well.

Parameters

algorithm:String: a String value

setFile back to summary

setFile	back to summary
public void setFile(File file) Sets the file for which the checksum is to be calculated. Parameters file:File a `File` value

public void setFile(File file)

Sets the file for which the checksum is to be calculated.

Parameters

file:File: a File value

setFileext back to summary

setFileext	back to summary
public void setFileext(String fileext) Sets the file extension that is be to used to create or identify destination file. Parameters fileext:String a `String` value

public void setFileext(String fileext)

Sets the file extension that is be to used to create or identify destination file.

Parameters

fileext:String: a String value

setForceOverwrite back to summary

setForceOverwrite	back to summary
public 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:boolean a `boolean` value

public 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:boolean: a boolean value

setFormat back to summary

setFormat	back to summary
public void setFormat(Checksum.FormatElement e) Select the in/output pattern via a well know format name. Parameters e:Checksum.FormatElement an `enumerated` value Since 1.7.0

public void setFormat(Checksum.FormatElement e)

Select the in/output pattern via a well know format name.

Parameters

e:Checksum.FormatElement: an enumerated value

Since

1.7.0

setPattern back to summary

setPattern	back to summary
public void setPattern(String pattern) Specify the pattern to use as a MessageFormat pattern. {0} gets replaced by the checksum, {1} by the filename. Parameters pattern:String a `String` value Since 1.7.0

public void setPattern(String pattern)

Specify the pattern to use as a MessageFormat pattern.

{0} gets replaced by the checksum, {1} by the filename.

Parameters

pattern:String: a String value

Since

1.7.0

setProperty back to summary

setProperty	back to summary
public void setProperty(String property) Sets the property to hold the generated checksum. Parameters property:String a `String` value

public void setProperty(String property)

Sets the property to hold the generated checksum.

Parameters

property:String: a String value

setProvider back to summary

setProvider	back to summary
public void setProvider(String provider) Sets the MessageDigest algorithm provider to be used to calculate the checksum. Parameters provider:String a `String` value

public void setProvider(String provider)

Sets the MessageDigest algorithm provider to be used to calculate the checksum.

Parameters

provider:String: a String value

setReadBufferSize back to summary

setReadBufferSize	back to summary
public void setReadBufferSize(int size) The size of the read buffer to use. Parameters size:int an `int` value

public void setReadBufferSize(int size)

The size of the read buffer to use.

Parameters

size:int: an int value

setTodir	back to summary
public void setTodir(File todir) Sets the root directory where checksum files will be written/read Parameters todir:File the directory to write to Since Ant 1.6

setTodir

back to summary

public void setTodir(File todir)

Sets the root directory where checksum files will be written/read

Parameters

todir:File: the directory to write to

Since

Ant 1.6

setTotalproperty back to summary

setTotalproperty	back to summary
public void setTotalproperty(String totalproperty) Sets the property to hold the generated total checksum for all files. Parameters totalproperty:String a `String` value Since Ant 1.6

public void setTotalproperty(String totalproperty)

Sets the property to hold the generated total checksum for all files.

Parameters

totalproperty:String: a String value

Since

Ant 1.6

setVerifyproperty back to summary

setVerifyproperty	back to summary
public void setVerifyproperty(String verifyProperty) Sets the verify property. This project property holds the result of a checksum verification - "true" or "false" Parameters verifyProperty:String a `String` value

public void setVerifyproperty(String verifyProperty)

Sets the verify property. This project property holds the result of a checksum verification - "true" or "false"

Parameters

verifyProperty:String: a String value

validateAndExecute	back to summary
private boolean validateAndExecute() throws BuildException Validate attributes and get down to business.

org.apache.tools.ant.taskdefs back to summary

private Class Checksum.FileUnion

Class Inheritance

extends Restrict

java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
org.apache.tools.ant.types.resources.selectors.ResourceSelectorContainer
org.apache.tools.ant.types.resources.Restrict
org.apache.tools.ant.taskdefs.Checksum.FileUnion

Field Summary

Modifier and Type	Field and Description
private Union	u

Constructor Summary

Access	Constructor and Description
pack-priv	FileUnion()

Method Summary

Modifier and Type	Method and Description
public void	add(ResourceCollection the ResourceCollection to add. rc) Overrides org.apache.tools.ant.types.resources.Restrict.add. Add the ResourceCollection.

Inherited from org.apache.tools.ant.types.resources.Restrict:: add dieOnCircularReference isCache isFilesystemOnly iterator setCache size toString

Field Detail

u	back to summary
private Union u

Constructor Detail

FileUnion	back to summary
pack-priv FileUnion()

Method Detail

add

back to summary

public void add(ResourceCollection rc)

Overrides org.apache.tools.ant.types.resources.Restrict.add.

Doc from org.apache.tools.ant.types.resources.Restrict.add.

Add the ResourceCollection.

Parameters

rc:ResourceCollection: the ResourceCollection to add.

Annotations

@Override

org.apache.tools.ant.taskdefs back to summary

public Class Checksum.FormatElement

Class Inheritance

extends EnumeratedAttribute

java.lang.Object
org.apache.tools.ant.types.EnumeratedAttribute
org.apache.tools.ant.taskdefs.Checksum.FormatElement

Helper class for the format attribute.

Since: 1.7

Field Summary

Modifier and Type	Field and Description
private static final String	CHECKSUM
private static HashMap<String, MessageFormat>	formatMap
private static final String	MD5SUM
private static final String	SVF

Inherited from org.apache.tools.ant.types.EnumeratedAttribute:: value

Constructor Summary

Access	Constructor and Description
public	FormatElement()

Method Summary

Modifier and Type	Method and Description
public static Checksum.FormatElement	Returns: the defaul value. getDefault() Get the default value - CHECKSUM.
public MessageFormat	Returns: a `MessageFormat` object. getFormat() Convert this enumerated type to a `MessageFormat`.
public String[]	Returns: an array of values. getValues() Implements abstract org.apache.tools.ant.types.EnumeratedAttribute.getValues. Get the valid values.

Inherited from org.apache.tools.ant.types.EnumeratedAttribute:: containsValue getIndex getInstance getValue indexOfValue setValue toString

Field Detail

CHECKSUM	back to summary
private static final String CHECKSUM

formatMap	back to summary
private static HashMap<String, MessageFormat> formatMap

MD5SUM	back to summary
private static final String MD5SUM

SVF	back to summary
private static final String SVF

Constructor Detail

FormatElement	back to summary
public FormatElement()

Method Detail

getDefault

back to summary

public static Checksum.FormatElement getDefault()

Get the default value - CHECKSUM.

Returns:Checksum.FormatElement: the defaul value.

getFormat back to summary

public MessageFormat getFormat()

Convert this enumerated type to a MessageFormat.

Returns:MessageFormat: a MessageFormat object.

getValues

back to summary

public String[] getValues()

Implements abstract org.apache.tools.ant.types.EnumeratedAttribute.getValues.

Get the valid values.

Returns:String[]

an array of values.

Annotations

@Override

public Class Checksum

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Checksum.FileUnion

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Checksum.FormatElement

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail