net.nicoulaj.maven.plugins.checksum.digest

Interface FileDigester

All Known Implementing Classes:

AbstractFileDigester, CksumFileDigester, CRC32FileDigester, MessageDigestFileDigester

public interface FileDigester

Class for computing checksums digests from files.

Since:

1.0

Author:

Julien Nicoulaud

Field Summary

Fields

Modifier and Type	Field and Description
static int	STREAMING_BUFFER_SIZE The size of the buffer used to stream the files contents while calculating their hashcode.

Method Summary

Modifier and Type	Method and Description
String	calculate(File file) Calculate a checksum for a file.
String	getAlgorithm() Get the algorithm used to compute checksum digests.
String	getFileExtension() The filename extension for this digester.

Field Detail

STREAMING_BUFFER_SIZE

static final int STREAMING_BUFFER_SIZE

The size of the buffer used to stream the files contents while calculating their hashcode.

See Also:

Constant Field Values

Method Detail

getAlgorithm

String getAlgorithm()

Get the algorithm used to compute checksum digests.

Returns:

the algorithm.

getFileExtension

String getFileExtension()

The filename extension for this digester.

Returns:

the filename extension.

calculate

String calculate(File file)
          throws DigesterException,
                 NoSuchAlgorithmException

Calculate a checksum for a file.

Parameters:

file - the file to compute the checksum for.

Returns:

the current checksum.

Throws:

DigesterException - if there was a problem computing the hashcode.

NoSuchAlgorithmException - in case the given is not supported.