de.undercouch.gradle.tasks.download

Class Verify

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

de.undercouch.gradle.tasks.download.Verify

All Implemented Interfaces:

VerifySpec, java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>

public class Verify
extends org.gradle.api.DefaultTask
implements VerifySpec

Verifies a file's integrity by calculating its checksum.

 task verifyFile(type: Verify) {
     file new File(buildDir, "myfile.txt")
     algorithm 'MD5'
     checksum '694B2863621FCDBBBA2777BF329C056C' // expected checksum (hex)
 }
 

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

org.gradle.api.Task.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
Verify() Default constructor

Method Summary

Modifier and Type	Method and Description
void	algorithm(java.lang.String algorithm) Set the algorithm to use to compute the checksum.
void	checksum(java.lang.String checksum) Set the actual checksum to verify against
java.lang.String	getAlgorithm()
java.lang.String	getChecksum()
java.io.File	getSrc()
void	src(java.lang.Object src) Sets the file to verify
void	verify() Starts verifying

Methods inherited from class org.gradle.api.DefaultTask

compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

Methods inherited from class org.gradle.api.internal.AbstractTask

appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getOnlyIf, getReasonNotToTrackState, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, prependParallelSafeAction, setImpliesSubProjects

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gradle.api.Task

doNotTrackState, getConvention

Constructor Detail

Verify

public Verify()

Default constructor

Method Detail

verify

public void verify()
            throws java.io.IOException,
                   java.security.NoSuchAlgorithmException

Starts verifying

Throws:

java.io.IOException - if the file could not be verified

java.security.NoSuchAlgorithmException - if the given algorithm is not available

src

public void src(java.lang.Object src)

Description copied from interface: VerifySpec

Sets the file to verify

Specified by:

src in interface VerifySpec

Parameters:

src - the file (either a filename or a File object)

algorithm

public void algorithm(java.lang.String algorithm)

Description copied from interface: VerifySpec

Set the algorithm to use to compute the checksum. Defaults to "MD5" (see the list of algorithm names for more information).

Specified by:

algorithm in interface VerifySpec

Parameters:

algorithm - the name of the algorithm

checksum

public void checksum(java.lang.String checksum)

Description copied from interface: VerifySpec

Set the actual checksum to verify against

Specified by:

checksum in interface VerifySpec

Parameters:

checksum - the checksum (in hex)

getSrc

@InputFile
public java.io.File getSrc()

Specified by:

getSrc in interface VerifySpec

Returns:

the file to verify

getAlgorithm

@Input
 @Optional
public java.lang.String getAlgorithm()

Specified by:

getAlgorithm in interface VerifySpec

Returns:

the algorithm to use to compute the checksum

getChecksum

@Input
public java.lang.String getChecksum()

Specified by:

getChecksum in interface VerifySpec

Returns:

the actual checksum to verify against (in hex)