RC2ParameterSpec

AI-generated Key Takeaways

• RC2ParameterSpec defines parameters for the RC2 encryption algorithm, including effective key size and an optional initialization vector (IV).

• It can be used to initialize Cipher objects implementing the RC2 algorithm.

• The class provides constructors to specify the effective key size and IV, along with methods to retrieve these parameters.

• RC2ParameterSpec objects can be compared for equality based on their effective key sizes and IVs.

public class RC2ParameterSpec extends Object
implements AlgorithmParameterSpec

This class specifies the parameters used with the RC2 algorithm.

The parameters consist of an effective key size and optionally an 8-byte initialization vector (IV) (only in feedback mode).

This class can be used to initialize a Cipher object that implements the RC2 algorithm.

Public Constructor Summary

	RC2ParameterSpec(int effectiveKeyBits) Constructs a parameter set for RC2 from the given effective key size (in bits).
	RC2ParameterSpec(int effectiveKeyBits, byte[] iv) Constructs a parameter set for RC2 from the given effective key size (in bits) and an 8-byte IV.
	RC2ParameterSpec(int effectiveKeyBits, byte[] iv, int offset) Constructs a parameter set for RC2 from the given effective key size (in bits) and IV.

Public Method Summary

boolean	equals(Object obj) Tests for equality between the specified object and this object.
int	getEffectiveKeyBits() Returns the effective key size in bits.
byte[]	getIV() Returns the IV or null if this parameter set does not contain an IV.
int	hashCode() Calculates a hash code value for the object.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Public Constructors

public RC2ParameterSpec (int effectiveKeyBits)

Constructs a parameter set for RC2 from the given effective key size (in bits).

Parameters

effectiveKeyBits	the effective key size in bits.

public RC2ParameterSpec (int effectiveKeyBits, byte[] iv)

Constructs a parameter set for RC2 from the given effective key size (in bits) and an 8-byte IV.

The bytes that constitute the IV are those between iv[0] and iv[7] inclusive.

Parameters

effectiveKeyBits	the effective key size in bits.
iv	the buffer with the 8-byte IV. The first 8 bytes of the buffer are copied to protect against subsequent modification.

Throws

IllegalArgumentException	if iv is null.

public RC2ParameterSpec (int effectiveKeyBits, byte[] iv, int offset)

Constructs a parameter set for RC2 from the given effective key size (in bits) and IV.

The IV is taken from iv, starting at offset inclusive. The bytes that constitute the IV are those between iv[offset] and iv[offset+7] inclusive.

Parameters

effectiveKeyBits	the effective key size in bits.
iv	the buffer with the IV. The first 8 bytes of the buffer beginning at offset inclusive are copied to protect against subsequent modification.
offset	the offset in iv where the 8-byte IV starts.

Throws

IllegalArgumentException	if iv is null.

Public Methods

public boolean equals (Object obj)

Tests for equality between the specified object and this object. Two RC2ParameterSpec objects are considered equal if their effective key sizes and IVs are equal. (Two IV references are considered equal if both are null.)

Parameters

obj	the object to test for equality with this object.

Returns

• true if the objects are considered equal, false if obj is null or otherwise.

public int getEffectiveKeyBits ()

Returns the effective key size in bits.

Returns

• the effective key size in bits.

public byte[] getIV ()

Returns the IV or null if this parameter set does not contain an IV.

Returns

• the IV or null if this parameter set does not contain an IV. Returns a new array each time this method is called.

public int hashCode ()

Calculates a hash code value for the object. Objects that are equal will also have the same hashcode.

Returns

• this object's hash code.