net.nicoulaj.maven.plugins.checksum.execution.target.ExecutionTarget Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maven-checksum-plugin Show documentation

Compute project artifacts/dependencies/files checksum digests and output them to individual or summary files.

There is a newer version: 1.0

Show newest version

/*
 * Copyright 2010 Julien Nicoulaud 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.nicoulaj.maven.plugins.checksum.execution.target;

import java.io.File;

/**
 * An {@link ExecutionTarget} is an output target for calculated digests.
 *
 * @author Julien Nicoulaud
 * @since 1.0
 */
public interface ExecutionTarget
{
    /**
     * Initialize the target.
     *
     * Should be called before first call to {@link #write(String, java.io.File, String)}.
     *
     * @throws ExecutionTargetInitializationException
     *          if an error occured while initializing the target.
     */
    void init() throws ExecutionTargetInitializationException;

    /**
     * Write the hashcode calculated for the given file and algorithm to the target.
     *
     * @param digest    the digest to write.
     * @param file      the file for which the digest was calculated.
     * @param algorithm the algorithm used to calculate the digest.
     * @throws ExecutionTargetWriteException if an error occured while writing to the target.
     */
    void write( String digest, File file, String algorithm ) throws ExecutionTargetWriteException;

    /**
     * Close the target.
     *
     * Should be called after last call to {@link #write(String, java.io.File, String)}.
     *
     * @throws ExecutionTargetCloseException if an error occured while closing the target.
     */
    void close() throws ExecutionTargetCloseException;
}