This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-crypto.git
The following commit(s) were added to refs/heads/master by this push:
new a99bf9f6 Javadoc
a99bf9f6 is described below
commit a99bf9f68c63f896e83d53600786c22216339009
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 08:44:02 2026 -0400
Javadoc
---
src/main/java/org/apache/commons/crypto/Crypto.java | 4 ++--
.../org/apache/commons/crypto/NativeCodeLoader.java | 6 +++---
.../org/apache/commons/crypto/OpenSslInfoNative.java | 8 ++++----
src/main/java/org/apache/commons/crypto/OsInfo.java | 10 +++++-----
.../org/apache/commons/crypto/cipher/CryptoCipher.java | 8 ++++----
.../commons/crypto/cipher/CryptoCipherFactory.java | 6 +++---
.../org/apache/commons/crypto/cipher/JceCipher.java | 8 ++++----
.../java/org/apache/commons/crypto/cipher/OpenSsl.java | 8 ++++----
.../apache/commons/crypto/cipher/OpenSslCipher.java | 8 ++++----
.../apache/commons/crypto/cipher/OpenSslNative.java | 4 ++--
.../commons/crypto/jna/LibreSsl20XNativeJna.java | 4 ++--
.../apache/commons/crypto/jna/OpenSsl11XNativeJna.java | 4 ++--
.../apache/commons/crypto/jna/OpenSsl30XNativeJna.java | 4 ++--
.../java/org/apache/commons/crypto/jna/OpenSslJna.java | 2 +-
.../apache/commons/crypto/jna/OpenSslJnaCipher.java | 6 +++---
.../commons/crypto/random/CryptoRandomFactory.java | 6 +++---
.../commons/crypto/stream/CryptoInputStream.java | 18 +++++++++---------
.../commons/crypto/stream/CryptoOutputStream.java | 8 ++++----
.../commons/crypto/stream/CtrCryptoInputStream.java | 14 +++++++-------
.../commons/crypto/stream/CtrCryptoOutputStream.java | 2 +-
.../crypto/stream/PositionedCryptoInputStream.java | 10 +++++-----
.../commons/crypto/stream/input/ChannelInput.java | 8 ++++----
.../org/apache/commons/crypto/stream/input/Input.java | 6 +++---
.../commons/crypto/stream/input/StreamInput.java | 6 +++---
.../commons/crypto/stream/output/StreamOutput.java | 2 +-
.../apache/commons/crypto/utils/ReflectionUtils.java | 4 ++--
.../apache/commons/crypto/utils/Transformation.java | 8 ++++----
.../java/org/apache/commons/crypto/utils/Utils.java | 8 ++++----
.../crypto/examples/CipherByteBufferExample.java | 2 +-
29 files changed, 96 insertions(+), 96 deletions(-)
diff --git a/src/main/java/org/apache/commons/crypto/Crypto.java
b/src/main/java/org/apache/commons/crypto/Crypto.java
index 882dd9c9..2c305699 100644
--- a/src/main/java/org/apache/commons/crypto/Crypto.java
+++ b/src/main/java/org/apache/commons/crypto/Crypto.java
@@ -126,7 +126,7 @@ private static Properties getComponentProperties() {
* by Maven.
* </p>
*
- * @return the version; may be {@code null} if not found
+ * @return The version; may be {@code null} if not found
*/
public static String getComponentName() {
// Note: the component properties file allows the method to work
without needing
@@ -142,7 +142,7 @@ public static String getComponentName() {
* by Maven.
* </p>
*
- * @return the version; may be {@code null} if not found
+ * @return The version; may be {@code null} if not found
*/
public static String getComponentVersion() {
// Note: the component properties file allows the method to work
without needing
diff --git a/src/main/java/org/apache/commons/crypto/NativeCodeLoader.java
b/src/main/java/org/apache/commons/crypto/NativeCodeLoader.java
index 789c4b0f..eb1fbc37 100644
--- a/src/main/java/org/apache/commons/crypto/NativeCodeLoader.java
+++ b/src/main/java/org/apache/commons/crypto/NativeCodeLoader.java
@@ -80,7 +80,7 @@ private static void debug(final String format, final
Object... args) {
* @param libraryFileName the library name.
* @param targetFolder Target folder for the native lib. Use the
value
* of commons-crypto.tempdir or
java.io.tmpdir.
- * @return the library file.
+ * @return The library file.
*/
private static File extractLibraryFile(final String libFolderForCurrentOS,
final String libraryFileName,
final String targetFolder) {
@@ -148,7 +148,7 @@ private static File extractLibraryFile(final String
libFolderForCurrentOS, final
/**
* Finds the native library.
*
- * @return the jar file.
+ * @return The jar file.
*/
private static File findNativeLibrary() {
// Get the properties once
@@ -211,7 +211,7 @@ static Throwable getLoadingError() {
* Checks whether the given path has resource.
*
* @param path the path.
- * @return the boolean.
+ * @return The boolean.
*/
private static boolean hasResource(final String path) {
return NativeCodeLoader.class.getResource(path) != null;
diff --git a/src/main/java/org/apache/commons/crypto/OpenSslInfoNative.java
b/src/main/java/org/apache/commons/crypto/OpenSslInfoNative.java
index cf896fb6..2ed62200 100644
--- a/src/main/java/org/apache/commons/crypto/OpenSslInfoNative.java
+++ b/src/main/java/org/apache/commons/crypto/OpenSslInfoNative.java
@@ -31,7 +31,7 @@ final class OpenSslInfoNative {
/**
* Return the name used to load the dynamic linked library.
*
- * @return the name used to load the library (e.g. crypto.dll)
+ * @return The name used to load the library (e.g. crypto.dll)
*/
public static native String DLLName();
@@ -39,7 +39,7 @@ final class OpenSslInfoNative {
* Return the path to the loaded dynamic linked library.
* [Currently not implemented on Windows]
*
- * @return the path to the library that was loaded; may be {@code null}.
+ * @return The path to the library that was loaded; may be {@code null}.
*/
public static native String DLLPath();
@@ -59,7 +59,7 @@ final class OpenSslInfoNative {
public static native String NativeVersion();
/**
- * @return the value of OPENSSL_VERSION_NUMBER.
+ * @return The value of OPENSSL_VERSION_NUMBER.
*/
public static native long OpenSSL();
@@ -77,7 +77,7 @@ final class OpenSslInfoNative {
public static native String HeaderVersionText();
/**
- * @return the value of OPENSSL_VERSION_NUMBER from the header file used
to compile the code
+ * @return The value of OPENSSL_VERSION_NUMBER from the header file used
to compile the code
*/
public static native long HeaderVersionNumber();
diff --git a/src/main/java/org/apache/commons/crypto/OsInfo.java
b/src/main/java/org/apache/commons/crypto/OsInfo.java
index 2c00c0d2..aa45f222 100644
--- a/src/main/java/org/apache/commons/crypto/OsInfo.java
+++ b/src/main/java/org/apache/commons/crypto/OsInfo.java
@@ -109,7 +109,7 @@ final class OsInfo {
/**
* Gets the architecture name.
*
- * @return the architecture name.
+ * @return The architecture name.
*/
static String getArchName() {
// if running Linux on ARM, need to determine ABI of JVM
@@ -141,7 +141,7 @@ static String getArchName() {
/**
* Gets the native lib folder.
*
- * @return the current OS's native lib folder.
+ * @return The current OS's native lib folder.
*/
static String getNativeLibFolderPathForCurrentOS() {
return getOSName() + RESOURCE_PATH_SEPARATOR + getArchName();
@@ -150,7 +150,7 @@ static String getNativeLibFolderPathForCurrentOS() {
/**
* Gets the OS name.
*
- * @return the OS name.
+ * @return The OS name.
*/
static String getOSName() {
return translateOSNameToFolderName(getOsNameProperty());
@@ -184,7 +184,7 @@ public static void main(final String[] args) {
* Translates the architecture name to folder name.
*
* @param archName the architecture name.
- * @return the folder name.
+ * @return The folder name.
*/
private static String translateArchNameToFolderName(final String archName)
{
return archName.replaceAll("\\W", "");
@@ -194,7 +194,7 @@ private static String translateArchNameToFolderName(final
String archName) {
* Translates the OS name to folder name.
*
* @param osName the OS name.
- * @return the folder name.
+ * @return The folder name.
*/
private static String translateOSNameToFolderName(final String osName) {
if (osName.contains("Windows")) {
diff --git a/src/main/java/org/apache/commons/crypto/cipher/CryptoCipher.java
b/src/main/java/org/apache/commons/crypto/cipher/CryptoCipher.java
index f8765fba..ee7e0ad4 100644
--- a/src/main/java/org/apache/commons/crypto/cipher/CryptoCipher.java
+++ b/src/main/java/org/apache/commons/crypto/cipher/CryptoCipher.java
@@ -46,7 +46,7 @@ public interface CryptoCipher extends Closeable {
* @param inputLen the input length
* @param output the byte array for the result
* @param outputOffset the offset in output where the result is stored
- * @return the number of bytes stored in output
+ * @return The number of bytes stored in output
* @throws ShortBufferException if the given output byte array is too small
* to hold the result
* @throws BadPaddingException if this cipher is in decryption mode, and
@@ -93,14 +93,14 @@ int doFinal(ByteBuffer inBuffer, ByteBuffer outBuffer)
* {@code CryptoCipher} object.
* </p>
*
- * @return the algorithm name of this {@code CryptoCipher} object.
+ * @return The algorithm name of this {@code CryptoCipher} object.
*/
String getAlgorithm();
/**
* Returns the block size (in bytes).
*
- * @return the block size (in bytes), or 0 if the underlying algorithm is
+ * @return The block size (in bytes), or 0 if the underlying algorithm is
* not a block cipher
*/
int getBlockSize();
@@ -135,7 +135,7 @@ void init(int mode, Key key, AlgorithmParameterSpec params)
* @param inputLen the input length
* @param output the byte array for the result
* @param outputOffset the offset in output where the result is stored
- * @return the number of bytes stored in output
+ * @return The number of bytes stored in output
* @throws ShortBufferException if there is insufficient space in the
output
* byte array
*/
diff --git
a/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
b/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
index 8919c5b0..f8f56c36 100644
--- a/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
+++ b/src/main/java/org/apache/commons/crypto/cipher/CryptoCipherFactory.java
@@ -89,7 +89,7 @@ public enum CipherProvider {
/**
* Gets the class name of the provider.
*
- * @return the fully qualified name of the provider class
+ * @return The fully qualified name of the provider class
*/
public String getClassName() {
return className;
@@ -98,7 +98,7 @@ public String getClassName() {
/**
* Gets the implementation class of the provider.
*
- * @return the implementation class of the provider
+ * @return The implementation class of the provider
*/
public Class<? extends CryptoCipher> getImplClass() {
return klass;
@@ -148,7 +148,7 @@ public Class<? extends CryptoCipher> getImplClass() {
*
* @param props The {@code Properties} class represents a set of
* properties.
- * @return the cipher class based on the property {@link
CryptoCipherFactory.CLASSES_KEY}
+ * @return The cipher class based on the property {@link
CryptoCipherFactory.CLASSES_KEY}
* If the property is missing or empty, {@link CLASSES_DEFAULT} is returned
*/
private static String getCipherClassString(final Properties props) {
diff --git a/src/main/java/org/apache/commons/crypto/cipher/JceCipher.java
b/src/main/java/org/apache/commons/crypto/cipher/JceCipher.java
index 6482b7eb..ecb1e5b5 100644
--- a/src/main/java/org/apache/commons/crypto/cipher/JceCipher.java
+++ b/src/main/java/org/apache/commons/crypto/cipher/JceCipher.java
@@ -71,7 +71,7 @@ public void close() {
* @param inputLen the input length
* @param output the byte array for the result
* @param outputOffset the offset in output where the result is stored
- * @return the number of bytes stored in output
+ * @return The number of bytes stored in output
* @throws ShortBufferException if the given output byte array is too small
* to hold the result
* @throws BadPaddingException if this cipher is in decryption mode, and
@@ -126,7 +126,7 @@ public int doFinal(final ByteBuffer inBuffer, final
ByteBuffer outBuffer)
* {@code CryptoCipher} object.
* </p>
*
- * @return the algorithm name of this {@code CryptoCipher} object.
+ * @return The algorithm name of this {@code CryptoCipher} object.
*/
@Override
public String getAlgorithm() {
@@ -136,7 +136,7 @@ public String getAlgorithm() {
/**
* Returns the block size (in bytes).
*
- * @return the block size (in bytes), or 0 if the underlying algorithm is
+ * @return The block size (in bytes), or 0 if the underlying algorithm is
* not a block cipher
*/
@Override
@@ -176,7 +176,7 @@ public void init(final int mode, final Key key, final
AlgorithmParameterSpec par
* @param inputLen the input length
* @param output the byte array for the result
* @param outputOffset the offset in output where the result is stored
- * @return the number of bytes stored in output
+ * @return The number of bytes stored in output
* @throws ShortBufferException if there is insufficient space in the
output
* byte array
*/
diff --git a/src/main/java/org/apache/commons/crypto/cipher/OpenSsl.java
b/src/main/java/org/apache/commons/crypto/cipher/OpenSsl.java
index 3cfef9f3..c936c8e7 100644
--- a/src/main/java/org/apache/commons/crypto/cipher/OpenSsl.java
+++ b/src/main/java/org/apache/commons/crypto/cipher/OpenSsl.java
@@ -46,7 +46,7 @@ private enum AlgorithmMode {
*
* @param algorithm the algorithm.
* @param mode the mode.
- * @return the Algorithm mode.
+ * @return The Algorithm mode.
* @throws NoSuchAlgorithmException if the algorithm is not available.
*/
static int get(final String algorithm, final String mode) throws
NoSuchAlgorithmException {
@@ -108,7 +108,7 @@ public static OpenSsl getInstance(final String
transformation)
/**
* Gets the failure reason when loading OpenSsl native.
*
- * @return the failure reason; {@code null} if it was loaded and
initialized successfully
+ * @return The failure reason; {@code null} if it was loaded and
initialized successfully
*/
public static Throwable getLoadingFailureReason() {
return loadingFailureReason;
@@ -147,7 +147,7 @@ public void clean() {
* @param inputLen the input length
* @param output the byte array for the result
* @param outputOffset the offset in output where the result is stored
- * @return the number of bytes stored in output
+ * @return The number of bytes stored in output
* @throws ShortBufferException if the given output byte array is too small
* to hold the result
* @throws BadPaddingException if this cipher is in decryption mode, and
@@ -234,7 +234,7 @@ public void init(final int mode, final byte[] key, final
AlgorithmParameterSpec
* @param inputLen the input length
* @param output the byte array for the result
* @param outputOffset the offset in output where the result is stored
- * @return the number of bytes stored in output
+ * @return The number of bytes stored in output
* @throws ShortBufferException if there is insufficient space in the
output
* byte array
*/
diff --git a/src/main/java/org/apache/commons/crypto/cipher/OpenSslCipher.java
b/src/main/java/org/apache/commons/crypto/cipher/OpenSslCipher.java
index bb521cc4..11ce5a26 100644
--- a/src/main/java/org/apache/commons/crypto/cipher/OpenSslCipher.java
+++ b/src/main/java/org/apache/commons/crypto/cipher/OpenSslCipher.java
@@ -81,7 +81,7 @@ public void close() {
* @param inputLen the input length
* @param output the byte array for the result
* @param outputOffset the offset in output where the result is stored
- * @return the number of bytes stored in output
+ * @return The number of bytes stored in output
* @throws ShortBufferException if the given output byte array is too small
* to hold the result
* @throws BadPaddingException if this openSslEngine is in decryption
mode, and
@@ -135,7 +135,7 @@ public int doFinal(final ByteBuffer inBuffer, final
ByteBuffer outBuffer)
* {@code CryptoCipher} object.
* </p>
*
- * @return the algorithm name of this {@code CryptoCipher} object.
+ * @return The algorithm name of this {@code CryptoCipher} object.
*/
@Override
public String getAlgorithm() {
@@ -145,7 +145,7 @@ public String getAlgorithm() {
/**
* Returns the block size (in bytes).
*
- * @return the block size (in bytes), or 0 if the underlying algorithm is
+ * @return The block size (in bytes), or 0 if the underlying algorithm is
* not a block openSslEngine
*/
@Override
@@ -182,7 +182,7 @@ public void init(final int mode, final Key key, final
AlgorithmParameterSpec par
* @param inputLen the input length
* @param output the byte array for the result
* @param outputOffset the offset in output where the result is stored
- * @return the number of bytes stored in output
+ * @return The number of bytes stored in output
* @throws ShortBufferException if there is insufficient space in the
output
* byte array
*/
diff --git a/src/main/java/org/apache/commons/crypto/cipher/OpenSslNative.java
b/src/main/java/org/apache/commons/crypto/cipher/OpenSslNative.java
index d3c70c9a..55d247fe 100644
--- a/src/main/java/org/apache/commons/crypto/cipher/OpenSslNative.java
+++ b/src/main/java/org/apache/commons/crypto/cipher/OpenSslNative.java
@@ -83,7 +83,7 @@ public static native int doFinalByteArray(long context,
byte[] output,
* @param padding the padding mode of OpenSsl cipher
* @param key crypto key
* @param iv crypto iv
- * @return the context address of cipher
+ * @return The context address of cipher
*/
public static native long init(long context, int mode, int alg,
int padding, byte[] key, byte[] iv);
@@ -93,7 +93,7 @@ public static native long init(long context, int mode, int
alg,
*
* @param algorithm The algorithm name of cipher
* @param padding The padding name of cipher
- * @return the context address of cipher
+ * @return The context address of cipher
*/
public static native long initContext(int algorithm, int padding);
diff --git
a/src/main/java/org/apache/commons/crypto/jna/LibreSsl20XNativeJna.java
b/src/main/java/org/apache/commons/crypto/jna/LibreSsl20XNativeJna.java
index aa17f7a2..585b3a2e 100644
--- a/src/main/java/org/apache/commons/crypto/jna/LibreSsl20XNativeJna.java
+++ b/src/main/java/org/apache/commons/crypto/jna/LibreSsl20XNativeJna.java
@@ -114,7 +114,7 @@ final class LibreSsl20XNativeJna implements
OpenSslInterfaceNativeJna {
* the error code
* @param null_
* buf is NULL, the error string is placed in a static buffer
- * @return the human-readable error messages.
+ * @return The human-readable error messages.
*/
public static native String ERR_error_string(NativeLong err, char[] null_);
@@ -125,7 +125,7 @@ final class LibreSsl20XNativeJna implements
OpenSslInterfaceNativeJna {
public static native void ERR_load_crypto_strings();
/**
- * @return the earliest error code from the thread's error queue without
modifying it.
+ * @return The earliest error code from the thread's error queue without
modifying it.
*/
public static native NativeLong ERR_peek_error();
diff --git
a/src/main/java/org/apache/commons/crypto/jna/OpenSsl11XNativeJna.java
b/src/main/java/org/apache/commons/crypto/jna/OpenSsl11XNativeJna.java
index 97cf2d7c..3c72c7f0 100644
--- a/src/main/java/org/apache/commons/crypto/jna/OpenSsl11XNativeJna.java
+++ b/src/main/java/org/apache/commons/crypto/jna/OpenSsl11XNativeJna.java
@@ -106,12 +106,12 @@ final class OpenSsl11XNativeJna implements
OpenSslInterfaceNativeJna {
* the error code
* @param null_
* buf is NULL, the error string is placed in a static buffer
- * @return the human-readable error messages.
+ * @return The human-readable error messages.
*/
public static native String ERR_error_string(NativeLong err, char[] null_);
/**
- * @return the earliest error code from the thread's error queue without
modifying it.
+ * @return The earliest error code from the thread's error queue without
modifying it.
*/
public static native NativeLong ERR_peek_error();
diff --git
a/src/main/java/org/apache/commons/crypto/jna/OpenSsl30XNativeJna.java
b/src/main/java/org/apache/commons/crypto/jna/OpenSsl30XNativeJna.java
index d623739d..4cb28534 100644
--- a/src/main/java/org/apache/commons/crypto/jna/OpenSsl30XNativeJna.java
+++ b/src/main/java/org/apache/commons/crypto/jna/OpenSsl30XNativeJna.java
@@ -108,12 +108,12 @@ final class OpenSsl30XNativeJna implements
OpenSslInterfaceNativeJna {
* the error code
* @param null_
* buf is NULL, the error string is placed in a static buffer
- * @return the human-readable error messages.
+ * @return The human-readable error messages.
*/
public static native String ERR_error_string(NativeLong err, char[] null_);
/**
- * @return the earliest error code from the thread's error queue without
modifying it.
+ * @return The earliest error code from the thread's error queue without
modifying it.
*/
public static native NativeLong ERR_peek_error();
diff --git a/src/main/java/org/apache/commons/crypto/jna/OpenSslJna.java
b/src/main/java/org/apache/commons/crypto/jna/OpenSslJna.java
index daca5867..dd05993f 100644
--- a/src/main/java/org/apache/commons/crypto/jna/OpenSslJna.java
+++ b/src/main/java/org/apache/commons/crypto/jna/OpenSslJna.java
@@ -72,7 +72,7 @@ private static void info(final String format, final Object...
args) {
/**
* Gets the error from the JNA.
*
- * @return the error from the JNA.
+ * @return The error from the JNA.
*/
public static Throwable initialisationError() {
return OpenSslNativeJna.INIT_ERROR;
diff --git a/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCipher.java
b/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCipher.java
index ee17847e..2f50b260 100644
--- a/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCipher.java
+++ b/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCipher.java
@@ -61,7 +61,7 @@ private enum AlgorithmMode {
*
* @param algorithm the algorithm name
* @param mode the mode name
- * @return the AlgorithmMode instance
+ * @return The AlgorithmMode instance
* @throws NoSuchAlgorithmException if the algorithm is not support
*/
static AlgorithmMode get(final String algorithm, final String mode)
throws NoSuchAlgorithmException {
@@ -126,7 +126,7 @@ public void close() {
* @param inputLen the input length
* @param output the byte array for the result
* @param outputOffset the offset in output where the result is stored
- * @return the number of bytes stored in output
+ * @return The number of bytes stored in output
* @throws ShortBufferException if the given output byte array is too
small
* to hold the result
* @throws BadPaddingException if this cipher is in decryption mode,
and
@@ -285,7 +285,7 @@ private void throwOnError(final int retVal) {
* @param inputLen the input length
* @param output the byte array for the result
* @param outputOffset the offset in output where the result is stored
- * @return the number of bytes stored in output
+ * @return The number of bytes stored in output
* @throws ShortBufferException if there is insufficient space in the
output
* byte array
*/
diff --git
a/src/main/java/org/apache/commons/crypto/random/CryptoRandomFactory.java
b/src/main/java/org/apache/commons/crypto/random/CryptoRandomFactory.java
index 22e62e5e..f7cd384a 100644
--- a/src/main/java/org/apache/commons/crypto/random/CryptoRandomFactory.java
+++ b/src/main/java/org/apache/commons/crypto/random/CryptoRandomFactory.java
@@ -99,7 +99,7 @@ public enum RandomProvider {
/**
* Gets the class name of the provider.
*
- * @return the name of the provider class
+ * @return The name of the provider class
*/
public String getClassName() {
return className;
@@ -108,7 +108,7 @@ public String getClassName() {
/**
* Gets the implementation class of the provider.
*
- * @return the implementation class of the provider
+ * @return The implementation class of the provider
*/
public Class<? extends CryptoRandom> getImplClass() {
return klass;
@@ -222,7 +222,7 @@ public static CryptoRandom getCryptoRandom(final Properties
props)
*
* @param props The {@code Properties} class represents a set of
* properties.
- * @return the CryptoRandom class based on the props.
+ * @return The CryptoRandom class based on the props.
*/
private static String getRandomClassString(final Properties props) {
String randomClassString = props.getProperty(CLASSES_KEY,
CLASSES_DEFAULT);
diff --git
a/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
b/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
index 10d4df0b..1d87b8ca 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
@@ -75,7 +75,7 @@ public class CryptoInputStream extends InputStream implements
ReadableByteChanne
*
* @param cipher the {@link CryptoCipher} instance.
* @param bufferSize the buffer size.
- * @return the remaining buffer size.
+ * @return The remaining buffer size.
*/
static int checkBufferSize(final CryptoCipher cipher, final int
bufferSize) {
Utils.checkArgument(bufferSize >= MIN_BUFFER_SIZE,
@@ -100,7 +100,7 @@ static void checkStreamCipher(final CryptoCipher cipher)
throws IOException {
*
* @param props The {@code Properties} class represents a set of
* properties.
- * @return the buffer size.
+ * @return The buffer size.
* */
static int getBufferSize(final Properties props) {
final String bufferSizeStr = props.getProperty(STREAM_BUFFER_SIZE_KEY,
"");
@@ -390,7 +390,7 @@ protected void freeBuffers() {
/**
* Gets the buffer size.
*
- * @return the bufferSize.
+ * @return The bufferSize.
*/
protected int getBufferSize() {
return bufferSize;
@@ -399,7 +399,7 @@ protected int getBufferSize() {
/**
* Gets the internal CryptoCipher.
*
- * @return the cipher instance.
+ * @return The cipher instance.
*/
protected CryptoCipher getCipher() {
return cipher;
@@ -408,7 +408,7 @@ protected CryptoCipher getCipher() {
/**
* Gets the input.
*
- * @return the input.
+ * @return The input.
*/
protected Input getInput() {
return input;
@@ -417,7 +417,7 @@ protected Input getInput() {
/**
* Gets the key.
*
- * @return the key.
+ * @return The key.
*/
protected Key getKey() {
return key;
@@ -426,7 +426,7 @@ protected Key getKey() {
/**
* Gets the specification of cryptographic parameters.
*
- * @return the params.
+ * @return The params.
*/
protected AlgorithmParameterSpec getParams() {
return params;
@@ -470,7 +470,7 @@ public boolean markSupported() {
* Overrides the {@link InputStream#read()}. Reads the next byte of
* data from the input stream.
*
- * @return the next byte of data, or {@code EOS (-1)} if the end of the
+ * @return The next byte of data, or {@code EOS (-1)} if the end of the
* stream is reached.
* @throws IOException if an I/O error occurs.
*/
@@ -575,7 +575,7 @@ public int read(final ByteBuffer dst) throws IOException {
* discards {@code n} bytes of data from this input stream.
*
* @param n the number of bytes to be skipped.
- * @return the actual number of bytes skipped.
+ * @return The actual number of bytes skipped.
* @throws IOException if an I/O error occurs.
*/
@Override
diff --git
a/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
b/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
index 72870167..828a4018 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
@@ -304,7 +304,7 @@ protected void freeBuffers() {
/**
* Gets the buffer size.
*
- * @return the buffer size.
+ * @return The buffer size.
*/
protected int getBufferSize() {
return bufferSize;
@@ -313,7 +313,7 @@ protected int getBufferSize() {
/**
* Gets the internal Cipher.
*
- * @return the cipher instance.
+ * @return The cipher instance.
*/
protected CryptoCipher getCipher() {
return cipher;
@@ -322,7 +322,7 @@ protected CryptoCipher getCipher() {
/**
* Gets the inBuffer.
*
- * @return the inBuffer.
+ * @return The inBuffer.
*/
protected ByteBuffer getInBuffer() {
return inBuffer;
@@ -331,7 +331,7 @@ protected ByteBuffer getInBuffer() {
/**
* Gets the outBuffer.
*
- * @return the outBuffer.
+ * @return The outBuffer.
*/
protected ByteBuffer getOutBuffer() {
return outBuffer;
diff --git
a/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
b/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
index d7a45ff2..60378f03 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
@@ -431,7 +431,7 @@ protected int decryptMore() throws IOException {
* Gets the counter for input stream position.
*
* @param position the given position in the data.
- * @return the counter for input stream position.
+ * @return The counter for input stream position.
*/
protected long getCounter(final long position) {
return position / cipher.getBlockSize();
@@ -440,7 +440,7 @@ protected long getCounter(final long position) {
/**
* Gets the initialization vector.
*
- * @return the initIV.
+ * @return The initIV.
*/
protected byte[] getInitIV() {
return initIV;
@@ -450,7 +450,7 @@ protected byte[] getInitIV() {
* Gets the padding for input stream position.
*
* @param position the given position in the data.
- * @return the padding for input stream position.
+ * @return The padding for input stream position.
*/
protected byte getPadding(final long position) {
return (byte) (position % cipher.getBlockSize());
@@ -459,7 +459,7 @@ protected byte getPadding(final long position) {
/**
* Gets the offset of the stream.
*
- * @return the stream offset.
+ * @return The stream offset.
*/
protected long getStreamOffset() {
return streamOffset;
@@ -468,7 +468,7 @@ protected long getStreamOffset() {
/**
* Gets the position of the stream.
*
- * @return the position of the stream.
+ * @return The position of the stream.
*/
protected long getStreamPosition() {
return streamOffset - outBuffer.remaining();
@@ -489,7 +489,7 @@ protected void initCipher() {
* cipher should be updated and recalculate padding if needed.
*
* @param position the given position in the data.
- * @return the byte.
+ * @return The byte.
* @throws IOException if an I/O error occurs.
*/
protected byte postDecryption(final long position) throws IOException {
@@ -627,7 +627,7 @@ protected void setStreamOffset(final long streamOffset) {
* discards {@code n} bytes of data from this input stream.
*
* @param n the number of bytes to be skipped.
- * @return the actual number of bytes skipped.
+ * @return The actual number of bytes skipped.
* @throws IOException if an I/O error occurs.
*/
@Override
diff --git
a/src/main/java/org/apache/commons/crypto/stream/CtrCryptoOutputStream.java
b/src/main/java/org/apache/commons/crypto/stream/CtrCryptoOutputStream.java
index 6f0270ac..8de39472 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CtrCryptoOutputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CtrCryptoOutputStream.java
@@ -337,7 +337,7 @@ protected void encryptFinal() throws IOException {
/**
* Gets the underlying stream offset
*
- * @return the underlying stream offset
+ * @return The underlying stream offset
*/
protected long getStreamOffset() {
return streamOffset;
diff --git
a/src/main/java/org/apache/commons/crypto/stream/PositionedCryptoInputStream.java
b/src/main/java/org/apache/commons/crypto/stream/PositionedCryptoInputStream.java
index 8f5f6acb..0aa96aed 100644
---
a/src/main/java/org/apache/commons/crypto/stream/PositionedCryptoInputStream.java
+++
b/src/main/java/org/apache/commons/crypto/stream/PositionedCryptoInputStream.java
@@ -59,7 +59,7 @@ public CipherState(final CryptoCipher cryptoCipher) {
/**
* Gets the CryptoCipher instance.
*
- * @return the cipher.
+ * @return The cipher.
*/
public CryptoCipher getCryptoCipher() {
return cryptoCipher;
@@ -68,7 +68,7 @@ public CryptoCipher getCryptoCipher() {
/**
* Gets the reset.
*
- * @return the value of reset.
+ * @return The value of reset.
*/
public boolean isReset() {
return reset;
@@ -272,7 +272,7 @@ private void decryptBuffer(final CipherState state, final
ByteBuffer inByteBuffe
/**
* Gets direct buffer from pool. Caller MUST also call {@link
#returnToPool(ByteBuffer)}.
*
- * @return the buffer.
+ * @return The buffer.
* @see #returnToPool(ByteBuffer)
*/
private ByteBuffer getBuffer() {
@@ -283,7 +283,7 @@ private ByteBuffer getBuffer() {
/**
* Gets CryptoCipher from pool. Caller MUST also call {@link
#returnToPool(CipherState)}.
*
- * @return the CipherState instance.
+ * @return The CipherState instance.
* @throws IOException if an I/O error occurs.
*/
@SuppressWarnings("resource") // Caller calls #returnToPool(CipherState)
@@ -300,7 +300,7 @@ private CipherState getCipherState() throws IOException {
* @param inByteBuffer the input buffer.
* @param position the offset from the start of the stream.
* @param iv the iv.
- * @return the padding.
+ * @return The padding.
*/
private byte postDecryption(final CipherState state, final ByteBuffer
inByteBuffer,
final long position, final byte[] iv) {
diff --git
a/src/main/java/org/apache/commons/crypto/stream/input/ChannelInput.java
b/src/main/java/org/apache/commons/crypto/stream/input/ChannelInput.java
index 1327a391..3c4a10ee 100644
--- a/src/main/java/org/apache/commons/crypto/stream/input/ChannelInput.java
+++ b/src/main/java/org/apache/commons/crypto/stream/input/ChannelInput.java
@@ -80,7 +80,7 @@ public void close() throws IOException {
/**
* Gets the skip buffer.
*
- * @return the buffer.
+ * @return The buffer.
*/
private ByteBuffer getSkipBuf() {
if (buf == null) {
@@ -95,7 +95,7 @@ private ByteBuffer getSkipBuf() {
* Reads a sequence of bytes from input into the given buffer.
*
* @param dst The buffer into which bytes are to be transferred.
- * @return the total number of bytes read into the buffer, or
+ * @return The total number of bytes read into the buffer, or
* {@code -1} if there is no more data because the end of the
* stream has been reached.
* @throws IOException if an I/O error occurs.
@@ -117,7 +117,7 @@ public int read(final ByteBuffer dst) throws IOException {
* @param buffer the buffer into which the data is read.
* @param offset the start offset in array buffer.
* @param length the maximum number of bytes to read.
- * @return the total number of bytes read into the buffer, or
+ * @return The total number of bytes read into the buffer, or
* {@code -1} if there is no more data because the end of the
* stream has been reached.
* @throws IOException if an I/O error occurs.
@@ -150,7 +150,7 @@ public void seek(final long position) throws IOException {
* over and discards {@code n} bytes of data from this input stream.
*
* @param n the number of bytes to be skipped.
- * @return the actual number of bytes skipped.
+ * @return The actual number of bytes skipped.
* @throws IOException if an I/O error occurs.
*/
@Override
diff --git a/src/main/java/org/apache/commons/crypto/stream/input/Input.java
b/src/main/java/org/apache/commons/crypto/stream/input/Input.java
index 4a500c1f..f81338aa 100644
--- a/src/main/java/org/apache/commons/crypto/stream/input/Input.java
+++ b/src/main/java/org/apache/commons/crypto/stream/input/Input.java
@@ -80,7 +80,7 @@ public interface Input extends Closeable {
* <em>p</em> {@code +} <em>n</em>; its limit will not have
changed.
*
* @param dst The buffer into which bytes are to be transferred.
- * @return the total number of bytes read into the buffer, or
+ * @return The total number of bytes read into the buffer, or
* {@code -1} if there is no more data because the end of the
* stream has been reached.
* @throws IOException If some other I/O error occurs.
@@ -99,7 +99,7 @@ public interface Input extends Closeable {
* @param buffer the buffer into which the data is read.
* @param offset the start offset in array buffer.
* @param length the maximum number of bytes to read.
- * @return the total number of bytes read into the buffer, or
+ * @return The total number of bytes read into the buffer, or
* {@code -1} if there is no more data because the end of the
* stream has been reached.
* @throws IOException if an I/O error occurs.
@@ -136,7 +136,7 @@ int read(long position, byte[] buffer, int offset, int
length)
* implementation may depend on the ability to seek.
*
* @param n the number of bytes to be skipped.
- * @return the actual number of bytes skipped.
+ * @return The actual number of bytes skipped.
* @throws IOException if the stream does not support seek, or if some
* other I/O error occurs.
*/
diff --git
a/src/main/java/org/apache/commons/crypto/stream/input/StreamInput.java
b/src/main/java/org/apache/commons/crypto/stream/input/StreamInput.java
index 4f1a2f0c..09ad3c6d 100644
--- a/src/main/java/org/apache/commons/crypto/stream/input/StreamInput.java
+++ b/src/main/java/org/apache/commons/crypto/stream/input/StreamInput.java
@@ -86,7 +86,7 @@ public void close() throws IOException {
* Reads a sequence of bytes from input into the given buffer.
*
* @param dst The buffer into which bytes are to be transferred.
- * @return the total number of bytes read into the buffer, or
+ * @return The total number of bytes read into the buffer, or
* {@code EOS (-1)} if there is no more data because the end of the
* stream has been reached.
* @throws IOException if an I/O error occurs.
@@ -124,7 +124,7 @@ public int read(final ByteBuffer dst) throws IOException {
* @param buffer the buffer into which the data is read.
* @param offset the start offset in array buffer.
* @param length the maximum number of bytes to read.
- * @return the total number of bytes read into the buffer, or
+ * @return The total number of bytes read into the buffer, or
* {@code EOS (-1)} if there is no more data because the end of the
* stream has been reached.
* @throws IOException if an I/O error occurs.
@@ -154,7 +154,7 @@ public void seek(final long position) throws IOException {
* over and discards {@code n} bytes of data from this input stream.
*
* @param n the number of bytes to be skipped.
- * @return the actual number of bytes skipped.
+ * @return The actual number of bytes skipped.
* @throws IOException if an I/O error occurs.
*/
@Override
diff --git
a/src/main/java/org/apache/commons/crypto/stream/output/StreamOutput.java
b/src/main/java/org/apache/commons/crypto/stream/output/StreamOutput.java
index 8ee4013b..f7c47388 100644
--- a/src/main/java/org/apache/commons/crypto/stream/output/StreamOutput.java
+++ b/src/main/java/org/apache/commons/crypto/stream/output/StreamOutput.java
@@ -73,7 +73,7 @@ public void flush() throws IOException {
/**
* Gets the output stream.
*
- * @return the output stream.
+ * @return The output stream.
*/
protected OutputStream getOut() {
return out;
diff --git a/src/main/java/org/apache/commons/crypto/utils/ReflectionUtils.java
b/src/main/java/org/apache/commons/crypto/utils/ReflectionUtils.java
index e87363bc..3d5f1d27 100644
--- a/src/main/java/org/apache/commons/crypto/utils/ReflectionUtils.java
+++ b/src/main/java/org/apache/commons/crypto/utils/ReflectionUtils.java
@@ -62,7 +62,7 @@ private abstract static class AbstractNegativeCacheSentinel {
* Loads a class by name.
*
* @param name the class name.
- * @return the class object.
+ * @return The class object.
* @throws ClassNotFoundException if the class is not found.
*/
public static Class<?> getClassByName(final String name) throws
ClassNotFoundException {
@@ -81,7 +81,7 @@ public static Class<?> getClassByName(final String name)
throws ClassNotFoundExc
* couldn't be loaded. This is to avoid the overhead of creating an
exception.
*
* @param name the class name.
- * @return the class object, or {@code null} if it could not be found or
initialization failed.
+ * @return The class object, or {@code null} if it could not be found or
initialization failed.
*/
private static Class<?> getClassByNameOrNull(final String name) {
final Set<String> set =
INIT_ERROR_CLASSES.computeIfAbsent(CLASS_LOADER, k ->
Collections.synchronizedSet(new HashSet<>()));
diff --git a/src/main/java/org/apache/commons/crypto/utils/Transformation.java
b/src/main/java/org/apache/commons/crypto/utils/Transformation.java
index d1253581..2e3f3862 100644
--- a/src/main/java/org/apache/commons/crypto/utils/Transformation.java
+++ b/src/main/java/org/apache/commons/crypto/utils/Transformation.java
@@ -36,7 +36,7 @@ public class Transformation {
* Parses a transformation.
*
* @param transformation current transformation
- * @return the Transformation
+ * @return The Transformation
* @throws NoSuchAlgorithmException if the algorithm is not supported
* @throws NoSuchPaddingException Thrown when the padding is unsupported.
*/
@@ -89,7 +89,7 @@ private Transformation(final String algorithm, final String
mode, final String p
/**
* Gets the algorithm.
*
- * @return the algorithm.
+ * @return The algorithm.
*/
public String getAlgorithm() {
return algorithm;
@@ -98,7 +98,7 @@ public String getAlgorithm() {
/**
* Gets the mode.
*
- * @return the mode.
+ * @return The mode.
*/
public String getMode() {
return mode;
@@ -107,7 +107,7 @@ public String getMode() {
/**
* Gets the padding.
*
- * @return the padding.
+ * @return The padding.
*/
public Padding getPadding() {
return padding;
diff --git a/src/main/java/org/apache/commons/crypto/utils/Utils.java
b/src/main/java/org/apache/commons/crypto/utils/Utils.java
index f448bcfa..8458734a 100644
--- a/src/main/java/org/apache/commons/crypto/utils/Utils.java
+++ b/src/main/java/org/apache/commons/crypto/utils/Utils.java
@@ -50,7 +50,7 @@ private static final class DefaultPropertiesHolder {
* Loads system properties when configuration file of the name
* {@link #SYSTEM_PROPERTIES_FILE} is found.
*
- * @return the default properties
+ * @return The default properties
*/
private static Properties createDefaultProperties() {
// default to system
@@ -118,7 +118,7 @@ public static void checkArgument(final boolean expression,
final Object errorMes
*
* @param <T> The type of the object reference to be checked.
* @param reference an object reference.
- * @return the non-null reference that was validated.
+ * @return The non-null reference that was validated.
* @throws NullPointerException if reference is {@code null}.
* @deprecated Use {@link Objects#requireNonNull(Object)}.
*/
@@ -162,7 +162,7 @@ public static void checkState(final boolean expression,
final String message) {
* <em>AES/CBC/PKCS5Padding</em>.
* See the Java Cryptography Architecture Standard Algorithm Name
Documentation
* for information about standard transformation names.
- * @return the CryptoCipher instance.
+ * @return The CryptoCipher instance.
* @throws IOException if an I/O error occurs.
*/
public static CryptoCipher getCipherInstance(final String transformation,
final Properties properties) throws IOException {
@@ -201,7 +201,7 @@ public static Properties getProperties(final Properties
newProp) {
* If Crypto.JNI_LIBRARY_NAME is defined, this overrides the default name.
*
* @param name the default name, passed from native code
- * @return the updated library path
+ * @return The updated library path
* This method is designed for use from the DynamicLoader native code.
* Although it could all be implemented in native code, this hook method
* makes maintenance easier.
diff --git
a/src/test/java/org/apache/commons/crypto/examples/CipherByteBufferExample.java
b/src/test/java/org/apache/commons/crypto/examples/CipherByteBufferExample.java
index 0b54e43f..4c7239f2 100644
---
a/src/test/java/org/apache/commons/crypto/examples/CipherByteBufferExample.java
+++
b/src/test/java/org/apache/commons/crypto/examples/CipherByteBufferExample.java
@@ -39,7 +39,7 @@ public class CipherByteBufferExample {
* Converts ByteBuffer to String
*
* @param buffer input byte buffer
- * @return the converted string
+ * @return The converted string
*/
private static String asString(final ByteBuffer buffer) {
final ByteBuffer copy = buffer.duplicate();
