to top

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

Since: 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)

Since: API Level 1

Constructs a new instance of AlgorithmParameters with the given arguments.

Parameters

algPramSpi	the concrete implementation.
provider	the security provider.
algorithm	the name of the algorithm.

Public Methods

public final String getAlgorithm ()

Since: API Level 1

Returns the name of the algorithm.

Returns

the name of the algorithm.

public final byte[] getEncoded (String format)

Since: API Level 1

Returns this AlgorithmParameters in the specified encoding format.

Parameters

format	the name of the encoding format.

Returns

the encoded parameters.

Throws

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

public final byte[] getEncoded ()

Since: API Level 1

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

Returns

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)

Since: API Level 1

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

Parameters

algorithm	the name of the algorithm to use.
provider	name of the provider of the `AlgorithmParameters`.

Returns

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)

Since: API Level 1

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

Parameters

algorithm	the name of the algorithm to use.
provider	the provider of the `AlgorithmParameters`.

Returns

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)

Since: API Level 1

Returns a new instance of AlgorithmParameters for the specified algorithm.

Parameters

algorithm	the name of the algorithm to use.

Returns

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)

Since: API Level 1

Returns the AlgorithmParameterSpec for this AlgorithmParameters.

Parameters

paramSpec	the type of the parameter specification in which this parameters should be converted.

Returns

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 ()

Since: API Level 1

Returns the provider associated with this AlgorithmParameters.

Returns

the provider associated with this AlgorithmParameters.

public final void init (AlgorithmParameterSpec paramSpec)

Since: API Level 1

Initializes this AlgorithmParameters with the specified AlgorithmParameterSpec.

Parameters

paramSpec	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)

Since: API Level 1

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

Parameters

params	the encoded parameters.
format	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)

Since: 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	the encoded parameters.

Throws

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

public final String toString ()

Since: API Level 1

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

Returns

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)

Parameters

Public Methods

public final String getAlgorithm ()

Returns

public final byte[] getEncoded (String format)

Parameters

Returns

Throws

public final byte[] getEncoded ()

Returns

Throws

public static AlgorithmParameters getInstance (String algorithm, String provider)

Parameters

Returns

Throws

public static AlgorithmParameters getInstance (String algorithm, Provider provider)

Parameters

Returns

Throws

public static AlgorithmParameters getInstance (String algorithm)

Parameters

Returns

Throws

public final T getParameterSpec (Class<T> paramSpec)

Parameters

Returns

Throws

public final Provider getProvider ()

Returns

public final void init (AlgorithmParameterSpec paramSpec)

Parameters

Throws

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

Parameters

Throws

public final void init (byte[] params)

Parameters

Throws

public final String toString ()

Returns