RFR: 8209038: Clarify the javadoc of Cipher.getParameters() [v5]

[Sean Mullan]

On Mon, 9 May 2022 18:28:04 GMT, Valerie Peng <valeriep at openjdk.org> wrote:

>> Anyone can help review this javadoc update? The main change is the wording for the method javadoc of Cipher.getParameters()/CipherSpi.engineGetParameters(). The original wording is somewhat restrictive and request is to broaden this to accommodate more scenarios such as when null can be returned.
>> The rest are minor things like add {@code } to class name and null, and remove redundant ".". 
>> 
>> Will file CSR after the review is close to being wrapped up.
>> Thanks~
>
> Valerie Peng has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains five additional commits since the last revision:
> 
>  - Merge branch 'master' of https://github.com/openjdk/jdk into JDK-8209038
>  - update to address review feedback and minor javadoc cleanup
>  - Update for getParameters()
>  - Update w/ review feedbacks
>  - 8209038: Clarify the javadoc of Cipher.getParameters()

Marked as reviewed by mullan (Reviewer).

src/java.base/share/classes/javax/crypto/CipherSpi.java line 294:

> 292:      * values used by the underlying cipher implementation. If the required
> 293:      * parameters were not supplied and can be generated by the cipher, the
> 294:      * generated parameters will be returned. Otherwise, {@code null} is

Minor wording nit - change "will be" to "are" to be consistent with other wording which uses the present tense. Same comment applies to `Cipher.getParameters`.

-------------

PR: https://git.openjdk.java.net/jdk/pull/8117