net.nicoulaj.maven.plugins.checksum.execution.target

Interface ExecutionTarget

All Known Implementing Classes:

CsvSummaryFileTarget, MavenLogTarget, OneHashPerFileTarget, ShasumSummaryFileTarget, XmlSummaryFileTarget

public interface ExecutionTarget

An ExecutionTarget is an output target for calculated digests.

Since:

1.0

Author:

Julien Nicoulaud

Method Summary

Modifier and Type	Method and Description
void	close(String subPath) Close the target.
void	init() Initialize the target.
void	write(String digest, ChecksumFile file, String algorithm) Write the hashcode calculated for the given file and algorithm to the target.

Method Detail

init

void init()
   throws ExecutionTargetInitializationException

Initialize the target.

Should be called before first call to write(String, ChecksumFile, String).

Throws:

ExecutionTargetInitializationException - if an error occured while initializing the target.

write

void write(String digest,
           ChecksumFile file,
           String algorithm)
    throws ExecutionTargetWriteException

Write the hashcode calculated for the given file and algorithm to the target.

Parameters:

digest - the digest to write.

file - the file for which the digest was calculated.

algorithm - the algorithm used to calculate the digest.

Throws:

ExecutionTargetWriteException - if an error occured while writing to the target.

close

void close(String subPath)
    throws ExecutionTargetCloseException

Close the target.

Should be called after last call to write(String, ChecksumFile, String).

Parameters:

subPath -

Throws:

ExecutionTargetCloseException - if an error occured while closing the target.