Skip to content

Commit 8f84445

Browse files
committed
docs: change javadoc expressions
1 parent 003cb5a commit 8f84445

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

key-pair-loader/src/main/java/com/onixbyte/security/KeyLoader.java

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,18 @@ public interface KeyLoader {
5656
PublicKey loadPublicKey(String pemKeyText);
5757

5858
/**
59-
* Get the public key with given modulus and public exponent.
59+
* Loads an RSA public key using the provided modulus and exponent.
60+
* <p>
61+
* This default implementation throws a {@link KeyLoadingException} to signify that this key loader does not support
62+
* loading an RSA public key. Implementing classes are expected to override this method to supply their own
63+
* loading logic.
6064
*
61-
* @param modulus the modulus
62-
* @param exponent the public exponent
63-
* @return generated public key object from the provided key specification
64-
* @see KeyFactory#getInstance(String)
65-
* @see KeyFactory#generatePublic(KeySpec)
65+
* @param modulus the modulus value of the RSA public key, usually represented in hexadecimal or Base64
66+
* string format
67+
* @param exponent the public exponent value of the RSA public key, usually represented in hexadecimal or Base64
68+
* string format
69+
* @return the loaded {@link RSAPublicKey} instance
70+
* @throws KeyLoadingException if loading is not supported or fails
6671
*/
6772
default RSAPublicKey loadPublicKey(String modulus, String exponent) {
6873
throw new KeyLoadingException("This key loader does not support loading an RSA public key.");

0 commit comments

Comments
 (0)