archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-08-27 14:54:52 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8284851: Update javax.crypto files to use proper javadoc for mentioned classes

Browse source 
Reviewed-by: weijun, valeriep
This commit is contained in:
Mark Powers 2022-07-07 23:20:58 +00:00 • committed by Valerie Peng
parent 8cdead0c94
commit f804f2ce8e
92 changed files with 2142 additions and 2010 deletions
Download patch file Download diff file Expand all files Collapse all files

43
src/java.base/share/classes/java/security/AlgorithmParameterGenerator.java
View file

@ -62,7 +62,7 @@ import sun.security.jca.JCAUtil;
* </ul>
*
* <P>In case the client does not explicitly initialize the
* AlgorithmParameterGenerator (via a call to an {@code init} method),
* {@code AlgorithmParameterGenerator} (via a call to an {@code init} method),
* each provider must supply (and document) a default initialization.
* See the Keysize Restriction sections of the
* {@extLink security_guide_jdk_providers JDK Providers}
@ -71,7 +71,8 @@ import sun.security.jca.JCAUtil;
* However, note that defaults may vary across different providers.
* Additionally, the default value for a provider may change in a future
* version. Therefore, it is recommended to explicitly initialize the
* AlgorithmParameterGenerator instead of relying on provider-specific defaults.
* {@code AlgorithmParameterGenerator} instead of relying on provider-specific
* defaults.
*
* <p> Every implementation of the Java platform is required to support the
* following standard {@code AlgorithmParameterGenerator} algorithms and
@ -108,7 +109,7 @@ public class AlgorithmParameterGenerator {
private final String algorithm;
/**
* Creates an AlgorithmParameterGenerator object.
* Creates an {@code AlgorithmParameterGenerator} object.
*
* @param paramGenSpi the delegate
* @param provider the provider
@ -133,14 +134,14 @@ public class AlgorithmParameterGenerator {
}
/**
* Returns an AlgorithmParameterGenerator object for generating
* Returns an {@code AlgorithmParameterGenerator} object for generating
* a set of parameters to be used with the specified algorithm.
*
* <p> This method traverses the list of registered security Providers,
* starting with the most preferred Provider.
* A new AlgorithmParameterGenerator object encapsulating the
* AlgorithmParameterGeneratorSpi implementation from the first
* Provider that supports the specified algorithm is returned.
* <p> This method traverses the list of registered security providers,
* starting with the most preferred provider.
* A new {@code AlgorithmParameterGenerator} object encapsulating the
* {@code AlgorithmParameterGeneratorSpi} implementation from the first
* provider that supports the specified algorithm is returned.
*
* <p> Note that the list of registered providers may be retrieved via
* the {@link Security#getProviders() Security.getProviders()} method.
@ -187,13 +188,13 @@ public class AlgorithmParameterGenerator {
}
/**
* Returns an AlgorithmParameterGenerator object for generating
* Returns an {@code AlgorithmParameterGenerator} object for generating
* a set of parameters to be used with the specified algorithm.
*
* <p> A new AlgorithmParameterGenerator object encapsulating the
* AlgorithmParameterGeneratorSpi implementation from the specified provider
* is returned. The specified provider must be registered
* in the security provider list.
* <p> A new {@code AlgorithmParameterGenerator} object encapsulating the
* {@code AlgorithmParameterGeneratorSpi} implementation from the
* specified provider is returned. The specified provider must be
* registered in the security provider list.
*
* <p> Note that the list of registered providers may be retrieved via
* the {@link Security#getProviders() Security.getProviders()} method.
@ -205,7 +206,7 @@ public class AlgorithmParameterGenerator {
* Java Security Standard Algorithm Names Specification</a>
* for information about standard algorithm names.
*
* @param provider the string name of the Provider.
* @param provider the string name of the {@code Provider}.
*
* @return the new {@code AlgorithmParameterGenerator} object
*
@ -240,13 +241,13 @@ public class AlgorithmParameterGenerator {
}
/**
* Returns an AlgorithmParameterGenerator object for generating
* Returns an {@code AlgorithmParameterGenerator} object for generating
* a set of parameters to be used with the specified algorithm.
*
* <p> A new AlgorithmParameterGenerator object encapsulating the
* AlgorithmParameterGeneratorSpi implementation from the specified Provider
* object is returned. Note that the specified Provider object
* does not have to be registered in the provider list.
* <p> A new {@code AlgorithmParameterGenerator} object encapsulating the
* {@code AlgorithmParameterGeneratorSpi} implementation from the specified
* provider is returned. Note that the specified provider does not
* have to be registered in the provider list.
*
* @param algorithm the string name of the algorithm this
* parameter generator is associated with.
@ -362,7 +363,7 @@ public class AlgorithmParameterGenerator {
/**
* Generates the parameters.
*
* @return the new AlgorithmParameters object.
* @return the new {@code AlgorithmParameters} object.
*/
public final AlgorithmParameters generateParameters() {
return paramGenSpi.engineGenerateParameters();