Class IvParameterSpec

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

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

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

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Modifier and Type	Method	Description
`protected Object`	`clone()`	Creates and returns a copy of this object.
`boolean`	`equals(Object obj)`	Indicates whether some other object is "equal to" this one.
`protected void`	`finalize()`	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
`final Class<?>`	`getClass()`	Returns the runtime class of this `Object`.
`int`	`hashCode()`	Returns a hash code value for this object.
`final void`	`notify()`	Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()`	Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()`	Returns a string representation of the object.
`final void`	`wait()`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
`final void`	`wait(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(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.

Constructor Details

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 - 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 - if iv is null or (iv.length - offset < len); ArrayIndexOutOfBoundsException - if offset or len are negative.

Method Details

getIV

public byte[] getIV()

Returns the initialization vector (IV).

Returns:: the initialization vector (IV). Returns a new array each time this method is called.

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.