Use final where possible.

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

Author: garydgregory

src/main/java/org/apache/commons/io/ByteOrderMark.java

@@ -66,7 +66,7 @@ public class ByteOrderMark implements Serializable {
      * @throws IllegalArgumentException if the bytes are null or zero
      * length
      */
-    public ByteOrderMark(String charsetName, int... bytes) {
+    public ByteOrderMark(final String charsetName, final int... bytes) {
         if (charsetName == null || charsetName.length() == 0) {
             throw new IllegalArgumentException("No charsetName specified");
         }
@@ -102,7 +102,7 @@ public int length() {
      * @param pos The position
      * @return The specified byte
      */
-    public int get(int pos) {
+    public int get(final int pos) {
         return bytes[pos];
     }
 
@@ -112,7 +112,7 @@ public int get(int pos) {
      * @return a copy of the BOM's bytes
      */
     public byte[] getBytes() {
-        byte[] copy = new byte[bytes.length];
+        final byte[] copy = new byte[bytes.length];
         for (int i = 0; i < bytes.length; i++) {
             copy[i] = (byte)bytes[i];
         }
@@ -127,11 +127,11 @@ public byte[] getBytes() {
      * false
      */
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(final Object obj) {
         if (!(obj instanceof ByteOrderMark)) {
             return false;
         }
-        ByteOrderMark bom = (ByteOrderMark)obj;
+        final ByteOrderMark bom = (ByteOrderMark)obj;
         if (bytes.length != bom.length()) {
             return false;
         }
@@ -152,7 +152,7 @@ public boolean equals(Object obj) {
     @Override
     public int hashCode() {
         int hashCode = getClass().hashCode();
-        for (int b : bytes) {
+        for (final int b : bytes) {
             hashCode += b;
         }
         return hashCode;
@@ -165,7 +165,7 @@ public int hashCode() {
      */
     @Override
     public String toString() {
-        StringBuilder builder = new StringBuilder();
+        final StringBuilder builder = new StringBuilder();
         builder.append(getClass().getSimpleName());
         builder.append('[');
         builder.append(charsetName);

src/main/java/org/apache/commons/io/Charsets.java

@@ -73,7 +73,7 @@ public class Charsets {
      */
     public static SortedMap<String, Charset> requiredCharsets() {
         // maybe cache?
-        TreeMap<String, Charset> m = new TreeMap<String, Charset>(String.CASE_INSENSITIVE_ORDER);
+        final TreeMap<String, Charset> m = new TreeMap<String, Charset>(String.CASE_INSENSITIVE_ORDER);
         m.put(ISO_8859_1.name(), ISO_8859_1);
         m.put(US_ASCII.name(), US_ASCII);
         m.put(UTF_16.name(), UTF_16);
@@ -90,7 +90,7 @@ public static SortedMap<String, Charset> requiredCharsets() {
      *            A charset or null.
      * @return the given Charset or the default Charset if the given Charset is null
      */
-    public static Charset toCharset(Charset charset) {
+    public static Charset toCharset(final Charset charset) {
         return charset == null ? Charset.defaultCharset() : charset;
     }
 
@@ -103,7 +103,7 @@ public static Charset toCharset(Charset charset) {
      * @throws UnsupportedCharsetException
      *             If the named charset is unavailable
      */
-    public static Charset toCharset(String charset) {
+    public static Charset toCharset(final String charset) {
         return charset == null ? Charset.defaultCharset() : Charset.forName(charset);
     }
 

src/main/java/org/apache/commons/io/CopyUtils.java

@@ -131,7 +131,7 @@ public CopyUtils() { }
      * @param output the <code>OutputStream</code> to write to
      * @throws IOException In case of an I/O problem
      */
-    public static void copy(byte[] input, OutputStream output)
+    public static void copy(final byte[] input, final OutputStream output)
             throws IOException {
         output.write(input);
     }
@@ -148,9 +148,9 @@ public static void copy(byte[] input, OutputStream output)
      * @param output the <code>Writer</code> to write to
      * @throws IOException In case of an I/O problem
      */
-    public static void copy(byte[] input, Writer output)
+    public static void copy(final byte[] input, final Writer output)
             throws IOException {
-        ByteArrayInputStream in = new ByteArrayInputStream(input);
+        final ByteArrayInputStream in = new ByteArrayInputStream(input);
         copy(in, output);
     }
 
@@ -166,11 +166,11 @@ public static void copy(byte[] input, Writer output)
      * @throws IOException In case of an I/O problem
      */
     public static void copy(
-            byte[] input,
-            Writer output,
-            String encoding)
+            final byte[] input,
+            final Writer output,
+            final String encoding)
                 throws IOException {
-        ByteArrayInputStream in = new ByteArrayInputStream(input);
+        final ByteArrayInputStream in = new ByteArrayInputStream(input);
         copy(in, output, encoding);
     }
 
@@ -188,10 +188,10 @@ public static void copy(
      * @throws IOException In case of an I/O problem
      */
     public static int copy(
-            InputStream input,
-            OutputStream output)
+            final InputStream input,
+            final OutputStream output)
                 throws IOException {
-        byte[] buffer = new byte[DEFAULT_BUFFER_SIZE];
+        final byte[] buffer = new byte[DEFAULT_BUFFER_SIZE];
         int count = 0;
         int n = 0;
         while (-1 != (n = input.read(buffer))) {
@@ -213,10 +213,10 @@ public static int copy(
      * @throws IOException In case of an I/O problem
      */
     public static int copy(
-            Reader input,
-            Writer output)
+            final Reader input,
+            final Writer output)
                 throws IOException {
-        char[] buffer = new char[DEFAULT_BUFFER_SIZE];
+        final char[] buffer = new char[DEFAULT_BUFFER_SIZE];
         int count = 0;
         int n = 0;
         while (-1 != (n = input.read(buffer))) {
@@ -239,10 +239,10 @@ public static int copy(
      * @throws IOException In case of an I/O problem
      */
     public static void copy(
-            InputStream input,
-            Writer output)
+            final InputStream input,
+            final Writer output)
                 throws IOException {
-        InputStreamReader in = new InputStreamReader(input);
+        final InputStreamReader in = new InputStreamReader(input);
         copy(in, output);
     }
 
@@ -257,11 +257,11 @@ public static void copy(
      * @throws IOException In case of an I/O problem
      */
     public static void copy(
-            InputStream input,
-            Writer output,
-            String encoding)
+            final InputStream input,
+            final Writer output,
+            final String encoding)
                 throws IOException {
-        InputStreamReader in = new InputStreamReader(input, encoding);
+        final InputStreamReader in = new InputStreamReader(input, encoding);
         copy(in, output);
     }
 
@@ -278,10 +278,10 @@ public static void copy(
      * @throws IOException In case of an I/O problem
      */
     public static void copy(
-            Reader input,
-            OutputStream output)
+            final Reader input,
+            final OutputStream output)
                 throws IOException {
-        OutputStreamWriter out = new OutputStreamWriter(output);
+        final OutputStreamWriter out = new OutputStreamWriter(output);
         copy(input, out);
         // XXX Unless anyone is planning on rewriting OutputStreamWriter, we
         // have to flush here.
@@ -301,11 +301,11 @@ public static void copy(
      * @throws IOException In case of an I/O problem
      */
     public static void copy(
-            String input,
-            OutputStream output)
+            final String input,
+            final OutputStream output)
                 throws IOException {
-        StringReader in = new StringReader(input);
-        OutputStreamWriter out = new OutputStreamWriter(output);
+        final StringReader in = new StringReader(input);
+        final OutputStreamWriter out = new OutputStreamWriter(output);
         copy(in, out);
         // XXX Unless anyone is planning on rewriting OutputStreamWriter, we
         // have to flush here.
@@ -322,7 +322,7 @@ public static void copy(
      * @param output the <code>Writer</code> to write to
      * @throws IOException In case of an I/O problem
      */
-    public static void copy(String input, Writer output)
+    public static void copy(final String input, final Writer output)
                 throws IOException {
         output.write(input);
     }

src/main/java/org/apache/commons/io/DirectoryWalker.java

@@ -278,7 +278,7 @@ protected DirectoryWalker() {
      * @param depthLimit  controls how <i>deep</i> the hierarchy is
      *  navigated to (less than 0 means unlimited)
      */
-    protected DirectoryWalker(FileFilter filter, int depthLimit) {
+    protected DirectoryWalker(final FileFilter filter, final int depthLimit) {
         this.filter = filter;
         this.depthLimit = depthLimit;
     }
@@ -297,7 +297,7 @@ protected DirectoryWalker(FileFilter filter, int depthLimit) {
      * @param depthLimit  controls how <i>deep</i> the hierarchy is
      *  navigated to (less than 0 means unlimited)
      */
-    protected DirectoryWalker(IOFileFilter directoryFilter, IOFileFilter fileFilter, int depthLimit) {
+    protected DirectoryWalker(IOFileFilter directoryFilter, IOFileFilter fileFilter, final int depthLimit) {
         if (directoryFilter == null && fileFilter == null) {
             this.filter = null;
         } else {
@@ -326,15 +326,15 @@ protected DirectoryWalker(IOFileFilter directoryFilter, IOFileFilter fileFilter,
      * @throws NullPointerException if the start directory is null
      * @throws IOException if an I/O Error occurs
      */
-    protected final void walk(File startDirectory, Collection<T> results) throws IOException {
+    protected final void walk(final File startDirectory, final Collection<T> results) throws IOException {
         if (startDirectory == null) {
             throw new NullPointerException("Start Directory is null");
         }
         try {
             handleStart(startDirectory, results);
             walk(startDirectory, 0, results);
             handleEnd(results);
-        } catch(CancelException cancel) {
+        } catch(final CancelException cancel) {
             handleCancelled(startDirectory, results, cancel);
         }
     }
@@ -347,19 +347,19 @@ protected final void walk(File startDirectory, Collection<T> results) throws IOE
      * @param results  the collection of result objects, may be updated
      * @throws IOException if an I/O Error occurs
      */
-    private void walk(File directory, int depth, Collection<T> results) throws IOException {
+    private void walk(final File directory, final int depth, final Collection<T> results) throws IOException {
         checkIfCancelled(directory, depth, results);
         if (handleDirectory(directory, depth, results)) {
             handleDirectoryStart(directory, depth, results);
-            int childDepth = depth + 1;
+            final int childDepth = depth + 1;
             if (depthLimit < 0 || childDepth <= depthLimit) {
                 checkIfCancelled(directory, depth, results);
                 File[] childFiles = filter == null ? directory.listFiles() : directory.listFiles(filter);
                 childFiles = filterDirectoryContents(directory, depth, childFiles);
                 if (childFiles == null) {
                     handleRestricted(directory, childDepth, results);
                 } else {
-                    for (File childFile : childFiles) {
+                    for (final File childFile : childFiles) {
                         if (childFile.isDirectory()) {
                             walk(childFile, childDepth, results);
                         } else {
@@ -390,7 +390,7 @@ private void walk(File directory, int depth, Collection<T> results) throws IOExc
      * @param results  the collection of result objects, may be updated
      * @throws IOException if an I/O Error occurs
      */
-    protected final void checkIfCancelled(File file, int depth, Collection<T> results) throws IOException {
+    protected final void checkIfCancelled(final File file, final int depth, final Collection<T> results) throws IOException {
         if (handleIsCancelled(file, depth, results)) {
             throw new CancelException(file, depth);
         }
@@ -432,7 +432,7 @@ protected final void checkIfCancelled(File file, int depth, Collection<T> result
      * @throws IOException if an I/O Error occurs
      */
     protected boolean handleIsCancelled(
-            File file, int depth, Collection<T> results) throws IOException {
+            final File file, final int depth, final Collection<T> results) throws IOException {
         // do nothing - overridable by subclass
         return false;  // not cancelled
     }
@@ -450,8 +450,8 @@ protected boolean handleIsCancelled(
      * containing details at the point of cancellation. 
      * @throws IOException if an I/O Error occurs
      */
-    protected void handleCancelled(File startDirectory, Collection<T> results,
-                       CancelException cancel) throws IOException {
+    protected void handleCancelled(final File startDirectory, final Collection<T> results,
+                       final CancelException cancel) throws IOException {
         // re-throw exception - overridable by subclass
         throw cancel;
     }
@@ -466,7 +466,7 @@ protected void handleCancelled(File startDirectory, Collection<T> results,
      * @param results  the collection of result objects, may be updated
      * @throws IOException if an I/O Error occurs
      */
-    protected void handleStart(File startDirectory, Collection<T> results) throws IOException {
+    protected void handleStart(final File startDirectory, final Collection<T> results) throws IOException {
         // do nothing - overridable by subclass
     }
 
@@ -485,7 +485,7 @@ protected void handleStart(File startDirectory, Collection<T> results) throws IO
      * @return true to process this directory, false to skip this directory
      * @throws IOException if an I/O Error occurs
      */
-    protected boolean handleDirectory(File directory, int depth, Collection<T> results) throws IOException {
+    protected boolean handleDirectory(final File directory, final int depth, final Collection<T> results) throws IOException {
         // do nothing - overridable by subclass
         return true;  // process directory
     }
@@ -500,7 +500,7 @@ protected boolean handleDirectory(File directory, int depth, Collection<T> resul
      * @param results  the collection of result objects, may be updated
      * @throws IOException if an I/O Error occurs
      */
-    protected void handleDirectoryStart(File directory, int depth, Collection<T> results) throws IOException {
+    protected void handleDirectoryStart(final File directory, final int depth, final Collection<T> results) throws IOException {
         // do nothing - overridable by subclass
     }
 
@@ -516,7 +516,7 @@ protected void handleDirectoryStart(File directory, int depth, Collection<T> res
      * @throws IOException if an I/O Error occurs
      * @since 2.0
      */
-    protected File[] filterDirectoryContents(File directory, int depth, File[] files) throws IOException {
+    protected File[] filterDirectoryContents(final File directory, final int depth, final File[] files) throws IOException {
         return files;
     }
 
@@ -530,7 +530,7 @@ protected File[] filterDirectoryContents(File directory, int depth, File[] files
      * @param results  the collection of result objects, may be updated
      * @throws IOException if an I/O Error occurs
      */
-    protected void handleFile(File file, int depth, Collection<T> results) throws IOException {
+    protected void handleFile(final File file, final int depth, final Collection<T> results) throws IOException {
         // do nothing - overridable by subclass
     }
 
@@ -544,7 +544,7 @@ protected void handleFile(File file, int depth, Collection<T> results) throws IO
      * @param results  the collection of result objects, may be updated
      * @throws IOException if an I/O Error occurs
      */
-    protected void handleRestricted(File directory, int depth, Collection<T> results) throws IOException  {
+    protected void handleRestricted(final File directory, final int depth, final Collection<T> results) throws IOException  {
         // do nothing - overridable by subclass
     }
 
@@ -558,7 +558,7 @@ protected void handleRestricted(File directory, int depth, Collection<T> results
      * @param results  the collection of result objects, may be updated
      * @throws IOException if an I/O Error occurs
      */
-    protected void handleDirectoryEnd(File directory, int depth, Collection<T> results) throws IOException {
+    protected void handleDirectoryEnd(final File directory, final int depth, final Collection<T> results) throws IOException {
         // do nothing - overridable by subclass
     }
 
@@ -570,7 +570,7 @@ protected void handleDirectoryEnd(File directory, int depth, Collection<T> resul
      * @param results  the collection of result objects, may be updated
      * @throws IOException if an I/O Error occurs
      */
-    protected void handleEnd(Collection<T> results) throws IOException {
+    protected void handleEnd(final Collection<T> results) throws IOException {
         // do nothing - overridable by subclass
     }
 
@@ -596,7 +596,7 @@ public static class CancelException extends IOException {
          * @param file  the file when the operation was cancelled, may be null
          * @param depth  the depth when the operation was cancelled, may be null
          */
-        public CancelException(File file, int depth) {
+        public CancelException(final File file, final int depth) {
             this("Operation Cancelled", file, depth);
         }
 
@@ -609,7 +609,7 @@ public CancelException(File file, int depth) {
          * @param file  the file when the operation was cancelled
          * @param depth  the depth when the operation was cancelled
          */
-        public CancelException(String message, File file, int depth) {
+        public CancelException(final String message, final File file, final int depth) {
             super(message);
             this.file = file;
             this.depth = depth;