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

Class XmlSummaryFileTarget

java.lang.Object

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

All Implemented Interfaces:

ExecutionTarget

public class XmlSummaryFileTarget
extends Object
implements ExecutionTarget

An ExecutionTarget that writes digests to an XML file.

Since:

1.0

Author:

Julien Nicoulaud

Field Summary

Fields

Modifier and Type	Field and Description
protected Iterable<? extends ArtifactListener>	artifactListeners List of listeners which are notified every time a XML file is created.
protected String	encoding Encoding to use for generated files.
protected Map<ChecksumFile,Map<String,String>>	filesHashcodes The association file => (algorithm,hashcode).
protected File	summaryFile The target file where the summary is written.
static int	XML_INDENTATION_SIZE The number of spaces used to indent the output file.

Constructor Summary

Constructors

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

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

XML_INDENTATION_SIZE

public static final int XML_INDENTATION_SIZE

The number of spaces used to indent the output file.

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).

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 XML file is created.

Since:

1.3

Constructor Detail

XmlSummaryFileTarget

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

Build a new instance of XmlSummaryFileTarget.

Parameters:

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

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()

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

Parameters:

subPath - part of relative path to exclude from file path

Throws:

ExecutionTargetCloseException - if an error occured while closing the target.