AlgorithmParameters

Summary: Protected Ctors | Methods | Inherited Methods | [Expand All]

Added in API level 1

public class

AlgorithmParameters

extends Object

java.lang.Object
↳	java.security.AlgorithmParameters

Class Overview

AlgorithmParameters is an engine class which provides algorithm parameters.

Summary

Protected Constructors
	AlgorithmParameters(AlgorithmParametersSpi algPramSpi, Provider provider, String algorithm) Constructs a new instance of `AlgorithmParameters` with the given arguments.

Public Methods
final String	getAlgorithm() Returns the name of the algorithm.
final byte[]	getEncoded(String format) Returns this `AlgorithmParameters` in the specified encoding format.
final byte[]	getEncoded() Returns this `AlgorithmParameters` in their default encoding format.
static AlgorithmParameters	getInstance(String algorithm, String provider) Returns a new instance of `AlgorithmParameters` from the specified provider for the specified algorithm.
static AlgorithmParameters	getInstance(String algorithm, Provider provider) Returns a new instance of `AlgorithmParameters` from the specified provider for the specified algorithm.
static AlgorithmParameters	getInstance(String algorithm) Returns a new instance of `AlgorithmParameters` for the specified algorithm.
final <T extends AlgorithmParameterSpec> T	getParameterSpec(Class<T> paramSpec) Returns the `AlgorithmParameterSpec` for this `AlgorithmParameters`.
final Provider	getProvider() Returns the provider associated with this `AlgorithmParameters`.
final void	init(AlgorithmParameterSpec paramSpec) Initializes this `AlgorithmParameters` with the specified `AlgorithmParameterSpec`.
final void	init(byte[] params, String format) Initializes this `AlgorithmParameters` with the specified `byte[]` using the specified decoding format.
final void	init(byte[] params) Initializes this `AlgorithmParameters` with the specified `byte[]` using the default decoding format for parameters.
final String	toString() Returns a string containing a concise, human-readable description of this `AlgorithmParameters`.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Protected Constructors

protected AlgorithmParameters (AlgorithmParametersSpi algPramSpi, Provider provider, String algorithm)

Added in API level 1

Constructs a new instance of AlgorithmParameters with the given arguments.

Parameters
`algPramSpi`	`AlgorithmParametersSpi`: the concrete implementation.
`provider`	`Provider`: the security provider.
`algorithm`	`String`: the name of the algorithm.

Public Methods

public final String getAlgorithm ()

Added in API level 1

Returns the name of the algorithm.

Returns
`String`	the name of the algorithm.

public final byte[] getEncoded (String format)

Added in API level 1

Returns this AlgorithmParameters in the specified encoding format.

Parameters
`format`	`String`: the name of the encoding format.

Returns
`byte[]`	the encoded parameters.

Throws
`IOException`	if this `AlgorithmParameters` has already been initialized, or if this parameters could not be encoded.

public final byte[] getEncoded ()

Added in API level 1

Returns this AlgorithmParameters in their default encoding format. The default encoding format is ASN.1.

Returns
`byte[]`	the encoded parameters.

Throws
`IOException`	if this `AlgorithmParameters` has already been initialized, or if this parameters could not be encoded.

public static AlgorithmParameters getInstance (String algorithm, String provider)

Added in API level 1

Returns a new instance of AlgorithmParameters from the specified provider for the specified algorithm.

Parameters
`algorithm`	`String`: the name of the algorithm to use.
`provider`	`String`: name of the provider of the `AlgorithmParameters`.

Returns
`AlgorithmParameters`	a new instance of `AlgorithmParameters` for the specified algorithm.

Throws
`NoSuchAlgorithmException`	if the specified algorithm is not available.
`NoSuchProviderException`	if the specified provider is not available.
`IllegalArgumentException`	if `provider == null \|\| provider.isEmpty()`
`NullPointerException`	if `algorithm` is `null`.

