|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.MatchingTask
org.apache.tools.ant.taskdefs.Checksum
public class Checksum
Used to create or verify file checksums.
| Nested Class Summary | |
|---|---|
static class |
Checksum.FormatElement
Helper class for the format attribute. |
| Field Summary |
|---|
| Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask |
|---|
fileset |
| Fields inherited from class org.apache.tools.ant.Task |
|---|
target, taskName, taskType, wrapper |
| Fields inherited from class org.apache.tools.ant.ProjectComponent |
|---|
description, location, project |
| Constructor Summary | |
|---|---|
Checksum()
|
|
| Method Summary | |
|---|---|
void |
add(ResourceCollection rc)
Add a resource collection. |
void |
addFileset(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. |
boolean |
eval()
Calculate the checksum(s) |
void |
execute()
Calculate the checksum(s). |
void |
setAlgorithm(java.lang.String algorithm)
Specifies the algorithm to be used to compute the checksum. |
void |
setFile(java.io.File file)
Sets the file for which the checksum is to be calculated. |
void |
setFileext(java.lang.String fileext)
Sets the file extension that is be to used to create or identify destination file. |
void |
setForceOverwrite(boolean forceOverwrite)
Whether or not to overwrite existing file irrespective of whether it is newer than the source file. |
void |
setFormat(Checksum.FormatElement e)
Select the in/output pattern via a well know format name. |
void |
setPattern(java.lang.String p)
Specify the pattern to use as a MessageFormat pattern. |
void |
setProperty(java.lang.String property)
Sets the property to hold the generated checksum. |
void |
setProvider(java.lang.String provider)
Sets the MessageDigest algorithm provider to be used to calculate the checksum. |
void |
setReadBufferSize(int size)
The size of the read buffer to use. |
void |
setTodir(java.io.File todir)
Sets the root directory where checksum files will be written/read |
void |
setTotalproperty(java.lang.String totalproperty)
Sets the property to hold the generated total checksum for all files. |
void |
setVerifyproperty(java.lang.String verifyProperty)
Sets the verify property. |
| 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, XsetItems |
| Methods 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, setTaskType |
| Methods inherited from class org.apache.tools.ant.ProjectComponent |
|---|
clone, getDescription, getLocation, getProject, setDescription, setLocation |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public Checksum()
| Method Detail |
|---|
public void setFile(java.io.File file)
file - a File valuepublic void setTodir(java.io.File todir)
todir - the directory to write topublic void setAlgorithm(java.lang.String algorithm)
algorithm - a String valuepublic void setProvider(java.lang.String provider)
provider - a String valuepublic void setFileext(java.lang.String fileext)
fileext - a String valuepublic void setProperty(java.lang.String property)
property - a String valuepublic void setTotalproperty(java.lang.String totalproperty)
totalproperty - a String valuepublic void setVerifyproperty(java.lang.String verifyProperty)
verifyProperty - a String valuepublic void setForceOverwrite(boolean forceOverwrite)
forceOverwrite - a boolean valuepublic void setReadBufferSize(int size)
size - an int valuepublic void setFormat(Checksum.FormatElement e)
e - an enumerated valuepublic void setPattern(java.lang.String p)
{0} gets replaced by the checksum, {1} by the filename.
p - a String valuepublic void addFileset(FileSet set)
set - a fileset of files to generate checksums for.public void add(ResourceCollection rc)
rc - the ResourceCollection to add.
public void execute()
throws BuildException
execute in class TaskBuildException - on error
public boolean eval()
throws BuildException
eval in interface ConditionBuildException - on error
public static byte[] decodeHex(char[] data)
throws BuildException
data - an array of characters representing hexadecimal values
BuildException - on error
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||