IvParameterSpec (Java Platform SE 8 ) (original) (raw)

• java.lang.Object

• • javax.crypto.spec.IvParameterSpec

• All Implemented Interfaces:
  AlgorithmParameterSpec

public class IvParameterSpec
extends Object
implements AlgorithmParameterSpec
This class specifies an initialization vector (IV). Examples which use IVs are ciphers in feedback mode, e.g., DES in CBC mode and RSA ciphers with OAEP encoding operation.
Since:
1.4

• • Constructor Summary

  Constructors

  Constructor	Description
  IvParameterSpec(byte[] iv)	Creates an IvParameterSpec object using the bytes in iv as the IV.
  IvParameterSpec(byte[] iv, int offset, int len)	Creates an IvParameterSpec object using the first len bytes in iv, beginning at offset inclusive, as the IV.

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  byte[]	getIV()	Returns the initialization vector (IV).

     * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
     `[clone](../../../java/lang/Object.html#clone--), [equals](../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../java/lang/Object.html#finalize--), [getClass](../../../java/lang/Object.html#getClass--), [hashCode](../../../java/lang/Object.html#hashCode--), [notify](../../../java/lang/Object.html#notify--), [notifyAll](../../../java/lang/Object.html#notifyAll--), [toString](../../../java/lang/Object.html#toString--), [wait](../../../java/lang/Object.html#wait--), [wait](../../../java/lang/Object.html#wait-long-), [wait](../../../java/lang/Object.html#wait-long-int-)`

• • Constructor Detail

     * #### IvParameterSpec  
     public IvParameterSpec(byte[] iv)  
     Creates an IvParameterSpec object using the bytes in `iv` as the IV.  
     Parameters:  
     `iv` \- the buffer with the IV. The contents of the buffer are copied to protect against subsequent modification.  
     Throws:  
     `[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if `iv` is `null`  
     * #### IvParameterSpec  
     public IvParameterSpec(byte[] iv,  
                            int offset,  
                            int len)  
     Creates an IvParameterSpec object using the first `len` bytes in `iv`, beginning at `offset` inclusive, as the IV.  
      The bytes that constitute the IV are those between`iv[offset]` and `iv[offset+len-1]` inclusive.  
     Parameters:  
     `iv` \- the buffer with the IV. The first `len` bytes of the buffer beginning at `offset` inclusive are copied to protect against subsequent modification.  
     `offset` \- the offset in `iv` where the IV starts.  
     `len` \- the number of IV bytes.  
     Throws:  
     `[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `iv` is `null` or `(iv.length - offset < len)`  
     `[ArrayIndexOutOfBoundsException](../../../java/lang/ArrayIndexOutOfBoundsException.html "class in java.lang")` \- is thrown if `offset` or `len` index bytes outside the `iv`.  

  • Method Detail

    * #### getIV  
    public byte[] getIV()  
    Returns the initialization vector (IV).  
    Returns:  
    the initialization vector (IV). Returns a new array each time this method is called.

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.