Fix checkstyle issues (line lengths).

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/codec/trunk@1378928 13f79535-47bb-0310-9956-ffa450edef68

Author: garydgregory

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

@@ -36,8 +36,9 @@
  * </ul>
  * </p>
  * <p>
- * Since this class operates directly on byte streams, and not character streams, it is hard-coded to only encode/decode
- * character encodings which are compatible with the lower 127 ASCII chart (ISO-8859-1, Windows-1252, UTF-8, etc).
+ * Since this class operates directly on byte streams, and not character streams, it is hard-coded to only
+ * encode/decode character encodings which are compatible with the lower 127 ASCII chart (ISO-8859-1, Windows-1252,
+ * UTF-8, etc).
  * </p>
  * <p>
  * This class is thread-safe.
@@ -98,8 +99,8 @@ public class Base64 extends BaseNCodec {
     };
 
     /**
-     * This array is a lookup table that translates Unicode characters drawn from the "Base64 Alphabet" (as specified in
-     * Table 1 of RFC 2045) into their 6-bit positive integer equivalents. Characters that are not in the Base64
+     * This array is a lookup table that translates Unicode characters drawn from the "Base64 Alphabet" (as specified
+     * in Table 1 of RFC 2045) into their 6-bit positive integer equivalents. Characters that are not in the Base64
      * alphabet but fall within the bounds of the array are translated to -1.
      *
      * Note: '+' and '-' both decode to 62. '/' and '_' both decode to 63. This means decoder seamlessly handles both
@@ -172,16 +173,16 @@ public Base64() {
     /**
      * Creates 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.
+     * When encoding the line length is 76, the line separator is CRLF, and the encoding table is
+     * STANDARD_ENCODE_TABLE.
      * </p>
      *
      * <p>
      * When decoding all variants are supported.
      * </p>
      *
      * @param urlSafe
-     *            if {@code true}, URL-safe encoding is used. In most cases this should be set to
-     *            {@code false}.
+     *            if {@code true}, URL-safe encoding is used. In most cases this should be set to {@code false}.
      * @since 1.4
      */
     public Base64(boolean urlSafe) {
@@ -202,8 +203,9 @@ public Base64(boolean urlSafe) {
      * </p>
      *
      * @param lineLength
-     *            Each line of encoded data will be at most of the given length (rounded down to nearest multiple of 4).
-     *            If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.
+     *            Each line of encoded data will be at most of the given length (rounded down to nearest multiple of
+     *            4). If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when
+     *            decoding.
      * @since 1.4
      */
     public Base64(int lineLength) {
@@ -224,8 +226,9 @@ public Base64(int lineLength) {
      * </p>
      *
      * @param lineLength
-     *            Each line of encoded data will be at most of the given length (rounded down to nearest multiple of 4).
-     *            If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.
+     *            Each line of encoded data will be at most of the given length (rounded down to nearest multiple of
+     *            4). If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when
+     *            decoding.
      * @param lineSeparator
      *            Each line of encoded data will end with this sequence of bytes.
      * @throws IllegalArgumentException
@@ -250,8 +253,9 @@ public Base64(int lineLength, byte[] lineSeparator) {
      * </p>
      *
      * @param lineLength
-     *            Each line of encoded data will be at most of the given length (rounded down to nearest multiple of 4).
-     *            If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.
+     *            Each line of encoded data will be at most of the given length (rounded down to nearest multiple of
+     *            4). If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when
+     *            decoding.
      * @param lineSeparator
      *            Each line of encoded data will end with this sequence of bytes.
      * @param urlSafe
@@ -315,7 +319,8 @@ public boolean isUrlSafe() {
      *            Position to start reading data from.
      * @param inAvail
      *            Amount of bytes available from input for encoding.
-     * @param context the context to be used
+     * @param context
+     *            the context to be used
      */
     @Override
     void encode(byte[] in, int inPos, int inAvail, Context context) {
@@ -333,8 +338,10 @@ void encode(byte[] in, int inPos, int inAvail, Context context) {
             int savedPos = context.pos;
             switch (context.modulus) { // 0-2
                 case 1 : // 8 bits = 6 + 2
-                    context.buffer[context.pos++] = encodeTable[(context.ibitWorkArea >> 2) & MASK_6BITS]; // top 6 bits
-                    context.buffer[context.pos++] = encodeTable[(context.ibitWorkArea << 4) & MASK_6BITS]; // remaining 2
+                    // top 6 bits:
+                    context.buffer[context.pos++] = encodeTable[(context.ibitWorkArea >> 2) & MASK_6BITS];
+                    // remaining 2:
+                    context.buffer[context.pos++] = encodeTable[(context.ibitWorkArea << 4) & MASK_6BITS];
                     // URL-SAFE skips the padding to further reduce size.
                     if (encodeTable == STANDARD_ENCODE_TABLE) {
                         context.buffer[context.pos++] = PAD;
@@ -405,7 +412,8 @@ void encode(byte[] in, int inPos, int inAvail, Context context) {
      *            Position to start reading data from.
      * @param inAvail
      *            Amount of bytes available from input for encoding.
-     * @param context the context to be used
+     * @param context
+     *            the context to be used
      */
     @Override
     void decode(byte[] in, int inPos, int inAvail, Context context) {

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

@@ -76,14 +76,14 @@ static class Context {
         boolean eof;
 
         /**
-         * Variable tracks how many characters have been written to the current line. Only used when encoding. We use it to
-         * make sure each encoded line never goes beyond lineLength (if lineLength > 0).
+         * Variable tracks how many characters have been written to the current line. Only used when encoding. We use
+         * it to make sure each encoded line never goes beyond lineLength (if lineLength > 0).
          */
         int currentLinePos;
 
         /**
-         * Writes to the buffer only occur after every 3/5 reads when encoding, and every 4/8 reads when decoding.
-         * This variable helps track that.
+         * Writes to the buffer only occur after every 3/5 reads when encoding, and every 4/8 reads when decoding. This
+         * variable helps track that.
          */
         int modulus;
 
@@ -166,10 +166,11 @@ static class Context {
      * @param lineLength if &gt; 0, use chunking with a length <code>lineLength</code>
      * @param chunkSeparatorLength the chunk separator length, if relevant
      */
-    protected BaseNCodec(int unencodedBlockSize, int encodedBlockSize, int lineLength, int chunkSeparatorLength){
+    protected BaseNCodec(int unencodedBlockSize, int encodedBlockSize, int lineLength, int chunkSeparatorLength) {
         this.unencodedBlockSize = unencodedBlockSize;
         this.encodedBlockSize = encodedBlockSize;
-        this.lineLength = (lineLength > 0  && chunkSeparatorLength > 0) ? (lineLength / encodedBlockSize) * encodedBlockSize : 0;
+        final boolean useChunking = lineLength > 0 && chunkSeparatorLength > 0;
+        this.lineLength = useChunking ? (lineLength / encodedBlockSize) * encodedBlockSize : 0;
         this.chunkSeparatorLength = chunkSeparatorLength;
     }
 
@@ -231,19 +232,22 @@ protected void ensureBufferSize(int size, Context context){
     }
 
     /**
-     * Extracts buffered data into the provided byte[] array, starting at position bPos,
-     * up to a maximum of bAvail bytes. Returns how many bytes were actually extracted.
+     * Extracts buffered data into the provided byte[] array, starting at position bPos, up to a maximum of bAvail
+     * bytes. Returns how many bytes were actually extracted.
+     * <p>
+     * Package protected for access from I/O streams.
      *
      * @param b
      *            byte[] array to extract the buffered data into.
      * @param bPos
      *            position in byte[] array to start extraction at.
      * @param bAvail
      *            amount of bytes we're allowed to extract. We may extract fewer (if fewer are available).
-     * @param context the context to be used
+     * @param context
+     *            the context to be used
      * @return The number of bytes successfully extracted into the provided byte[] array.
      */
-    int readResults(byte[] b, int bPos, int bAvail, Context context) {  // package protected for access from I/O streams
+    int readResults(byte[] b, int bPos, int bAvail, Context context) {
         if (context.buffer != null) {
             int len = Math.min(available(context), bAvail);
             System.arraycopy(context.buffer, context.readPos, b, bPos, len);
@@ -276,8 +280,8 @@ protected static boolean isWhiteSpace(byte byteToCheck) {
     }
 
     /**
-     * Encodes an Object using the Base-N algorithm. This method is provided in order to satisfy the requirements of the
-     * Encoder interface, and will throw an EncoderException if the supplied object is not of type byte[].
+     * Encodes an Object using the Base-N algorithm. This method is provided in order to satisfy the requirements of
+     * the Encoder interface, and will throw an EncoderException if the supplied object is not of type byte[].
      *
      * @param obj
      *            Object to encode
@@ -317,12 +321,13 @@ public String encodeAsString(byte[] pArray){
     }
 
     /**
-     * Decodes an Object using the Base-N algorithm. This method is provided in order to satisfy the requirements of the
-     * Decoder interface, and will throw a DecoderException if the supplied object is not of type byte[] or String.
+     * Decodes an Object using the Base-N algorithm. This method is provided in order to satisfy the requirements of
+     * the Decoder interface, and will throw a DecoderException if the supplied object is not of type byte[] or String.
      *
      * @param obj
      *            Object to decode
-     * @return An object (of type byte[]) containing the binary data which corresponds to the byte[] or String supplied.
+     * @return An object (of type byte[]) containing the binary data which corresponds to the byte[] or String
+     *         supplied.
      * @throws DecoderException
      *             if the parameter supplied is not of type byte[]
      */
@@ -388,9 +393,11 @@ public byte[] encode(byte[] pArray) {
         return buf;
     }
 
-    abstract void encode(byte[] pArray, int i, int length, Context context);  // package protected for access from I/O streams
+    // package protected for access from I/O streams
+    abstract void encode(byte[] pArray, int i, int length, Context context);
 
-    abstract void decode(byte[] pArray, int i, int length, Context context); // package protected for access from I/O streams
+    // package protected for access from I/O streams
+    abstract void decode(byte[] pArray, int i, int length, Context context);
 
     /**
      * Returns whether or not the <code>octet</code> is in the current alphabet.