Module java.base
Package javax.crypto.spec

Class RC5ParameterSpec

  • All Implemented Interfaces:
    AlgorithmParameterSpec
    public class RC5ParameterSpec
extends Object
implements AlgorithmParameterSpec
    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.

    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.

    • 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 - 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 - 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 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 in class Object
        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(), HashMap