# RC2ParameterSpec

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/RC2ParameterSpec#pubctors)\|[Methods](https://developer.android.com/reference/javax/crypto/spec/RC2ParameterSpec#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/javax/crypto/spec/RC2ParameterSpec#inhmethods)  

# RC2ParameterSpec

`
public


class
RC2ParameterSpec
`  
`

extends `[Object](https://developer.android.com/reference/java/lang/Object)`


``


implements

`[AlgorithmParameterSpec](https://developer.android.com/reference/java/security/spec/AlgorithmParameterSpec)`


`

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

<br />

*** ** * ** ***

This class specifies the parameters used with the[*RC2*](http://www.ietf.org/rfc/rfc2268.txt)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.

## Summary

|                                                                                                                              ### Public constructors                                                                                                                               ||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[RC2ParameterSpec](https://developer.android.com/reference/javax/crypto/spec/RC2ParameterSpec#RC2ParameterSpec(int))`(int effectiveKeyBits) ` Constructs a parameter set for RC2 from the given effective key size (in bits).                                                |
| ` `[RC2ParameterSpec](https://developer.android.com/reference/javax/crypto/spec/RC2ParameterSpec#RC2ParameterSpec(int,%20byte[]))`(int effectiveKeyBits, byte[] iv) ` Constructs a parameter set for RC2 from the given effective key size (in bits) and an 8-byte IV.          |
| ` `[RC2ParameterSpec](https://developer.android.com/reference/javax/crypto/spec/RC2ParameterSpec#RC2ParameterSpec(int,%20byte[],%20int))`(int effectiveKeyBits, byte[] iv, int offset) ` Constructs a parameter set for RC2 from the given effective key size (in bits) and IV. |

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

| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object)          | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object.                                                                                                                                                      | | ` boolean`                                                                     | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                           | | ` void`                                                                        | ` `[finalize](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 `[Class](https://developer.android.com/reference/java/lang/Class)`<?>` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`.                                                                                                                                                | | ` int`                                                                         | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                 | | ` final void`                                                                  | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor.                                                                                                                            | | ` final void`                                                                  | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor.                                                                                                                         | | ` `[String](https://developer.android.com/reference/java/lang/String)          | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object.                                                                                                                                            | | ` final void`                                                                  | ` `[wait](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`                                                                  | ` `[wait](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`                                                                  | ` `[wait](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

### RC2ParameterSpec

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

```
public RC2ParameterSpec (int effectiveKeyBits)
```

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

<br />

|                            Parameters                             ||
|--------------------|-----------------------------------------------|
| `effectiveKeyBits` | `int`: the effective key size in bits. <br /> |

### RC2ParameterSpec

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

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

<br />

|                                                                        Parameters                                                                        ||
|--------------------|--------------------------------------------------------------------------------------------------------------------------------------|
| `effectiveKeyBits` | `int`: the effective key size in bits. <br />                                                                                        |
| `iv`               | `byte`: the buffer with the 8-byte IV. The first 8 bytes of the buffer are copied to protect against subsequent modification. <br /> |

|                                                         Throws                                                         ||
|--------------------------------------------------------------------------------------------------------|----------------|
| [IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException) | if`iv`is null. |

### RC2ParameterSpec

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

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

<br />

|                                                                                   Parameters                                                                                    ||
|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `effectiveKeyBits` | `int`: the effective key size in bits. <br />                                                                                                               |
| `iv`               | `byte`: the buffer with the IV. The first 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 8-byte IV starts. <br />                                                                                                  |

|                                                         Throws                                                         ||
|--------------------------------------------------------------------------------------------------------|----------------|
| [IllegalArgumentException](https://developer.android.com/reference/java/lang/IllegalArgumentException) | if`iv`is null. |

## 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 RC2ParameterSpec objects are considered equal if their effective key sizes and IVs are equal. (Two IV references are considered equal if both arenull.)

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

### getEffectiveKeyBits

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

```
public int getEffectiveKeyBits ()
```

Returns the effective key size in bits.

<br />

|                    Returns                    ||
|-------|----------------------------------------|
| `int` | the effective key size in bits. <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 /> |

### 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 /> |