net.rim.device.api.crypto
Class NullDigest

java.lang.Object
  net.rim.device.api.crypto.AbstractDigest
      net.rim.device.api.crypto.NullDigest

All Implemented Interfaces:

Digest

public final class NullDigest
extends AbstractDigest
implements Digest

Allows for a user to provide a digest with no functionality to a function that requires a digest. It is provided for instances when no digest is required initially and further in the protocol or application a new digest is required. The methods in this class do not perform any operations. For information on cryptographic algorithms, see Crypto Algorithms.

See Also:

NullEncryptor, NullDecryptor

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

Constructor Summary
	NullDigest() This constructor is not used.

Method Summary
	String	getAlgorithm() Returns the name of this digest, "Null" in this case.
	int	getDigest(byte[] buffer, int offset, boolean resetDigest) Returns zero (0) specifying that no information was hashed and that there is no information to return from the null digest.
	int	getDigestLength() Returns zero (0), since this is a null digest with a length of zero.
	void	reset() Reinitializes the digest.
	void	update(byte[] data, int offset, int length) Passes a byte array of data, specified by the length and offset, into the hash algorithm.
	void	update(int data) Passes a single byte into the hash algorithm.

Methods inherited from class net.rim.device.api.crypto.AbstractDigest

getBlockLength, getDigest, getDigest, getDigest, update

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.rim.device.api.crypto.Digest

getBlockLength, getDigest, getDigest, getDigest, update

Constructor Detail

NullDigest

public NullDigest()

This constructor is not used.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

Method Detail

getAlgorithm

public String getAlgorithm()

Returns the name of this digest, "Null" in this case.

Specified by:

getAlgorithm in interface Digest

Specified by:

getAlgorithm in class AbstractDigest

Returns:

A String representing the name of the digest.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

reset

public void reset()

Description copied from class: AbstractDigest

Reinitializes the digest.

Specified by:

reset in interface Digest

Specified by:

reset in class AbstractDigest

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

update

public void update(int data)

Description copied from class: AbstractDigest

Passes a single byte into the hash algorithm.

Specified by:

update in interface Digest

Overrides:

update in class AbstractDigest

Parameters:

data - The byte to be hashed.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

update

public void update(byte[] data,
                   int offset,
                   int length)

Description copied from class: AbstractDigest

Passes a byte array of data, specified by the length and offset, into the hash algorithm.

Specified by:

update in interface Digest

Specified by:

update in class AbstractDigest

Parameters:

data - The array containing the input data.

offset - The offset of the input data.

length - The length of the input data.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

getDigestLength

public int getDigestLength()

Returns zero (0), since this is a null digest with a length of zero.

Specified by:

getDigestLength in interface Digest

Specified by:

getDigestLength in class AbstractDigest

Returns:

An integer that represents the length of the digest.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0

getDigest

public int getDigest(byte[] buffer,
                     int offset,
                     boolean resetDigest)

Returns zero (0) specifying that no information was hashed and that there is no information to return from the null digest.

Specified by:

getDigest in interface Digest

Specified by:

getDigest in class AbstractDigest

Parameters:

buffer - Ignored.

offset - Ignored.

resetDigest - Ignored.

Returns:

An integer with the value Zero (0).

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 3.6.0