SHA3Digest (Bouncy Castle Library 1.68 API Specification)

java.lang.Object
- org.bouncycastle.crypto.digests.KeccakDigest
- - org.bouncycastle.crypto.digests.SHA3Digest

All Implemented Interfaces:

Digest, ExtendedDigest
```
public class SHA3Digest
extends KeccakDigest
```
implementation of SHA-3 based on following KeccakNISTInterface.c from http://keccak.noekeon.org/
Following the naming conventions used in the C source code to enable easy review of the implementation.

Field Summary
- Fields inherited from class org.bouncycastle.crypto.digests.KeccakDigest
  bitsInQueue, dataQueue, fixedOutputLength, rate, squeezing, state

Constructor Summary

Constructors
Constructor Description

SHA3Digest()

SHA3Digest(int bitLength)

SHA3Digest(SHA3Digest source)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`doFinal(byte[] out, int outOff)`	close the digest, producing the final digest value.
`protected int`	`doFinal(byte[] out, int outOff, byte partialByte, int partialBits)`
`java.lang.String`	`getAlgorithmName()`	return the algorithm name

Methods inherited from class org.bouncycastle.crypto.digests.KeccakDigest
absorb, absorb, absorbBits, dumpState, getByteLength, getDigestSize, reset, squeeze, update, update

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SHA3Digest
```
public SHA3Digest()
```
  - SHA3Digest
```
public SHA3Digest(int bitLength)
```
  - SHA3Digest
```
public SHA3Digest(SHA3Digest source)
```
- Method Detail
  - getAlgorithmName
```
public java.lang.String getAlgorithmName()
```
    Description copied from interface: Digest
    
    return the algorithm name
    
    Specified by:
    
    getAlgorithmName in interface Digest
    
    Overrides:
    
    getAlgorithmName in class KeccakDigest
    
    Returns:
    
    the algorithm name
  - doFinal
```
public int doFinal(byte[] out,
                   int outOff)
```
    Description copied from interface: Digest
    
    close the digest, producing the final digest value. The doFinal call leaves the digest reset.
    
    Specified by:
    
    doFinal in interface Digest
    
    Overrides:
    
    doFinal in class KeccakDigest
    
    Parameters:
    
    out - the array the digest is to be copied into.
    
    outOff - the offset into the out array the digest is to start at.
  - doFinal
```
protected int doFinal(byte[] out,
                      int outOff,
                      byte partialByte,
                      int partialBits)
```
    Overrides:
    
    doFinal in class KeccakDigest