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

Class OneHashPerFileTarget

java.lang.Object

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

All Implemented Interfaces:

ExecutionTarget

public class OneHashPerFileTarget
extends Object
implements ExecutionTarget

An ExecutionTarget that writes digests to separate files.

Since:

1.0

Author:

Julien Nicoulaud

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	appendFilename Append the filename to the hash file
protected Iterable<? extends ArtifactListener>	artifactListeners List of listeners which are notified every time a checksum file is created.
protected String	encoding Encoding to use for generated files.
protected File	outputDirectory The files output directory.

Constructor Summary

Constructors

Constructor and Description
OneHashPerFileTarget(String encoding, File outputDirectory, Iterable<? extends ArtifactListener> artifactListeners) Build a new instance of OneHashPerFileTarget.
OneHashPerFileTarget(String encoding, File outputDirectory, Iterable<? extends ArtifactListener> artifactListeners, boolean appendFilename) Build a new instance of OneHashPerFileTarget.
OneHashPerFileTarget(String encoding, Iterable<? extends ArtifactListener> artifactListeners) Build a new instance of OneHashPerFileTarget.

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.

Methods inherited from class java.lang.Object

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

Field Detail

encoding

protected String encoding

Encoding to use for generated files.

outputDirectory

protected File outputDirectory

The files output directory.

artifactListeners

protected final Iterable<? extends ArtifactListener> artifactListeners

List of listeners which are notified every time a checksum file is created.

Since:

1.3

appendFilename

protected boolean appendFilename

Append the filename to the hash file

Since:

1.4

Constructor Detail

OneHashPerFileTarget

public OneHashPerFileTarget(String encoding,
                            File outputDirectory,
                            Iterable<? extends ArtifactListener> artifactListeners)

Build a new instance of OneHashPerFileTarget.

Parameters:

encoding - the encoding to use for generated files.

outputDirectory - the files output directory.

artifactListeners - listeners which are notified every time a CSV file is created

OneHashPerFileTarget

public OneHashPerFileTarget(String encoding,
                            File outputDirectory,
                            Iterable<? extends ArtifactListener> artifactListeners,
                            boolean appendFilename)

Build a new instance of OneHashPerFileTarget.

Parameters:

encoding - the encoding to use for generated files.

outputDirectory - the files output directory.

artifactListeners - listeners which are notified every time a CSV file is created

appendFilename - add filename in generated file

OneHashPerFileTarget

public OneHashPerFileTarget(String encoding,
                            Iterable<? extends ArtifactListener> artifactListeners)

Build a new instance of OneHashPerFileTarget.

Parameters:

encoding - the encoding to use for generated files.

artifactListeners - listeners which are notified every time a CSV file is created

Method Detail

init

public void init()
          throws ExecutionTargetInitializationException

Initialize the target.

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

Specified by:

init in interface ExecutionTarget

Throws:

ExecutionTargetInitializationException - if an error occured while initializing the target.

write

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

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

Specified by:

write in interface ExecutionTarget

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

public void close(String subPath)

Close the target.

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

Specified by:

close in interface ExecutionTarget

Parameters:

subPath - part of relative path to exclude from file path