public static AlgorithmParameters getInstance (String algorithm, Provider provider)

Added in API level 1

Returns a new instance of AlgorithmParameters from the specified provider for the specified algorithm. The provider supplied does not have to be registered.

Parameters
`algorithm`	`String`: the name of the algorithm to use.
`provider`	`Provider`: the provider of the `AlgorithmParameters`.

Returns
`AlgorithmParameters`	a new instance of `AlgorithmParameters` for the specified algorithm.

Throws
`NoSuchAlgorithmException`	if the specified algorithm is not available.
`NullPointerException`	if `algorithm` is `null`.
`IllegalArgumentException`	if `provider == null`

public static AlgorithmParameters getInstance (String algorithm)

Added in API level 1

Returns a new instance of AlgorithmParameters for the specified algorithm.

Parameters
`algorithm`	`String`: the name of the algorithm to use.

Returns
`AlgorithmParameters`	a new instance of `AlgorithmParameters` for the specified algorithm.

Throws
`NoSuchAlgorithmException`	if the specified algorithm is not available.
`NullPointerException`	if `algorithm` is `null`.

public final T getParameterSpec (Class<T> paramSpec)

Added in API level 1

Returns the AlgorithmParameterSpec for this AlgorithmParameters.

Parameters
`paramSpec`	`Class`: the type of the parameter specification in which this parameters should be converted.

Returns
`T`	the `AlgorithmParameterSpec` for this `AlgorithmParameters`.

Throws
`InvalidParameterSpecException`	if this `AlgorithmParameters` has already been initialized, or if this parameters could not be converted to the specified class.

public final Provider getProvider ()

Added in API level 1

Returns the provider associated with this AlgorithmParameters.

Returns
`Provider`	the provider associated with this `AlgorithmParameters`.

public final void init (AlgorithmParameterSpec paramSpec)

Added in API level 1

Initializes this AlgorithmParameters with the specified AlgorithmParameterSpec.

Parameters
`paramSpec`	`AlgorithmParameterSpec`: the parameter specification.

Throws
`InvalidParameterSpecException`	if this `AlgorithmParameters` has already been initialized or the given `paramSpec` is not appropriate for initializing this `AlgorithmParameters`.

public final void init (byte[] params, String format)

Added in API level 1

Initializes this AlgorithmParameters with the specified byte[] using the specified decoding format.

Parameters
`params`	`byte`: the encoded parameters.
`format`	`String`: the name of the decoding format.

Throws
`IOException`	if this `AlgorithmParameters` has already been initialized, or the parameter could not be encoded.

public final void init (byte[] params)

Added in API level 1

Initializes this AlgorithmParameters with the specified byte[] using the default decoding format for parameters. The default encoding format is ASN.1.

Parameters
`params`	`byte`: the encoded parameters.

Throws
`IOException`	if this `AlgorithmParameters` has already been initialized, or the parameter could not be encoded.

public final String toString ()

Added in API level 1

Returns a string containing a concise, human-readable description of this AlgorithmParameters.

Returns
`String`	a printable representation for this `AlgorithmParameters`.

Results

Interfaces

Classes

Enums

Exceptions

AlgorithmParameters

Class Overview

Summary

Protected Constructors

protected AlgorithmParameters (AlgorithmParametersSpi algPramSpi, Provider provider, String algorithm)

Public Methods

public final String getAlgorithm ()

public final byte[] getEncoded (String format)

public final byte[] getEncoded ()

public static AlgorithmParameters getInstance (String algorithm, String provider)

public static AlgorithmParameters getInstance (String algorithm, Provider provider)

public static AlgorithmParameters getInstance (String algorithm)

public final T getParameterSpec (Class<T> paramSpec)

public final Provider getProvider ()

public final void init (AlgorithmParameterSpec paramSpec)

public final void init (byte[] params, String format)

public final void init (byte[] params)

public final String toString ()