Javadoc

Author: garydgregory

src/main/java/org/apache/commons/codec/binary/Base16.java

@@ -114,14 +114,14 @@ public class Base16 extends BaseNCodec {
     private final byte[] encodeTable;
 
     /**
-     * Creates a Base16 codec used for decoding and encoding.
+     * Constructs a Base16 codec used for decoding and encoding.
      */
     public Base16() {
         this(false);
     }
 
     /**
-     * Creates a Base16 codec used for decoding and encoding.
+     * Constructs a Base16 codec used for decoding and encoding.
      *
      * @param lowerCase if {@code true} then use a lower-case Base16 alphabet.
      */
@@ -130,7 +130,7 @@ public Base16(final boolean lowerCase) {
     }
 
     /**
-     * Creates a Base16 codec used for decoding and encoding.
+     * Constructs a Base16 codec used for decoding and encoding.
      *
      * @param lowerCase      if {@code true} then use a lower-case Base16 alphabet.
      * @param decodingPolicy Decoding policy.

src/main/java/org/apache/commons/codec/binary/Base16InputStream.java

@@ -33,7 +33,7 @@
 public class Base16InputStream extends BaseNCodecInputStream {
 
     /**
-     * Creates a Base16InputStream such that all data read is Base16-decoded from the original provided InputStream.
+     * Constructs a Base16InputStream such that all data read is Base16-decoded from the original provided InputStream.
      *
      * @param inputStream InputStream to wrap.
      */
@@ -42,7 +42,7 @@ public Base16InputStream(final InputStream inputStream) {
     }
 
     /**
-     * Creates a Base16InputStream such that all data read is either Base16-encoded or Base16-decoded from the original
+     * Constructs a Base16InputStream such that all data read is either Base16-encoded or Base16-decoded from the original
      * provided InputStream.
      *
      * @param inputStream InputStream to wrap.
@@ -53,7 +53,7 @@ public Base16InputStream(final InputStream inputStream, final boolean doEncode)
     }
 
     /**
-     * Creates a Base16InputStream such that all data read is either Base16-encoded or Base16-decoded from the original
+     * Constructs a Base16InputStream such that all data read is either Base16-encoded or Base16-decoded from the original
      * provided InputStream.
      *
      * @param inputStream InputStream to wrap.
@@ -66,7 +66,7 @@ public Base16InputStream(final InputStream inputStream, final boolean doEncode,
     }
 
     /**
-     * Creates a Base16InputStream such that all data read is either Base16-encoded or Base16-decoded from the original
+     * Constructs a Base16InputStream such that all data read is either Base16-encoded or Base16-decoded from the original
      * provided InputStream.
      *
      * @param inputStream InputStream to wrap.

src/main/java/org/apache/commons/codec/binary/Base16OutputStream.java

@@ -33,7 +33,7 @@
 public class Base16OutputStream extends BaseNCodecOutputStream {
 
     /**
-     * Creates a Base16OutputStream such that all data written is Hex-encoded to the original provided OutputStream.
+     * Constructs a Base16OutputStream such that all data written is Hex-encoded to the original provided OutputStream.
      *
      * @param outputStream OutputStream to wrap.
      */
@@ -42,7 +42,7 @@ public Base16OutputStream(final OutputStream outputStream) {
     }
 
     /**
-     * Creates a Base16OutputStream such that all data written is either Hex-encoded or Hex-decoded to the
+     * Constructs a Base16OutputStream such that all data written is either Hex-encoded or Hex-decoded to the
      * original provided OutputStream.
      *
      * @param outputStream OutputStream to wrap.
@@ -53,7 +53,7 @@ public Base16OutputStream(final OutputStream outputStream, final boolean doEncod
     }
 
     /**
-     * Creates a Base16OutputStream such that all data written is either Hex-encoded or Hex-decoded to the
+     * Constructs a Base16OutputStream such that all data written is either Hex-encoded or Hex-decoded to the
      * original provided OutputStream.
      *
      * @param outputStream OutputStream to wrap.
@@ -65,7 +65,7 @@ public Base16OutputStream(final OutputStream outputStream, final boolean doEncod
     }
 
     /**
-     * Creates a Base16OutputStream such that all data written is either Hex-encoded or Hex-decoded to the
+     * Constructs a Base16OutputStream such that all data written is either Hex-encoded or Hex-decoded to the
      * original provided OutputStream.
      *
      * @param outputStream OutputStream to wrap.

src/main/java/org/apache/commons/codec/binary/Base32.java

@@ -154,7 +154,7 @@ public class Base32 extends BaseNCodec {
     private final byte[] lineSeparator;
 
     /**
-     * Creates a Base32 codec used for decoding and encoding.
+     * Constructs a Base32 codec used for decoding and encoding.
      * <p>
      * When encoding the line length is 0 (no chunking).
      * </p>
@@ -164,7 +164,7 @@ public Base32() {
     }
 
     /**
-     * Creates a Base32 codec used for decoding and encoding.
+     * Constructs a Base32 codec used for decoding and encoding.
      * <p>
      * When encoding the line length is 0 (no chunking).
      * </p>
@@ -176,7 +176,7 @@ public Base32(final boolean useHex) {
     }
 
     /**
-     * Creates a Base32 codec used for decoding and encoding.
+     * Constructs a Base32 codec used for decoding and encoding.
      * <p>
      * When encoding the line length is 0 (no chunking).
      * </p>
@@ -189,7 +189,7 @@ public Base32(final boolean useHex, final byte padding) {
     }
 
     /**
-     * Creates a Base32 codec used for decoding and encoding.
+     * Constructs a Base32 codec used for decoding and encoding.
      * <p>
      * When encoding the line length is 0 (no chunking).
      * </p>
@@ -201,7 +201,7 @@ public Base32(final byte pad) {
     }
 
     /**
-     * Creates a Base32 codec used for decoding and encoding.
+     * Constructs a Base32 codec used for decoding and encoding.
      * <p>
      * When encoding the line length is given in the constructor, the line separator is CRLF.
      * </p>
@@ -214,7 +214,7 @@ public Base32(final int lineLength) {
     }
 
     /**
-     * Creates a Base32 codec used for decoding and encoding.
+     * Constructs a Base32 codec used for decoding and encoding.
      * <p>
      * When encoding the line length and line separator are given in the constructor.
      * </p>
@@ -232,7 +232,7 @@ public Base32(final int lineLength, final byte[] lineSeparator) {
     }
 
     /**
-     * Creates a Base32 / Base32 Hex codec used for decoding and encoding.
+     * Constructs a Base32 / Base32 Hex codec used for decoding and encoding.
      * <p>
      * When encoding the line length and line separator are given in the constructor.
      * </p>
@@ -251,7 +251,7 @@ public Base32(final int lineLength, final byte[] lineSeparator, final boolean us
     }
 
     /**
-     * Creates a Base32 / Base32 Hex codec used for decoding and encoding.
+     * Constructs a Base32 / Base32 Hex codec used for decoding and encoding.
      * <p>
      * When encoding the line length and line separator are given in the constructor.
      * </p>
@@ -271,7 +271,7 @@ public Base32(final int lineLength, final byte[] lineSeparator, final boolean us
     }
 
     /**
-     * Creates a Base32 / Base32 Hex codec used for decoding and encoding.
+     * Constructs a Base32 / Base32 Hex codec used for decoding and encoding.
      * <p>
      * When encoding the line length and line separator are given in the constructor.
      * </p>

src/main/java/org/apache/commons/codec/binary/Base32InputStream.java

@@ -55,7 +55,7 @@
 public class Base32InputStream extends BaseNCodecInputStream {
 
     /**
-     * Creates a Base32InputStream such that all data read is Base32-decoded from the original provided InputStream.
+     * Constructs a Base32InputStream such that all data read is Base32-decoded from the original provided InputStream.
      *
      * @param inputStream
      *            InputStream to wrap.
@@ -65,7 +65,7 @@ public Base32InputStream(final InputStream inputStream) {
     }
 
     /**
-     * Creates a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original
+     * Constructs a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original
      * provided InputStream.
      *
      * @param inputStream
@@ -78,7 +78,7 @@ public Base32InputStream(final InputStream inputStream, final boolean doEncode)
     }
 
     /**
-     * Creates a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original
+     * Constructs a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original
      * provided InputStream.
      *
      * @param inputStream
@@ -98,7 +98,7 @@ public Base32InputStream(final InputStream inputStream, final boolean doEncode,
     }
 
     /**
-     * Creates a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original
+     * Constructs a Base32InputStream such that all data read is either Base32-encoded or Base32-decoded from the original
      * provided InputStream.
      *
      * @param inputStream

src/main/java/org/apache/commons/codec/binary/Base32OutputStream.java

@@ -59,7 +59,7 @@
 public class Base32OutputStream extends BaseNCodecOutputStream {
 
     /**
-     * Creates a Base32OutputStream such that all data written is Base32-encoded to the original provided OutputStream.
+     * Constructs a Base32OutputStream such that all data written is Base32-encoded to the original provided OutputStream.
      *
      * @param outputStream
      *            OutputStream to wrap.
@@ -69,7 +69,7 @@ public Base32OutputStream(final OutputStream outputStream) {
     }
 
     /**
-     * Creates a Base32OutputStream such that all data written is either Base32-encoded or Base32-decoded to the
+     * Constructs a Base32OutputStream such that all data written is either Base32-encoded or Base32-decoded to the
      * original provided OutputStream.
      *
      * @param outputStream
@@ -82,7 +82,7 @@ public Base32OutputStream(final OutputStream outputStream, final boolean doEncod
     }
 
     /**
-     * Creates a Base32OutputStream such that all data written is either Base32-encoded or Base32-decoded to the
+     * Constructs a Base32OutputStream such that all data written is either Base32-encoded or Base32-decoded to the
      * original provided OutputStream.
      *
      * @param outputStream
@@ -102,7 +102,7 @@ public Base32OutputStream(final OutputStream outputStream, final boolean doEncod
     }
 
     /**
-     * Creates a Base32OutputStream such that all data written is either Base32-encoded or Base32-decoded to the
+     * Constructs a Base32OutputStream such that all data written is either Base32-encoded or Base32-decoded to the
      * original provided OutputStream.
      *
      * @param outputStream

src/main/java/org/apache/commons/codec/binary/Base64.java

@@ -529,7 +529,7 @@ private static byte[] toUrlSafeEncodeTable(final boolean urlSafe) {
     private final int encodeSize;
 
     /**
-     * Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
+     * Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
      * <p>
      * When encoding the line length is 0 (no chunking), and the encoding table is STANDARD_ENCODE_TABLE.
      * </p>
@@ -543,7 +543,7 @@ public Base64() {
     }
 
     /**
-     * Creates a Base64 codec used for decoding (all modes) and encoding in the given URL-safe mode.
+     * Constructs a Base64 codec used for decoding (all modes) and encoding in the given URL-safe mode.
      * <p>
      * When encoding the line length is 76, the line separator is CRLF, and the encoding table is STANDARD_ENCODE_TABLE.
      * </p>
@@ -562,7 +562,7 @@ public Base64(final boolean urlSafe) {
     }
 
     /**
-     * Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
+     * Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
      * <p>
      * When encoding the line length is given in the constructor, the line separator is CRLF, and the encoding table is
      * STANDARD_ENCODE_TABLE.
@@ -586,7 +586,7 @@ public Base64(final int lineLength) {
 
 
     /**
-     * Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
+     * Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
      * <p>
      * When encoding the line length and line separator are given in the constructor, and the encoding table is
      * STANDARD_ENCODE_TABLE.
@@ -613,7 +613,7 @@ public Base64(final int lineLength, final byte[] lineSeparator) {
     }
 
     /**
-     * Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
+     * Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
      * <p>
      * When encoding the line length and line separator are given in the constructor, and the encoding table is
      * STANDARD_ENCODE_TABLE.
@@ -644,7 +644,7 @@ public Base64(final int lineLength, final byte[] lineSeparator, final boolean ur
     }
 
     /**
-     * Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
+     * Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
      * <p>
      * When encoding the line length and line separator are given in the constructor, and the encoding table is
      * STANDARD_ENCODE_TABLE.
@@ -677,7 +677,7 @@ public Base64(final int lineLength, final byte[] lineSeparator, final boolean ur
     }
 
     /**
-     * Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
+     * Constructs a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
      * <p>
      * When encoding the line length and line separator are given in the constructor, and the encoding table is
      * STANDARD_ENCODE_TABLE.

src/main/java/org/apache/commons/codec/binary/Base64InputStream.java

@@ -59,7 +59,7 @@
 public class Base64InputStream extends BaseNCodecInputStream {
 
     /**
-     * Creates a Base64InputStream such that all data read is Base64-decoded from the original provided InputStream.
+     * Constructs a Base64InputStream such that all data read is Base64-decoded from the original provided InputStream.
      *
      * @param inputStream
      *            InputStream to wrap.
@@ -69,7 +69,7 @@ public Base64InputStream(final InputStream inputStream) {
     }
 
     /**
-     * Creates a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original
+     * Constructs a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original
      * provided InputStream.
      *
      * @param inputStream
@@ -82,7 +82,7 @@ public Base64InputStream(final InputStream inputStream, final boolean doEncode)
     }
 
     /**
-     * Creates a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original
+     * Constructs a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original
      * provided InputStream.
      *
      * @param inputStream
@@ -102,7 +102,7 @@ public Base64InputStream(final InputStream inputStream, final boolean doEncode,
     }
 
     /**
-     * Creates a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original
+     * Constructs a Base64InputStream such that all data read is either Base64-encoded or Base64-decoded from the original
      * provided InputStream.
      *
      * @param inputStream

src/main/java/org/apache/commons/codec/binary/Base64OutputStream.java

@@ -63,7 +63,7 @@
 public class Base64OutputStream extends BaseNCodecOutputStream {
 
     /**
-     * Creates a Base64OutputStream such that all data written is Base64-encoded to the original provided OutputStream.
+     * Constructs a Base64OutputStream such that all data written is Base64-encoded to the original provided OutputStream.
      *
      * @param outputStream
      *            OutputStream to wrap.
@@ -73,7 +73,7 @@ public Base64OutputStream(final OutputStream outputStream) {
     }
 
     /**
-     * Creates a Base64OutputStream such that all data written is either Base64-encoded or Base64-decoded to the
+     * Constructs a Base64OutputStream such that all data written is either Base64-encoded or Base64-decoded to the
      * original provided OutputStream.
      *
      * @param outputStream
@@ -86,7 +86,7 @@ public Base64OutputStream(final OutputStream outputStream, final boolean doEncod
     }
 
     /**
-     * Creates a Base64OutputStream such that all data written is either Base64-encoded or Base64-decoded to the
+     * Constructs a Base64OutputStream such that all data written is either Base64-encoded or Base64-decoded to the
      * original provided OutputStream.
      *
      * @param outputStream
@@ -106,7 +106,7 @@ public Base64OutputStream(final OutputStream outputStream, final boolean doEncod
     }
 
     /**
-     * Creates a Base64OutputStream such that all data written is either Base64-encoded or Base64-decoded to the
+     * Constructs a Base64OutputStream such that all data written is either Base64-encoded or Base64-decoded to the
      * original provided OutputStream.
      *
      * @param outputStream