org.bouncycastle.openpgp.operator.PGPDigestCalculator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bcpg-jdk15on Show documentation

The Bouncy Castle Java API for handling the OpenPGP protocol. This jar contains the OpenPGP API for JDK 1.5 to JDK 1.7. The APIs can be used in conjunction with a JCE/JCA provider such as the one provided with the Bouncy Castle Cryptography APIs.

There is a newer version: 1.70

Show newest version

package org.bouncycastle.openpgp.operator;

import java.io.OutputStream;

import org.bouncycastle.bcpg.HashAlgorithmTags;

/**
 * A digest calculator, which consumes a stream of data and computes a digest value over it.
 */
public interface PGPDigestCalculator
{
    /**
     * Return the {@link HashAlgorithmTags algorithm number} representing the digest implemented by
     * this calculator.
     * 
     * @return the hash algorithm number
     */
    int getAlgorithm();

    /**
     * Returns a stream that will accept data for the purpose of calculating a digest. Use
     * org.bouncycastle.util.io.TeeOutputStream if you want to accumulate the data on the fly as
     * well.
     * 
     * @return an OutputStream that data to be digested can be written to.
     */
    OutputStream getOutputStream();

    /**
     * Return the digest calculated on what has been written to the calculator's output stream.
     *
     * @return a digest.
     */
    byte[] getDigest();

    /**
     * Reset the underlying digest calculator
     */
    void reset();
}