Code formatting and cleanup, javadoc formatting, default locale for string formatting, consuming entity/inputstream

Author: smarek

library/src/main/java/com/loopj/android/http/base64/Base64.java

@@ -33,31 +33,31 @@ public class Base64 {
     /**
      * Encoder flag bit to omit the padding '=' characters at the end of the output (if any).
      */
-    public static final int NO_PADDING = 1;
+    private static final int NO_PADDING = 1;
 
     /**
      * Encoder flag bit to omit all line terminators (i.e., the output will be on one long line).
      */
-    public static final int NO_WRAP = 2;
+    private static final int NO_WRAP = 2;
 
     /**
      * Encoder flag bit to indicate lines should be terminated with a CRLF pair instead of just an
      * LF.  Has no effect if {@code NO_WRAP} is specified as well.
      */
-    public static final int CRLF = 4;
+    private static final int CRLF = 4;
 
     /**
      * Encoder/decoder flag bit to indicate using the "URL and filename safe" variant of Base64 (see
      * RFC 3548 section 4) where {@code -} and {@code _} are used in place of {@code +} and {@code
      * /}.
      */
-    public static final int URL_SAFE = 8;
+    private static final int URL_SAFE = 8;
 
     /**
      * Flag to pass to {@link Base64OutputStream} to indicate that it should not close the output
      * stream it is wrapping when it itself is closed.
      */
-    public static final int NO_CLOSE = 16;
+    static final int NO_CLOSE = 16;
 
     //  --------------------------------------------------------
     //  shared code
@@ -80,7 +80,7 @@ private Base64() {
      * @param flags controls certain features of the decoded output. Pass {@code DEFAULT} to decode
      *              standard Base64.
      * @return decoded bytes
-     * @throws IllegalArgumentException if the input contains incorrect padding
+     * @throws java.lang.IllegalArgumentException if the input contains incorrect padding
      */
     public static byte[] decode(String str, int flags) {
         return decode(str.getBytes(), flags);
@@ -95,31 +95,30 @@ public static byte[] decode(String str, int flags) {
      * @param flags controls certain features of the decoded output. Pass {@code DEFAULT} to decode
      *              standard Base64.
      * @return decoded bytes
-     * @throws IllegalArgumentException if the input contains incorrect padding
+     * @throws java.lang.IllegalArgumentException if the input contains incorrect padding
      */
-    public static byte[] decode(byte[] input, int flags) {
-        return decode(input, 0, input.length, flags);
+    private static byte[] decode(byte[] input, int flags) {
+        return decode(input, input.length, flags);
     }
 
     /**
      * Decode the Base64-encoded data in input and return the data in a new byte array.
      * <p>&nbsp;</p> <p>The padding '=' characters at the end are considered optional, but if any
      * are present, there must be the correct number of them.
      *
-     * @param input  the data to decode
-     * @param offset the position within the input array at which to start
-     * @param len    the number of bytes of input to decode
-     * @param flags  controls certain features of the decoded output. Pass {@code DEFAULT} to decode
-     *               standard Base64.
+     * @param input the data to decode
+     * @param len   the number of bytes of input to decode
+     * @param flags controls certain features of the decoded output. Pass {@code DEFAULT} to decode
+     *              standard Base64.
      * @return decoded bytes for given offset and length
-     * @throws IllegalArgumentException if the input contains incorrect padding
+     * @throws java.lang.IllegalArgumentException if the input contains incorrect padding
      */
-    public static byte[] decode(byte[] input, int offset, int len, int flags) {
+    private static byte[] decode(byte[] input, int len, int flags) {
         // Allocate space for the most data the input could represent.
         // (It could contain less if it contains whitespace, etc.)
         Decoder decoder = new Decoder(flags, new byte[len * 3 / 4]);
 
-        if (!decoder.process(input, offset, len, true)) {
+        if (!decoder.process(input, 0, len, true)) {
             throw new IllegalArgumentException("bad base-64");
         }
 
@@ -183,7 +182,7 @@ public static String encodeToString(byte[] input, int offset, int len, int flags
      *              in output that adheres to RFC 2045.
      * @return base64 encoded input as bytes
      */
-    public static byte[] encode(byte[] input, int flags) {
+    private static byte[] encode(byte[] input, int flags) {
         return encode(input, 0, input.length, flags);
     }
 
@@ -197,7 +196,7 @@ public static byte[] encode(byte[] input, int flags) {
      *               results in output that adheres to RFC 2045.
      * @return base64 encoded input as bytes
      */
-    public static byte[] encode(byte[] input, int offset, int len, int flags) {
+    private static byte[] encode(byte[] input, int offset, int len, int flags) {
         Encoder encoder = new Encoder(flags, null);
 
         // Compute the exact length of the array we will produce.
@@ -238,8 +237,8 @@ public static byte[] encode(byte[] input, int offset, int len, int flags) {
     }
 
     /* package */ static abstract class Coder {
-        public byte[] output;
-        public int op;
+        byte[] output;
+        int op;
 
         /**
          * Encode/decode another block of input data.  this.output is provided by the caller, and
@@ -264,7 +263,7 @@ public static byte[] encode(byte[] input, int offset, int len, int flags) {
         /**
          * Lookup table for turning bytes into their position in the Base64 alphabet.
          */
-        private static final int DECODE[] = {
+        private static final int[] DECODE = {
                 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
                 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
                 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 62, -1, -1, -1, 63,
@@ -287,7 +286,7 @@ public static byte[] encode(byte[] input, int offset, int len, int flags) {
          * Decode lookup table for the "web safe" variant (RFC 3548 sec. 4) where - and _ replace +
          * and /.
          */
-        private static final int DECODE_WEBSAFE[] = {
+        private static final int[] DECODE_WEBSAFE = {
                 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
                 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
                 -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 62, -1, -1,
@@ -321,7 +320,7 @@ public static byte[] encode(byte[] input, int offset, int len, int flags) {
         private int state;   // state number (0 to 6)
         private int value;
 
-        public Decoder(int flags, byte[] output) {
+        Decoder(int flags, byte[] output) {
             this.output = output;
 
             alphabet = ((flags & URL_SAFE) == 0) ? DECODE : DECODE_WEBSAFE;
@@ -526,12 +525,12 @@ public boolean process(byte[] input, int offset, int len, boolean finish) {
          * (the maximum allowable according to <a href="https://www.ietf.org/rfc/rfc2045.txt">RFC
          * 2045</a>).
          */
-        public static final int LINE_GROUPS = 19;
+        static final int LINE_GROUPS = 19;
 
         /**
          * Lookup table for turning Base64 alphabet positions (6 bits) into output bytes.
          */
-        private static final byte ENCODE[] = {
+        private static final byte[] ENCODE = {
                 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P',
                 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', 'a', 'b', 'c', 'd', 'e', 'f',
                 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v',
@@ -541,21 +540,21 @@ public boolean process(byte[] input, int offset, int len, boolean finish) {
         /**
          * Lookup table for turning Base64 alphabet positions (6 bits) into output bytes.
          */
-        private static final byte ENCODE_WEBSAFE[] = {
+        private static final byte[] ENCODE_WEBSAFE = {
                 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P',
                 'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', 'a', 'b', 'c', 'd', 'e', 'f',
                 'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v',
                 'w', 'x', 'y', 'z', '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '-', '_',
         };
-        final public boolean do_padding;
-        final public boolean do_newline;
-        final public boolean do_cr;
+        final boolean do_padding;
+        final boolean do_newline;
+        final boolean do_cr;
         final private byte[] tail;
         final private byte[] alphabet;
         /* package */ int tailLen;
         private int count;
 
-        public Encoder(int flags, byte[] output) {
+        Encoder(int flags, byte[] output) {
             this.output = output;
 
             do_padding = (flags & NO_PADDING) == 0;

library/src/main/java/com/loopj/android/http/handlers/AsyncHttpResponseHandler.java

@@ -30,13 +30,15 @@
 import java.io.InputStream;
 import java.lang.ref.WeakReference;
 import java.net.URI;
+import java.util.Locale;
 
 import cz.msebera.android.httpclient.Header;
 import cz.msebera.android.httpclient.HttpEntity;
 import cz.msebera.android.httpclient.HttpResponse;
 import cz.msebera.android.httpclient.StatusLine;
 import cz.msebera.android.httpclient.client.HttpResponseException;
 import cz.msebera.android.httpclient.util.ByteArrayBuffer;
+import cz.msebera.android.httpclient.util.EntityUtils;
 
 /**
  * Used to intercept and handle the responses from requests made using {@link AsyncHttpClient}. The
@@ -82,7 +84,6 @@
  * });
  * </pre>
  */
-@SuppressWarnings("ALL")
 public abstract class AsyncHttpResponseHandler implements ResponseHandlerInterface {
 
     public static final String DEFAULT_CHARSET = "UTF-8";
@@ -243,7 +244,7 @@ public void setCharset(final String charset) {
      * @param totalSize    total size of file
      */
     public void onProgress(long bytesWritten, long totalSize) {
-        AsyncHttpClient.log.v(LOG_TAG, String.format("Progress %d from %d (%2.0f%%)", bytesWritten, totalSize, (totalSize > 0) ? (bytesWritten * 1.0 / totalSize) * 100 : -1));
+        AsyncHttpClient.log.v(LOG_TAG, String.format(Locale.getDefault(), "Progress %d from %d (%2.0f%%)", bytesWritten, totalSize, (totalSize > 0) ? (bytesWritten * 1.0 / totalSize) * 100 : -1));
     }
 
     /**
@@ -296,7 +297,7 @@ public void onPostProcessResponse(ResponseHandlerInterface instance, HttpRespons
      * @param retryNo number of retry
      */
     public void onRetry(int retryNo) {
-        AsyncHttpClient.log.d(LOG_TAG, String.format("Request retry no. %d", retryNo));
+        AsyncHttpClient.log.d(LOG_TAG, String.format(Locale.getDefault(), "Request retry no. %d", retryNo));
     }
 
     public void onCancel() {
@@ -485,8 +486,7 @@ byte[] getResponseData(HttpEntity entity) throws IOException {
                             sendProgressMessage(count, (contentLength <= 0 ? 1 : contentLength));
                         }
                     } finally {
-//                        AsyncHttpClient.silentCloseInputStream(instream);
-//                        AsyncHttpClient.endEntityViaReflection(entity);
+                        EntityUtils.consumeQuietly(entity);
                     }
                     responseBody = buffer.toByteArray();
                 } catch (OutOfMemoryError e) {

library/src/main/java/com/loopj/android/http/handlers/BinaryHttpResponseHandler.java

@@ -21,7 +21,6 @@
 import android.os.Looper;
 
 import com.loopj.android.http.AsyncHttpClient;
-import com.loopj.android.http.RequestParams;
 
 import java.io.IOException;
 import java.util.regex.Pattern;

library/src/main/java/com/loopj/android/http/handlers/DataAsyncHttpResponseHandler.java

@@ -27,8 +27,8 @@
 
 import cz.msebera.android.httpclient.HttpEntity;
 import cz.msebera.android.httpclient.util.ByteArrayBuffer;
+import cz.msebera.android.httpclient.util.EntityUtils;
 
-@SuppressWarnings("ALL")
 public abstract class DataAsyncHttpResponseHandler extends AsyncHttpResponseHandler {
     protected static final int PROGRESS_DATA_MESSAGE = 7;
     private static final String LOG_TAG = "DataAsyncHttpRH";
@@ -89,19 +89,17 @@ protected void handleMessage(Message message) {
         super.handleMessage(message);
         Object[] response;
 
-        switch (message.what) {
-            case PROGRESS_DATA_MESSAGE:
-                response = (Object[]) message.obj;
-                if (response != null && response.length >= 1) {
-                    try {
-                        onProgressData((byte[]) response[0]);
-                    } catch (Throwable t) {
-                        AsyncHttpClient.log.e(LOG_TAG, "custom onProgressData contains an error", t);
-                    }
-                } else {
-                    AsyncHttpClient.log.e(LOG_TAG, "PROGRESS_DATA_MESSAGE didn't got enough params");
+        if (message.what == PROGRESS_DATA_MESSAGE) {
+            response = (Object[]) message.obj;
+            if (response != null && response.length >= 1) {
+                try {
+                    onProgressData((byte[]) response[0]);
+                } catch (Throwable t) {
+                    AsyncHttpClient.log.e(LOG_TAG, "custom onProgressData contains an error", t);
                 }
-                break;
+            } else {
+                AsyncHttpClient.log.e(LOG_TAG, "PROGRESS_DATA_MESSAGE didn't got enough params");
+            }
         }
     }
 
@@ -138,7 +136,7 @@ byte[] getResponseData(HttpEntity entity) throws IOException {
                             sendProgressMessage(count, contentLength);
                         }
                     } finally {
-//                        AsyncHttpClient.silentCloseInputStream(instream);
+                        EntityUtils.consumeQuietly(entity);
                     }
                     responseBody = buffer.toByteArray();
                 } catch (OutOfMemoryError e) {

library/src/main/java/com/loopj/android/http/handlers/FileAsyncHttpResponseHandler.java

@@ -30,6 +30,7 @@
 
 import cz.msebera.android.httpclient.Header;
 import cz.msebera.android.httpclient.HttpEntity;
+import cz.msebera.android.httpclient.util.EntityUtils;
 
 public abstract class FileAsyncHttpResponseHandler extends AsyncHttpResponseHandler {
 
@@ -165,14 +166,14 @@ protected File getTargetFileByParsingURL() {
         Utils.asserts(getOriginalFile().isDirectory(), "Target file is not a directory, cannot proceed");
         Utils.asserts(getRequestURI() != null, "RequestURI is null, cannot proceed");
         String requestURL = getRequestURI().toString();
-        String filename = requestURL.substring(requestURL.lastIndexOf('/') + 1, requestURL.length());
+        String filename = requestURL.substring(requestURL.lastIndexOf('/') + 1);
         File targetFileRtn = new File(getOriginalFile(), filename);
         if (targetFileRtn.exists() && renameIfExists) {
             String format;
             if (!filename.contains(".")) {
                 format = filename + " (%d)";
             } else {
-                format = filename.substring(0, filename.lastIndexOf('.')) + " (%d)" + filename.substring(filename.lastIndexOf('.'), filename.length());
+                format = filename.substring(0, filename.lastIndexOf('.')) + " (%d)" + filename.substring(filename.lastIndexOf('.'));
             }
             int index = 0;
             while (true) {
@@ -232,9 +233,8 @@ protected byte[] getResponseData(HttpEntity entity) throws IOException {
                         sendProgressMessage(count, contentLength);
                     }
                 } finally {
-//                    AsyncHttpClient.silentCloseInputStream(instream);
                     buffer.flush();
-//                    AsyncHttpClient.silentCloseOutputStream(buffer);
+                    EntityUtils.consumeQuietly(entity);
                 }
             }
         }

library/src/main/java/com/loopj/android/http/handlers/SaxAsyncHttpResponseHandler.java

@@ -35,6 +35,7 @@
 
 import cz.msebera.android.httpclient.Header;
 import cz.msebera.android.httpclient.HttpEntity;
+import cz.msebera.android.httpclient.util.EntityUtils;
 
 /**
  * Provides interface to deserialize SAX responses, using AsyncHttpResponseHandler. Can be used like
@@ -65,7 +66,7 @@ public abstract class SaxAsyncHttpResponseHandler<T extends DefaultHandler> exte
     /**
      * Generic Type of handler
      */
-    private T handler = null;
+    private T handler;
 
     /**
      * Constructs new SaxAsyncHttpResponseHandler with given handler instance
@@ -107,12 +108,12 @@ protected byte[] getResponseData(HttpEntity entity) throws IOException {
                 } catch (ParserConfigurationException e) {
                     AsyncHttpClient.log.e(LOG_TAG, "getResponseData exception", e);
                 } finally {
-//                    AsyncHttpClient.silentCloseInputStream(instream);
                     if (inputStreamReader != null) {
                         try {
                             inputStreamReader.close();
                         } catch (IOException e) { /*ignore*/ }
                     }
+                    EntityUtils.consumeQuietly(entity);
                 }
             }
         }

library/src/main/java/com/loopj/android/http/interfaces/AsyncHttpClientInterface.java

@@ -33,6 +33,7 @@ public interface AsyncHttpClientInterface {
     ExecutorService getThreadPool();
 
     RequestHandle sendRequest(CloseableHttpClient httpClient, HttpUriRequest request, ResponseHandlerInterface responseHandler);
+
     RequestHandle sendRequest(RequestInterface request, ResponseHandlerInterface responseHandler);
 
     boolean isLoggingEnabled();

library/src/main/java/com/loopj/android/http/interfaces/RequestParamInterface.java

@@ -20,7 +20,9 @@
 public interface RequestParamInterface<T> {
 
     String getName();
+
     T getValue();
+
     ContentType getContentType();
 
 }

library/src/main/java/com/loopj/android/http/interfaces/ResponseInterface.java

@@ -20,9 +20,13 @@
 public interface ResponseInterface<T> {
 
     boolean isSuccess();
+
     int getStatusCode();
+
     Header[] getHeaders();
+
     T getResponse();
+
     Throwable getThrowable();
 
 }