Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Ctors](https://developer.android.com/reference/javax/crypto/spec/RC5ParameterSpec#pubctors) \| [Methods](https://developer.android.com/reference/javax/crypto/spec/RC5ParameterSpec#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/javax/crypto/spec/RC5ParameterSpec#inhmethods)

# RC5ParameterSpec

` public class RC5ParameterSpec `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/java/security/spec/AlgorithmParameterSpec `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | javax.crypto.spec.RC5ParameterSpec |

<br />

*** ** * ** ***

This class specifies the parameters used with the [*RC5*](http://www.ietf.org/rfc/rfc2040.txt) 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 Inc.](http://www.rsasecurity.com), or any parties authorized by RSA Security.

## Summary

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/javax/crypto/spec/RC5ParameterSpec#RC5ParameterSpec(int,%20int,%20int)(int version, int rounds, int wordSize) ` Constructs a parameter set for RC5 from the given version, number of rounds and word size (in bits). |
| ` https://developer.android.com/reference/javax/crypto/spec/RC5ParameterSpec#RC5ParameterSpec(int,%20int,%20int,%20byte[])(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. |
| ` https://developer.android.com/reference/javax/crypto/spec/RC5ParameterSpec#RC5ParameterSpec(int,%20int,%20int,%20byte[],%20int)(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. |

| ### Public methods ||
|---|---|
| ` boolean` | ` https://developer.android.com/reference/javax/crypto/spec/RC5ParameterSpec#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Tests for equality between the specified object and this object. |
| ` byte[]` | ` https://developer.android.com/reference/javax/crypto/spec/RC5ParameterSpec#getIV()() ` Returns the IV or null if this parameter set does not contain an IV. |
| ` int` | ` https://developer.android.com/reference/javax/crypto/spec/RC5ParameterSpec#getRounds()() ` Returns the number of rounds. |
| ` int` | ` https://developer.android.com/reference/javax/crypto/spec/RC5ParameterSpec#getVersion()() ` Returns the version. |
| ` int` | ` https://developer.android.com/reference/javax/crypto/spec/RC5ParameterSpec#getWordSize()() ` Returns the word size in bits. |
| ` int` | ` https://developer.android.com/reference/javax/crypto/spec/RC5ParameterSpec#hashCode()() ` Calculates a hash code value for the object. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.

## Public constructors

### RC5ParameterSpec

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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).

<br />

| Parameters ||
|---|---|
| `version` | `int`: the version. <br /> |
| `rounds` | `int`: the number of rounds. <br /> |
| `wordSize` | `int`: the word size in bits. <br /> |

### RC5ParameterSpec

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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.

<br />

| Parameters ||
|---|---|
| `version` | `int`: the version. <br /> |
| `rounds` | `int`: the number of rounds. <br /> |
| `wordSize` | `int`: the word size in bits. <br /> |
| `iv` | `byte`: the buffer with the IV. The first `2*(wordSize/8) ` bytes of the buffer are copied to protect against subsequent modification. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if `iv` is `null` or `(iv.length < 2 * (wordSize / 8))` |

### RC5ParameterSpec

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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.

<br />

| Parameters ||
|---|---|
| `version` | `int`: the version. <br /> |
| `rounds` | `int`: the number of rounds. <br /> |
| `wordSize` | `int`: the word size in bits. <br /> |
| `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. <br /> |
| `offset` | `int`: the offset in `iv` where the IV starts. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if `iv` is `null` or `(iv.length - offset < 2 * (wordSize / 8))` |

## Public methods

### equals

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean equals (Object obj)
```

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.)

<br />

| Parameters ||
|---|---|
| `obj` | `Object`: the object to test for equality with this object. <br /> |

| Returns ||
|---|---|
| `boolean` | true if the objects are considered equal, false if `obj` is null or otherwise. <br /> |

### getIV

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public byte[] getIV ()
```

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

<br />

| 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. <br /> |

### getRounds

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getRounds ()
```

Returns the number of rounds.

<br />

| Returns ||
|---|---|
| `int` | the number of rounds. <br /> |

### getVersion

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getVersion ()
```

Returns the version.

<br />

| Returns ||
|---|---|
| `int` | the version. <br /> |

### getWordSize

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getWordSize ()
```

Returns the word size in bits.

<br />

| Returns ||
|---|---|
| `int` | the word size in bits. <br /> |

### hashCode

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int hashCode ()
```

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

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |