RC5ParameterSpec (Java SE 11 & JDK 11 ) (original) (raw)

• java.lang.Object

• • javax.crypto.spec.RC5ParameterSpec

• All Implemented Interfaces:
  [AlgorithmParameterSpec](../../../java/security/spec/AlgorithmParameterSpec.html "interface in java.security.spec")

public class RC5ParameterSpec
extends Object
implements AlgorithmParameterSpec
This class specifies the parameters used with theRC5 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 byRSA Security LLC, or any parties authorized by RSA Security.
Since:
1.4

• • Constructor Summary

  Constructors

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

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  boolean	equals​(Object obj)	Tests for equality between the specified object and this object.
  byte[]	getIV()	Returns the IV or null if this parameter set does not contain an IV.
  int	getRounds()	Returns the number of rounds.
  int	getVersion()	Returns the version.
  int	getWordSize()	Returns the word size in bits.
  int	hashCode()	Calculates a hash code value for the object.

     * ### Methods declared in class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
     `[clone](../../../java/lang/Object.html#clone%28%29), [finalize](../../../java/lang/Object.html#finalize%28%29), [getClass](../../../java/lang/Object.html#getClass%28%29), [notify](../../../java/lang/Object.html#notify%28%29), [notifyAll](../../../java/lang/Object.html#notifyAll%28%29), [toString](../../../java/lang/Object.html#toString%28%29), [wait](../../../java/lang/Object.html#wait%28%29), [wait](../../../java/lang/Object.html#wait%28long%29), [wait](../../../java/lang/Object.html#wait%28long,int%29)`

• • Constructor Detail

     * #### RC5ParameterSpec  
     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` \- the version.  
     `rounds` \- the number of rounds.  
     `wordSize` \- the word size in bits.  
     * #### RC5ParameterSpec  
     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` \- the version.  
     `rounds` \- the number of rounds.  
     `wordSize` \- the word size in bits.  
     `iv` \- the buffer with the IV. The first `2*(wordSize/8)` bytes of the buffer are copied to protect against subsequent modification.  
     Throws:  
     `[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `iv` is`null` or `(iv.length < 2 * (wordSize / 8))`  
     * #### RC5ParameterSpec  
     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` \- the version.  
     `rounds` \- the number of rounds.  
     `wordSize` \- the word size in bits.  
     `iv` \- 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` \- the offset in `iv` where the IV starts.  
     Throws:  
     `[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `iv` is`null` or`(iv.length - offset < 2 * (wordSize / 8))`  

  • Method Detail

    * #### getVersion  
    public int getVersion()  
    Returns the version.  
    Returns:  
    the version.  
    * #### getRounds  
    public int getRounds()  
    Returns the number of rounds.  
    Returns:  
    the number of rounds.  
    * #### getWordSize  
    public int getWordSize()  
    Returns the word size in bits.  
    Returns:  
    the word size in bits.  
    * #### getIV  
    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.  
    * #### equals  
    public boolean equals​([Object](../../../java/lang/Object.html "class in java.lang") 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`.)  
    Overrides:  
    `[equals](../../../java/lang/Object.html#equals%28java.lang.Object%29)` in class `[Object](../../../java/lang/Object.html "class in java.lang")`  
    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.  
    See Also:  
    [Object.hashCode()](../../../java/lang/Object.html#hashCode%28%29), [HashMap](../../../java/util/HashMap.html "class in java.util")  
    * #### hashCode  
    public int hashCode()  
    Calculates a hash code value for the object. Objects that are equal will also have the same hashcode.  
    Overrides:  
    `[hashCode](../../../java/lang/Object.html#hashCode%28%29)` in class `[Object](../../../java/lang/Object.html "class in java.lang")`  
    Returns:  
    a hash code value for this object.  
    See Also:  
    [Object.equals(java.lang.Object)](../../../java/lang/Object.html#equals%28java.lang.Object%29), [System.identityHashCode(java.lang.Object)](../../../java/lang/System.html#identityHashCode%28java.lang.Object%29)

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2025, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.