Top Description Fields Constructors Methods
javax.crypto.spec

public Class RC5ParameterSpec

extends Object
implements AlgorithmParameterSpec
Class Inheritance
All Implemented Interfaces
java.security.spec.AlgorithmParameterSpec
Imports
java.security.spec.AlgorithmParameterSpec, java.util.Arrays

This class specifies the parameters used with the RC5 algorithm.

The parameters consist of a version number, a rounds count, a word size, and optionally an initialization vector (IV) (only in feedback mode).

This class can be used to initialize a Cipher object that implements the RC5 algorithm as supplied by RSA Security LLC, or any parties authorized by RSA Security.

Author
Jan Luehe
Since
1.4

Field Summary

Modifier and TypeField and Description
private byte[]
private final int
private final int
private final int

Constructor Summary

AccessConstructor and Description
public
RC5ParameterSpec(int
the version.
version
,
int
the number of rounds.
rounds
,
int
the word size in bits.
wordSize
)

Constructs a parameter set for RC5 from the given version, number of rounds and word size (in bits).

public
RC5ParameterSpec(int
the version.
version
,
int
the number of rounds.
rounds
,
int
the word size in bits.
wordSize
,
byte[]
the buffer with the IV. The first 2*(wordSize/8) bytes of the buffer are copied to protect against subsequent modification.
iv
)

Constructs a parameter set for RC5 from the given version, number of rounds, word size (in bits), and IV.

public
RC5ParameterSpec(int
the version.
version
,
int
the number of rounds.
rounds
,
int
the word size in bits.
wordSize
,
byte[]
the buffer with the IV. The first 2*(wordSize/8) bytes of the buffer beginning at offset inclusive are copied to protect against subsequent modification.
iv
,
int
the offset in iv where the IV starts.
offset
)

Constructs a parameter set for RC5 from the given version, number of rounds, word size (in bits), and IV.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the objects are considered equal, false if obj is null or otherwise.
equals
(Object
the object to test for equality with this object.
obj
)

Overrides java.lang.Object.equals.

Tests for equality between the specified object and this object.

public byte[]

Returns:

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

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

public int

Returns:

the number of rounds.
getRounds
()

Returns the number of rounds.

public int

Returns:

the version.
getVersion
()

Returns the version.

public int

Returns:

the word size in bits.
getWordSize
()

Returns the word size in bits.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Calculates a hash code value for the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

ivback to summary
private byte[] iv
roundsback to summary
private final int rounds
versionback to summary
private final int version
wordSizeback to summary
private final int wordSize

Constructor Detail

RC5ParameterSpecback to summary
public RC5ParameterSpec(int version, int rounds, int wordSize)

Constructs a parameter set for RC5 from the given version, number of rounds and word size (in bits).

Parameters
version:int

the version.

rounds:int

the number of rounds.

wordSize:int

the word size in bits.

RC5ParameterSpecback to summary
public RC5ParameterSpec(int version, int rounds, int wordSize, byte[] iv)

Constructs a parameter set for RC5 from the given version, number of rounds, word size (in bits), and IV.

Note that the size of the IV (block size) must be twice the word size. The bytes that constitute the IV are those between iv[0] and iv[2*(wordSize/8)-1] inclusive.

Parameters
version:int

the version.

rounds:int

the number of rounds.

wordSize:int

the word size in bits.

iv:byte[]

the buffer with the IV. The first 2*(wordSize/8) bytes of the buffer are copied to protect against subsequent modification.

Exceptions
IllegalArgumentException:
if iv is null or (iv.length < 2 * (wordSize / 8))
RC5ParameterSpecback to summary
public RC5ParameterSpec(int version, int rounds, int wordSize, byte[] iv, int offset)

Constructs a parameter set for RC5 from the given version, number of rounds, word size (in bits), and IV.

The IV is taken from iv, starting at offset inclusive. Note that the size of the IV (block size), starting at offset inclusive, must be twice the word size. The bytes that constitute the IV are those between iv[offset] and iv[offset+2*(wordSize/8)-1] inclusive.

Parameters
version:int

the version.

rounds:int

the number of rounds.

wordSize:int

the word size in bits.

iv:byte[]

the buffer with the IV. The first 2*(wordSize/8) bytes of the buffer beginning at offset inclusive are copied to protect against subsequent modification.

offset:int

the offset in iv where the IV starts.

Exceptions
IllegalArgumentException:
if iv is null or (iv.length - offset < 2 * (wordSize / 8))

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Tests for equality between the specified object and this object. Two RC5ParameterSpec objects are considered equal if their version numbers, number of rounds, word sizes, and IVs are equal. (Two IV references are considered equal if both are null.)

Parameters
obj:Object

the object to test for equality with this object.

Returns:boolean

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

Annotations
@Override
getIVback to summary
public byte[] getIV()

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

Returns:byte[]

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

getRoundsback to summary
public int getRounds()

Returns the number of rounds.

Returns:int

the number of rounds.

getVersionback to summary
public int getVersion()

Returns the version.

Returns:int

the version.

getWordSizeback to summary
public int getWordSize()

Returns the word size in bits.

Returns:int

the word size in bits.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

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

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object

Annotations
@Override