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

Class CsvSummaryFileTarget

java.lang.Object

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

All Implemented Interfaces:

ExecutionTarget

public class CsvSummaryFileTarget
extends Object
implements ExecutionTarget

An ExecutionTarget that writes digests to a CSV file.

Since:

1.0

Author:

Julien Nicoulaud

Field Summary

Fields

Modifier and Type	Field and Description
protected SortedSet<String>	algorithms The set of algorithms encountered.
protected Iterable<? extends ArtifactListener>	artifactListeners List of listeners which are notified every time a CSV file is created.
static String	CSV_COLUMN_SEPARATOR The CSV column separator character.
static String	CSV_COMMENT_MARKER The CSV comment marker character.
protected String	encoding Encoding to use for generated files.
protected Map<ChecksumFile,Map<String,String>>	filesHashcodes The association file => (algorithm,hashcode).
static String	LINE_SEPARATOR The line separator character.
protected File	summaryFile The target file where the summary is written.

Constructor Summary

Constructors

Constructor and Description
CsvSummaryFileTarget(File summaryFile, String encoding, Iterable<? extends ArtifactListener> artifactListeners) Build a new instance of CsvSummaryFileTarget.

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

LINE_SEPARATOR

public static final String LINE_SEPARATOR

The line separator character.

CSV_COLUMN_SEPARATOR

public static final String CSV_COLUMN_SEPARATOR

The CSV column separator character.

See Also:

Constant Field Values

CSV_COMMENT_MARKER

public static final String CSV_COMMENT_MARKER

The CSV comment marker character.

See Also:

Constant Field Values

encoding

protected String encoding

Encoding to use for generated files.

filesHashcodes

protected Map<ChecksumFile,Map<String,String>> filesHashcodes

The association file => (algorithm,hashcode).

algorithms

protected SortedSet<String> algorithms

The set of algorithms encountered.

summaryFile

protected File summaryFile

The target file where the summary is written.

artifactListeners

protected final Iterable<? extends ArtifactListener> artifactListeners

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

Since:

1.3

Constructor Detail

CsvSummaryFileTarget

public CsvSummaryFileTarget(File summaryFile,
                            String encoding,
                            Iterable<? extends ArtifactListener> artifactListeners)

Build a new instance of CsvSummaryFileTarget.

Parameters:

summaryFile - the file to which the summary should be written.

encoding - the encoding to use for generated files.

artifactListeners -

Method Detail

init

public void init()

Initialize the target.

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

Specified by:

init in interface ExecutionTarget

write

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

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.

close

public void close(String subPath)
           throws ExecutionTargetCloseException

Close the target.

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

Specified by:

close in interface ExecutionTarget

Throws:

ExecutionTargetCloseException - if an error occured while closing the target.