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 ce31555b Javadoc
ce31555b is described below
commit ce31555bc542e8e0d618f18eaac04902d5727939
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Aug 2 15:33:38 2026 -0400
Javadoc
---
.../java/org/apache/commons/crypto/Crypto.java | 2 +-
.../commons/crypto/stream/CryptoInputStream.java | 34 +++++++++---------
.../commons/crypto/stream/CryptoOutputStream.java | 28 +++++++--------
.../crypto/stream/CtrCryptoInputStream.java | 42 +++++++++++-----------
.../crypto/stream/CtrCryptoOutputStream.java | 28 +++++++--------
.../crypto/stream/PositionedCryptoInputStream.java | 20 +++++------
.../commons/crypto/stream/input/ChannelInput.java | 12 +++----
.../apache/commons/crypto/stream/input/Input.java | 10 +++---
.../commons/crypto/stream/input/StreamInput.java | 12 +++----
.../crypto/stream/output/ChannelOutput.java | 6 ++--
.../commons/crypto/stream/output/Output.java | 4 +--
.../commons/crypto/stream/output/StreamOutput.java | 6 ++--
.../org/apache/commons/crypto/utils/IoUtils.java | 4 +--
.../org/apache/commons/crypto/utils/Utils.java | 2 +-
14 files changed, 105 insertions(+), 105 deletions(-)
diff --git a/src/main/java/org/apache/commons/crypto/Crypto.java
b/src/main/java/org/apache/commons/crypto/Crypto.java
index 2c305699..1dc37b9e 100644
--- a/src/main/java/org/apache/commons/crypto/Crypto.java
+++ b/src/main/java/org/apache/commons/crypto/Crypto.java
@@ -184,7 +184,7 @@ public static boolean isNativeCodeLoaded() {
* The Main of Crypto.
*
* @param args Not used.
- * @throws Exception if getCryptoRandom or getCryptoCipher get error.
+ * @throws Exception Thrown if getCryptoRandom or getCryptoCipher get
error.
*/
public static void main(final String[] args) throws Exception {
quiet = args.length == 1 && args[0].equals("-q");
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 8b6a98b7..eafc6b00 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CryptoInputStream.java
@@ -87,7 +87,7 @@ static int checkBufferSize(final CryptoCipher cipher, final
int bufferSize) {
* Checks whether the cipher is supported streaming.
*
* @param cipher The {@link CryptoCipher} instance.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
static void checkStreamCipher(final CryptoCipher cipher) throws
IOException {
if (!cipher.getAlgorithm().equals(AES.CTR_NO_PADDING)) {
@@ -152,7 +152,7 @@ static int getBufferSize(final Properties props) {
* @param bufferSize The bufferSize.
* @param key crypto key for the cipher.
* @param params The algorithm parameters.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected CryptoInputStream(final Input input, final CryptoCipher cipher,
final int bufferSize,
final Key key, final AlgorithmParameterSpec params) throws
IOException {
@@ -183,7 +183,7 @@ protected CryptoInputStream(final Input input, final
CryptoCipher cipher, final
* @param bufferSize The bufferSize.
* @param key crypto key for the cipher.
* @param params The algorithm parameters.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@SuppressWarnings("resource") // Closing the instance closes the
StreamInput
protected CryptoInputStream(final InputStream inputStream, final
CryptoCipher cipher,
@@ -200,7 +200,7 @@ protected CryptoInputStream(final InputStream inputStream,
final CryptoCipher ci
* @param bufferSize The bufferSize.
* @param key crypto key for the cipher.
* @param params The algorithm parameters.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@SuppressWarnings("resource") // Closing the instance closes the
ChannelInput
protected CryptoInputStream(final ReadableByteChannel channel, final
CryptoCipher cipher,
@@ -221,7 +221,7 @@ protected CryptoInputStream(final ReadableByteChannel
channel, final CryptoCiphe
* @param inputStream The input stream.
* @param key crypto key for the cipher.
* @param params The algorithm parameters.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@SuppressWarnings("resource") // The CryptoCipher returned by
getCipherInstance() is closed by CryptoInputStream.
public CryptoInputStream(final String transformation,
@@ -242,7 +242,7 @@ public CryptoInputStream(final String transformation,
* @param channel The ReadableByteChannel object.
* @param key crypto key for the cipher.
* @param params The algorithm parameters.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@SuppressWarnings("resource") // The CryptoCipher returned by
getCipherInstance() is closed by CryptoInputStream.
public CryptoInputStream(final String transformation,
@@ -260,7 +260,7 @@ public CryptoInputStream(final String transformation,
* @return An estimate of the number of bytes that can be read (or skipped
* over) from this input stream without blocking or {@code 0} when
* it reaches the end of the input stream.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public int available() throws IOException {
@@ -272,7 +272,7 @@ public int available() throws IOException {
/**
* Checks whether the stream is closed.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected void checkStream() throws IOException {
if (closed) {
@@ -284,7 +284,7 @@ protected void checkStream() throws IOException {
* Overrides the {@link InputStream#close()}. Closes this input stream and
* releases any system resources associated with the stream.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public void close() throws IOException {
@@ -304,7 +304,7 @@ public void close() throws IOException {
* return, inBuffer is cleared; the decrypted data starts at
* outBuffer.position() and ends at outBuffer.limit().
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected void decrypt() throws IOException {
// Prepare the input buffer and clear the out buffer
@@ -325,7 +325,7 @@ protected void decrypt() throws IOException {
/**
* Does final of the cipher to end the decrypting stream.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected void decryptFinal() throws IOException {
// Prepare the input buffer and clear the out buffer
@@ -352,7 +352,7 @@ protected void decryptFinal() throws IOException {
* @return The number of decrypted data.
* return -1 (if end of the decrypted stream)
* return 0 (no data now, but could have more later)
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected int decryptMore() throws IOException {
if (finalDone) {
@@ -435,7 +435,7 @@ protected AlgorithmParameterSpec getParams() {
/**
* Initializes the cipher.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected void initCipher() throws IOException {
try {
@@ -472,7 +472,7 @@ public boolean markSupported() {
*
* @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.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public int read() throws IOException {
@@ -494,7 +494,7 @@ public int read() throws IOException {
* @param len The maximum number of decrypted data bytes to read.
* @return int the total number of decrypted data bytes read into the
* buffer.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public int read(final byte[] array, final int off, final int len) throws
IOException {
@@ -537,7 +537,7 @@ public int read(final byte[] array, final int off, final
int len) throws IOExcep
* @param dst The buffer into which bytes are to be transferred.
* @return The number of bytes read, possibly zero, or {@code EOS (-1)} if
the
* channel has reached end-of-stream.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public int read(final ByteBuffer dst) throws IOException {
@@ -576,7 +576,7 @@ public int read(final ByteBuffer dst) throws IOException {
*
* @param n The number of bytes to be skipped.
* @return The actual number of bytes skipped.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public long skip(final long n) throws IOException {
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 5c9fa1f1..d24fd80d 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CryptoOutputStream.java
@@ -90,7 +90,7 @@ public class CryptoOutputStream extends OutputStream
implements
* @param bufferSize The bufferSize.
* @param key crypto key for the cipher.
* @param params The algorithm parameters.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected CryptoOutputStream(final Output output, final CryptoCipher
cipher,
final int bufferSize, final Key key, final AlgorithmParameterSpec
params)
@@ -124,7 +124,7 @@ protected CryptoOutputStream(final Output output, final
CryptoCipher cipher,
* @param bufferSize The bufferSize.
* @param key crypto key for the cipher.
* @param params The algorithm parameters.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@SuppressWarnings("resource") // Closing the instance closes the
StreamOutput
protected CryptoOutputStream(final OutputStream outputStream, final
CryptoCipher cipher,
@@ -145,7 +145,7 @@ protected CryptoOutputStream(final OutputStream
outputStream, final CryptoCipher
* @param outputStream The output stream.
* @param key crypto key for the cipher.
* @param params The algorithm parameters.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@SuppressWarnings("resource") // The CryptoCipher returned by
getCipherInstance() is closed by CryptoOutputStream.
public CryptoOutputStream(final String transformation,
@@ -168,7 +168,7 @@ public CryptoOutputStream(final String transformation,
* @param out The WritableByteChannel instance.
* @param key crypto key for the cipher.
* @param params The algorithm parameters.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@SuppressWarnings("resource") // The CryptoCipher returned by
getCipherInstance() is closed by CryptoOutputStream.
public CryptoOutputStream(final String transformation,
@@ -187,7 +187,7 @@ public CryptoOutputStream(final String transformation,
* @param bufferSize The bufferSize.
* @param key crypto key for the cipher.
* @param params The algorithm parameters.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@SuppressWarnings("resource") // Closing the instance closes the
ChannelOutput
protected CryptoOutputStream(final WritableByteChannel channel, final
CryptoCipher cipher,
@@ -199,7 +199,7 @@ protected CryptoOutputStream(final WritableByteChannel
channel, final CryptoCiph
/**
* Checks whether the stream is closed.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected void checkStream() throws IOException {
if (closed) {
@@ -211,7 +211,7 @@ protected void checkStream() throws IOException {
* Overrides the {@link OutputStream#close()}. Closes this output stream
and
* releases any system resources associated with this stream.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public void close() throws IOException {
@@ -234,7 +234,7 @@ public void close() throws IOException {
* Does the encryption, input is {@link #inBuffer} and output is
* {@link #outBuffer}.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected void encrypt() throws IOException {
@@ -259,7 +259,7 @@ protected void encrypt() throws IOException {
/**
* Does final encryption of the last data.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected void encryptFinal() throws IOException {
inBuffer.flip();
@@ -285,7 +285,7 @@ protected void encryptFinal() throws IOException {
* the data in the buffer and write to the underlying stream, then do the
* flush.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public void flush() throws IOException {
@@ -340,7 +340,7 @@ protected ByteBuffer getOutBuffer() {
/**
* Initializes the cipher.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected void initCipher() throws IOException {
try {
@@ -370,7 +370,7 @@ public boolean isOpen() {
* @param array The data.
* @param off The start offset in the data.
* @param len The number of bytes to write.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public void write(final byte[] array, int off, int len) throws IOException
{
@@ -402,7 +402,7 @@ public void write(final byte[] array, int off, int len)
throws IOException {
*
* @param src The buffer from which bytes are to be retrieved.
* @return The number of bytes written, possibly zero.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public int write(final ByteBuffer src) throws IOException {
@@ -438,7 +438,7 @@ public int write(final ByteBuffer src) throws IOException {
* specified byte to this output stream.
*
* @param b The data.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public void write(final int b) throws IOException {
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 86fcc97c..a1b12388 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CtrCryptoInputStream.java
@@ -128,7 +128,7 @@ static void calculateIV(final byte[] initIV, long counter,
final byte[] IV) {
* @param bufferSize The bufferSize.
* @param key crypto key for the cipher.
* @param iv Initialization vector for the cipher.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected CtrCryptoInputStream(final Input input, final CryptoCipher
cipher,
final int bufferSize, final byte[] key, final byte[] iv) throws
IOException {
@@ -144,7 +144,7 @@ protected CtrCryptoInputStream(final Input input, final
CryptoCipher cipher,
* @param key crypto key for the cipher.
* @param iv Initialization vector for the cipher.
* @param streamOffset The start offset in the stream.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected CtrCryptoInputStream(final Input input, final CryptoCipher
cipher,
final int bufferSize, final byte[] key, final byte[] iv, final
long streamOffset)
@@ -168,7 +168,7 @@ protected CtrCryptoInputStream(final Input input, final
CryptoCipher cipher,
* @param bufferSize The bufferSize.
* @param key crypto key for the cipher.
* @param iv Initialization vector for the cipher.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected CtrCryptoInputStream(final InputStream inputStream, final
CryptoCipher cipher,
final int bufferSize, final byte[] key, final byte[] iv) throws
IOException {
@@ -184,7 +184,7 @@ protected CtrCryptoInputStream(final InputStream
inputStream, final CryptoCipher
* @param key crypto key for the cipher.
* @param iv Initialization vector for the cipher.
* @param streamOffset The start offset in the stream.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@SuppressWarnings("resource") // Closing the instance closes the
StreamInput
protected CtrCryptoInputStream(final InputStream inputStream, final
CryptoCipher cipher,
@@ -202,7 +202,7 @@ protected CtrCryptoInputStream(final InputStream
inputStream, final CryptoCipher
* @param inputStream The input stream.
* @param key crypto key for the cipher.
* @param iv Initialization vector for the cipher.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
public CtrCryptoInputStream(final Properties properties, final InputStream
inputStream, final byte[] key,
final byte[] iv) throws IOException {
@@ -218,7 +218,7 @@ public CtrCryptoInputStream(final Properties properties,
final InputStream input
* @param key crypto key for the cipher.
* @param iv Initialization vector for the cipher.
* @param streamOffset The start offset in the stream.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@SuppressWarnings("resource") // The CryptoCipher returned by
getCipherInstance() is closed by CtrCryptoInputStream.
public CtrCryptoInputStream(final Properties properties, final InputStream
inputStream, final byte[] key,
@@ -236,7 +236,7 @@ public CtrCryptoInputStream(final Properties properties,
final InputStream input
* @param channel The ReadableByteChannel instance.
* @param key crypto key for the cipher.
* @param iv Initialization vector for the cipher.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
public CtrCryptoInputStream(final Properties properties, final
ReadableByteChannel channel,
final byte[] key, final byte[] iv) throws IOException {
@@ -252,7 +252,7 @@ public CtrCryptoInputStream(final Properties properties,
final ReadableByteChann
* @param key crypto key for the cipher.
* @param iv Initialization vector for the cipher.
* @param streamOffset The start offset in the stream.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@SuppressWarnings("resource") // The CryptoCipher returned by
getCipherInstance() is closed by CtrCryptoInputStream.
public CtrCryptoInputStream(final Properties properties, final
ReadableByteChannel in,
@@ -270,7 +270,7 @@ public CtrCryptoInputStream(final Properties properties,
final ReadableByteChann
* @param bufferSize The bufferSize.
* @param key crypto key for the cipher.
* @param iv Initialization vector for the cipher.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected CtrCryptoInputStream(final ReadableByteChannel channel, final
CryptoCipher cipher,
final int bufferSize, final byte[] key, final byte[] iv) throws
IOException {
@@ -286,7 +286,7 @@ protected CtrCryptoInputStream(final ReadableByteChannel
channel, final CryptoCi
* @param key crypto key for the cipher.
* @param iv Initialization vector for the cipher.
* @param streamOffset The start offset in the stream.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@SuppressWarnings("resource") // Closing the instance closes the
ChannelInput
protected CtrCryptoInputStream(final ReadableByteChannel channel, final
CryptoCipher cipher,
@@ -300,7 +300,7 @@ protected CtrCryptoInputStream(final ReadableByteChannel
channel, final CryptoCi
* return, inBuffer is cleared; the decrypted data starts at
* outBuffer.position() and ends at outBuffer.limit().
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
protected void decrypt() throws IOException {
@@ -333,7 +333,7 @@ protected void decrypt() throws IOException {
* @param buf The buffer into which bytes are to be transferred.
* @param offset The start offset in the data.
* @param len The maximum number of decrypted data bytes to read.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected void decrypt(final ByteBuffer buf, final int offset, final int
len)
throws IOException {
@@ -362,7 +362,7 @@ protected void decrypt(final ByteBuffer buf, final int
offset, final int len)
* Does the decryption using out as output.
*
* @param out The output ByteBuffer.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected void decryptBuffer(final ByteBuffer out) throws IOException {
final int inputSize = inBuffer.remaining();
@@ -390,7 +390,7 @@ protected void decryptBuffer(final ByteBuffer out) throws
IOException {
* limit will not have changed.
*
* @param buf The buffer into which bytes are to be transferred.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected void decryptInPlace(final ByteBuffer buf) throws IOException {
Utils.checkState(inBuffer.position() >= padding);
@@ -412,7 +412,7 @@ protected void decryptInPlace(final ByteBuffer buf) throws
IOException {
* will be put in the output buffer.
*
* @return The number of decrypted data. -1 if end of the decrypted stream.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
protected int decryptMore() throws IOException {
@@ -490,7 +490,7 @@ protected void initCipher() {
*
* @param position The given position in the data.
* @return The byte.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected byte postDecryption(final long position) throws IOException {
byte padding = 0;
@@ -515,7 +515,7 @@ protected byte postDecryption(final long position) throws
IOException {
* @param buf The buffer into which bytes are to be transferred.
* @return The number of bytes read, possibly zero, or {@code -1} if the
* channel has reached end-of-stream.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public int read(final ByteBuffer buf) throws IOException {
@@ -558,7 +558,7 @@ public int read(final ByteBuffer buf) throws IOException {
* Calculates the counter and iv, resets the cipher.
*
* @param position The given position in the data.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected void resetCipher(final long position) throws IOException {
final long counter = getCounter(position);
@@ -576,7 +576,7 @@ protected void resetCipher(final long position) throws
IOException {
* {@link #outBuffer}. This Typically happens during {@link #skip(long)}.
*
* @param offset The offset of the stream.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected void resetStreamOffset(final long offset) throws IOException {
streamOffset = offset;
@@ -593,7 +593,7 @@ protected void resetStreamOffset(final long offset) throws
IOException {
* layer stream.
*
* @param position The given position in the data.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
public void seek(final long position) throws IOException {
Utils.checkArgument(position >= 0, "Cannot seek to negative offset.");
@@ -628,7 +628,7 @@ protected void setStreamOffset(final long streamOffset) {
*
* @param n The number of bytes to be skipped.
* @return The actual number of bytes skipped.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public long skip(long n) throws IOException {
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 baa1e79b..35bb572c 100644
--- a/src/main/java/org/apache/commons/crypto/stream/CtrCryptoOutputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/CtrCryptoOutputStream.java
@@ -90,7 +90,7 @@ public class CtrCryptoOutputStream extends CryptoOutputStream
{
* @param bufferSize The bufferSize.
* @param key crypto key for the cipher.
* @param iv Initialization vector for the cipher.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected CtrCryptoOutputStream(final Output output, final CryptoCipher
cipher,
final int bufferSize, final byte[] key, final byte[] iv) throws
IOException {
@@ -106,7 +106,7 @@ protected CtrCryptoOutputStream(final Output output, final
CryptoCipher cipher,
* @param key crypto key for the cipher.
* @param iv Initialization vector for the cipher.
* @param streamOffset The start offset in the data.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected CtrCryptoOutputStream(final Output output, final CryptoCipher
cipher,
final int bufferSize, final byte[] key, final byte[] iv, final
long streamOffset)
@@ -130,7 +130,7 @@ protected CtrCryptoOutputStream(final Output output, final
CryptoCipher cipher,
* @param bufferSize The bufferSize.
* @param key crypto key for the cipher.
* @param iv Initialization vector for the cipher.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected CtrCryptoOutputStream(final OutputStream out, final CryptoCipher
cipher,
final int bufferSize, final byte[] key, final byte[] iv) throws
IOException {
@@ -146,7 +146,7 @@ protected CtrCryptoOutputStream(final OutputStream out,
final CryptoCipher ciphe
* @param key crypto key for the cipher.
* @param iv Initialization vector for the cipher.
* @param streamOffset The start offset in the data.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@SuppressWarnings("resource") // Closing the instance closes the
StreamOutput
protected CtrCryptoOutputStream(final OutputStream outputStream, final
CryptoCipher cipher,
@@ -163,7 +163,7 @@ protected CtrCryptoOutputStream(final OutputStream
outputStream, final CryptoCip
* @param out The output stream.
* @param key crypto key for the cipher.
* @param iv Initialization vector for the cipher.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
public CtrCryptoOutputStream(final Properties props, final OutputStream
out,
final byte[] key, final byte[] iv) throws IOException {
@@ -179,7 +179,7 @@ public CtrCryptoOutputStream(final Properties props, final
OutputStream out,
* @param key crypto key for the cipher.
* @param iv Initialization vector for the cipher.
* @param streamOffset The start offset in the data.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@SuppressWarnings("resource") // The CryptoCipher returned by
getCipherInstance() is closed by CtrCryptoOutputStream.
public CtrCryptoOutputStream(final Properties properties, final
OutputStream outputStream,
@@ -197,7 +197,7 @@ public CtrCryptoOutputStream(final Properties properties,
final OutputStream out
* @param out The WritableByteChannel instance.
* @param key crypto key for the cipher.
* @param iv Initialization vector for the cipher.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
public CtrCryptoOutputStream(final Properties props, final
WritableByteChannel out,
final byte[] key, final byte[] iv) throws IOException {
@@ -213,7 +213,7 @@ public CtrCryptoOutputStream(final Properties props, final
WritableByteChannel o
* @param key crypto key for the cipher.
* @param iv Initialization vector for the cipher.
* @param streamOffset The start offset in the data.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@SuppressWarnings("resource") // The CryptoCipher returned by
getCipherInstance() is closed by CtrCryptoOutputStream.
public CtrCryptoOutputStream(final Properties properties, final
WritableByteChannel channel,
@@ -231,7 +231,7 @@ public CtrCryptoOutputStream(final Properties properties,
final WritableByteChan
* @param bufferSize The bufferSize.
* @param key crypto key for the cipher.
* @param iv Initialization vector for the cipher.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected CtrCryptoOutputStream(final WritableByteChannel channel,
final CryptoCipher cipher, final int bufferSize, final byte[] key,
final byte[] iv)
@@ -248,7 +248,7 @@ protected CtrCryptoOutputStream(final WritableByteChannel
channel,
* @param key crypto key for the cipher.
* @param iv Initialization vector for the cipher.
* @param streamOffset The start offset in the data.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@SuppressWarnings("resource") // Closing the instance closes the
ChannelOutput
protected CtrCryptoOutputStream(final WritableByteChannel channel,
@@ -261,7 +261,7 @@ protected CtrCryptoOutputStream(final WritableByteChannel
channel,
* Does the encryption, input is {@link #inBuffer} and output is
* {@link #outBuffer}.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
protected void encrypt() throws IOException {
@@ -303,7 +303,7 @@ protected void encrypt() throws IOException {
* Does the encryption if the ByteBuffer data.
*
* @param out The output ByteBuffer.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
private void encryptBuffer(final ByteBuffer out) throws IOException {
final int inputSize = inBuffer.remaining();
@@ -326,7 +326,7 @@ private void encryptBuffer(final ByteBuffer out) throws
IOException {
/**
* Does final encryption of the last data.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
protected void encryptFinal() throws IOException {
@@ -356,7 +356,7 @@ protected void initCipher() {
/**
* Resets the {@link #cipher}: calculate counter and {@link #padding}.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
private void resetCipher() throws IOException {
final long counter = 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 314bd94b..6a4505d2 100644
---
a/src/main/java/org/apache/commons/crypto/stream/PositionedCryptoInputStream.java
+++
b/src/main/java/org/apache/commons/crypto/stream/PositionedCryptoInputStream.java
@@ -108,7 +108,7 @@ public void reset(final boolean reset) {
* @param key crypto key for the cipher.
* @param iv Initialization vector for the cipher.
* @param streamOffset The start offset in the data.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@SuppressWarnings("resource") // The CryptoCipher returned by
getCipherInstance() is closed by PositionedCryptoInputStream.
public PositionedCryptoInputStream(final Properties properties, final
Input in, final byte[] key,
@@ -126,7 +126,7 @@ public PositionedCryptoInputStream(final Properties
properties, final Input in,
* @param key crypto key for the cipher.
* @param iv Initialization vector for the cipher.
* @param streamOffset The start offset in the data.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected PositionedCryptoInputStream(final Properties properties, final
Input input, final CryptoCipher cipher,
final int bufferSize, final byte[] key, final byte[] iv, final
long streamOffset)
@@ -155,7 +155,7 @@ private void cleanCipherStatePool() {
* Overrides the {@link CryptoInputStream#close()}. Closes this input
stream
* and releases any system resources associated with the stream.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public void close() throws IOException {
@@ -177,7 +177,7 @@ public void close() throws IOException {
* @param inByteBuffer The input buffer.
* @param outByteBuffer The output buffer.
* @param padding The padding.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
private void decrypt(final CipherState state, final ByteBuffer
inByteBuffer,
final ByteBuffer outByteBuffer, final byte padding) throws
IOException {
@@ -208,7 +208,7 @@ private void decrypt(final CipherState state, final
ByteBuffer inByteBuffer,
* @param offset The start offset in the data.
* @param position The offset from the start of the stream.
* @param length The maximum number of bytes to read.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
protected void decrypt(final long position, final byte[] buffer, final int
offset, final int length)
throws IOException {
@@ -247,7 +247,7 @@ protected void decrypt(final long position, final byte[]
buffer, final int offse
* @param state The CipherState instance.
* @param inByteBuffer The input buffer.
* @param outByteBuffer The output buffer.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@SuppressWarnings("resource") // getCryptoCipher does not allocate
private void decryptBuffer(final CipherState state, final ByteBuffer
inByteBuffer,
@@ -284,7 +284,7 @@ private ByteBuffer getBuffer() {
* Gets CryptoCipher from pool. Caller MUST also call {@link
#returnToPool(CipherState)}.
*
* @return The CipherState instance.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@SuppressWarnings("resource") // Caller calls #returnToPool(CipherState)
private CipherState getCipherState() throws IOException {
@@ -328,7 +328,7 @@ private byte postDecryption(final CipherState state, final
ByteBuffer inByteBuff
* @param length The maximum number of bytes to read.
* @param offset The start offset in the data.
* @param position The offset from the start of the stream.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
* @return int the total number of decrypted data bytes read into the
* buffer.
*/
@@ -350,7 +350,7 @@ public int read(final long position, final byte[] buffer,
final int offset, fina
*
* @param position The offset from the start of the stream.
* @param buffer The buffer into which the data is read.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
public void readFully(final long position, final byte[] buffer) throws
IOException {
readFully(position, buffer, 0, buffer.length);
@@ -365,7 +365,7 @@ public void readFully(final long position, final byte[]
buffer) throws IOExcepti
* @param length The maximum number of bytes to read.
* @param offset The start offset in the data.
* @param position The offset from the start of the stream.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
public void readFully(final long position, final byte[] buffer, final int
offset, final int length)
throws IOException {
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 75495a7d..d43dfd99 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
@@ -57,7 +57,7 @@ public ChannelInput(final ReadableByteChannel channel) {
* @return An estimate of the number of bytes that can be read (or skipped
* over) from this input stream without blocking or {@code 0} when
* it reaches the end of the input stream.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public int available() throws IOException {
@@ -70,7 +70,7 @@ public int available() throws IOException {
* this input and releases any system resources associated with the under
* layer input.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public void close() throws IOException {
@@ -98,7 +98,7 @@ private ByteBuffer getSkipBuf() {
* @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.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public int read(final ByteBuffer dst) throws IOException {
@@ -120,7 +120,7 @@ public int read(final ByteBuffer dst) throws IOException {
* @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.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public int read(final long position, final byte[] buffer, final int
offset, final int length)
@@ -136,7 +136,7 @@ public int read(final long position, final byte[] buffer,
final int offset, fina
* from that location.
*
* @param position The offset from the start of the stream.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public void seek(final long position) throws IOException {
@@ -151,7 +151,7 @@ public void seek(final long position) throws IOException {
*
* @param n The number of bytes to be skipped.
* @return The actual number of bytes skipped.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public long skip(final long n) throws IOException {
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 22c09fda..e8910a73 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
@@ -48,7 +48,7 @@ public interface Input extends Closeable {
* @return An estimate of the number of bytes that can be read (or skipped
* over) from this input stream without blocking or {@code 0} when
* it reaches the end of the input stream.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
int available() throws IOException;
@@ -56,7 +56,7 @@ public interface Input extends Closeable {
* Closes this input and releases any system resources associated with the
* under layer input.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
void close() throws IOException;
@@ -102,7 +102,7 @@ public interface Input extends Closeable {
* @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.
+ * @throws IOException Thrown if an I/O error occurs.
*/
int read(long position, byte[] buffer, int offset, int length)
throws IOException;
@@ -115,7 +115,7 @@ int read(long position, byte[] buffer, int offset, int
length)
* support seek, it throws UnsupportedOperationException.
*
* @param position The offset from the start of the stream.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
void seek(long position) throws IOException;
@@ -137,7 +137,7 @@ int read(long position, byte[] buffer, int offset, int
length)
*
* @param n The number of bytes to be skipped.
* @return The actual number of bytes skipped.
- * @throws IOException if the stream does not support seek, or if some
+ * @throws IOException Thrown if the stream does not support seek, or if
some
* other I/O error occurs.
*/
long skip(long n) throws IOException;
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 17401a29..90df7adf 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
@@ -60,7 +60,7 @@ public StreamInput(final InputStream inputStream, final int
bufferSize) {
* @return An estimate of the number of bytes that can be read (or skipped
* over) from this input stream without blocking or {@code 0} when
* it reaches the end of the input stream.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public int available() throws IOException {
@@ -73,7 +73,7 @@ public int available() throws IOException {
* this input and releases any system resources associated with the under
* layer input.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public void close() throws IOException {
@@ -89,7 +89,7 @@ public void close() throws IOException {
* @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.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public int read(final ByteBuffer dst) throws IOException {
@@ -127,7 +127,7 @@ public int read(final ByteBuffer dst) throws IOException {
* @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.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public int read(final long position, final byte[] buffer, final int
offset, final int length) throws IOException {
@@ -141,7 +141,7 @@ public int read(final long position, final byte[] buffer,
final int offset, fina
* from that location.
*
* @param position The offset from the start of the stream.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public void seek(final long position) throws IOException {
@@ -155,7 +155,7 @@ public void seek(final long position) throws IOException {
*
* @param n The number of bytes to be skipped.
* @return The actual number of bytes skipped.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public long skip(final long n) throws IOException {
diff --git
a/src/main/java/org/apache/commons/crypto/stream/output/ChannelOutput.java
b/src/main/java/org/apache/commons/crypto/stream/output/ChannelOutput.java
index c3436852..b722f345 100644
--- a/src/main/java/org/apache/commons/crypto/stream/output/ChannelOutput.java
+++ b/src/main/java/org/apache/commons/crypto/stream/output/ChannelOutput.java
@@ -48,7 +48,7 @@ public ChannelOutput(final WritableByteChannel channel) {
* Overrides the {@link Output#close()}. Closes this output and releases
any
* system resources associated with the under layer output.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public void close() throws IOException {
@@ -60,7 +60,7 @@ public void close() throws IOException {
* buffered output bytes to be written out if the under layer output method
* support.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public void flush() throws IOException {
@@ -74,7 +74,7 @@ public void flush() throws IOException {
*
* @param src The buffer from which bytes are to be retrieved.
* @return The number of bytes written, possibly zero.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public int write(final ByteBuffer src) throws IOException {
diff --git a/src/main/java/org/apache/commons/crypto/stream/output/Output.java
b/src/main/java/org/apache/commons/crypto/stream/output/Output.java
index 25128feb..e75b3a41 100644
--- a/src/main/java/org/apache/commons/crypto/stream/output/Output.java
+++ b/src/main/java/org/apache/commons/crypto/stream/output/Output.java
@@ -38,7 +38,7 @@ public interface Output extends Closeable {
* Closes this output and releases any system resources associated with the
* under layer output.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
void close() throws IOException;
@@ -51,7 +51,7 @@ public interface Output extends Closeable {
* stream, such bytes should immediately be written to their intended
* destination.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
void flush() throws IOException;
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 13fe8174..c78c7e4a 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
@@ -51,7 +51,7 @@ public StreamOutput(final OutputStream out, final int
bufferSize) {
* Overrides the {@link Output#close()}. Closes this output and releases
any
* system resources associated with the under layer output.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public void close() throws IOException {
@@ -63,7 +63,7 @@ public void close() throws IOException {
* buffered output bytes to be written out if the under layer output method
* support.
*
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public void flush() throws IOException {
@@ -86,7 +86,7 @@ protected OutputStream getOut() {
*
* @param src The buffer from which bytes are to be retrieved.
* @return The number of bytes written, possibly zero.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
@Override
public int write(final ByteBuffer src) throws IOException {
diff --git a/src/main/java/org/apache/commons/crypto/utils/IoUtils.java
b/src/main/java/org/apache/commons/crypto/utils/IoUtils.java
index 270ccbc4..384ea0f0 100644
--- a/src/main/java/org/apache/commons/crypto/utils/IoUtils.java
+++ b/src/main/java/org/apache/commons/crypto/utils/IoUtils.java
@@ -62,7 +62,7 @@ public static void closeQuietly(final Closeable closeable) {
* @param buffer The buffer to be read.
* @param length The maximum number of bytes to read.
* @param offset The start offset in array buffer.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
public static void readFully(final Input in, final long position, final
byte[] buffer,
final int offset, final int length) throws IOException {
@@ -85,7 +85,7 @@ public static void readFully(final Input in, final long
position, final byte[] b
* @param buf The buffer to be read.
* @param off The start offset in array buffer.
* @param len The maximum number of bytes to read.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
public static void readFully(final InputStream in, final byte[] buf, int
off, final int len)
throws IOException {
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 eb655226..03fa2052 100644
--- a/src/main/java/org/apache/commons/crypto/utils/Utils.java
+++ b/src/main/java/org/apache/commons/crypto/utils/Utils.java
@@ -163,7 +163,7 @@ public static void checkState(final boolean expression,
final String message) {
* See the Java Cryptography Architecture Standard Algorithm Name
Documentation
* for information about standard transformation names.
* @return The CryptoCipher instance.
- * @throws IOException if an I/O error occurs.
+ * @throws IOException Thrown if an I/O error occurs.
*/
public static CryptoCipher getCipherInstance(final String transformation,
final Properties properties) throws IOException {
try {
