Use final keyword where possible.

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

Author: garydgregory

src/main/java/org/apache/commons/csv/CSVFormat.java

@@ -155,8 +155,8 @@ public class CSVFormat implements Serializable {
      * @param header
      *            the header
      */
-    CSVFormat(char delimiter, char encapsulator, char commentStart, char escape, boolean surroundingSpacesIgnored,
-            boolean emptyLinesIgnored, String lineSeparator, String[] header) {
+    CSVFormat(final char delimiter, final char encapsulator, final char commentStart, final char escape, final boolean surroundingSpacesIgnored,
+            final boolean emptyLinesIgnored, final String lineSeparator, final String[] header) {
         this.delimiter = delimiter;
         this.encapsulator = encapsulator;
         this.commentStart = commentStart;
@@ -178,7 +178,7 @@ public class CSVFormat implements Serializable {
      *
      * @return true if <code>c</code> is a line break character
      */
-    private static boolean isLineBreak(char c) {
+    private static boolean isLineBreak(final char c) {
         return c == '\n' || c == '\r';
     }
 
@@ -230,7 +230,7 @@ public char getDelimiter() {
      * @throws IllegalArgumentException
      *             thrown if the specified character is a line break
      */
-    public CSVFormat withDelimiter(char delimiter) {
+    public CSVFormat withDelimiter(final char delimiter) {
         if (isLineBreak(delimiter)) {
             throw new IllegalArgumentException("The delimiter cannot be a line break");
         }
@@ -256,7 +256,7 @@ public char getEncapsulator() {
      * @throws IllegalArgumentException
      *             thrown if the specified character is a line break
      */
-    public CSVFormat withEncapsulator(char encapsulator) {
+    public CSVFormat withEncapsulator(final char encapsulator) {
         if (isLineBreak(encapsulator)) {
             throw new IllegalArgumentException("The encapsulator cannot be a line break");
         }
@@ -293,7 +293,7 @@ public char getCommentStart() {
      * @throws IllegalArgumentException
      *             thrown if the specified character is a line break
      */
-    public CSVFormat withCommentStart(char commentStart) {
+    public CSVFormat withCommentStart(final char commentStart) {
         if (isLineBreak(commentStart)) {
             throw new IllegalArgumentException("The comment start character cannot be a line break");
         }
@@ -330,7 +330,7 @@ public char getEscape() {
      * @throws IllegalArgumentException
      *             thrown if the specified character is a line break
      */
-    public CSVFormat withEscape(char escape) {
+    public CSVFormat withEscape(final char escape) {
         if (isLineBreak(escape)) {
             throw new IllegalArgumentException("The escape character cannot be a line break");
         }
@@ -365,7 +365,7 @@ public boolean getIgnoreSurroundingSpaces() {
      *            spaces as is.
      * @return A copy of this format with the specified trimming behavior.
      */
-    public CSVFormat withIgnoreSurroundingSpaces(boolean ignoreSurroundingSpaces) {
+    public CSVFormat withIgnoreSurroundingSpaces(final boolean ignoreSurroundingSpaces) {
         return new CSVFormat(delimiter, encapsulator, commentStart, escape, ignoreSurroundingSpaces,
                 ignoreEmptyLines, lineSeparator, header);
     }
@@ -388,7 +388,7 @@ public boolean getIgnoreEmptyLines() {
      *            <tt>false</tt> to translate empty lines to empty records.
      * @return A copy of this format with the specified empty line skipping behavior.
      */
-    public CSVFormat withIgnoreEmptyLines(boolean ignoreEmptyLines) {
+    public CSVFormat withIgnoreEmptyLines(final boolean ignoreEmptyLines) {
         return new CSVFormat(delimiter, encapsulator, commentStart, escape, ignoreSurroundingSpaces,
                 ignoreEmptyLines, lineSeparator, header);
     }
@@ -410,7 +410,7 @@ public String getLineSeparator() {
      *
      * @return A copy of this format using the specified output line separator
      */
-    public CSVFormat withLineSeparator(String lineSeparator) {
+    public CSVFormat withLineSeparator(final String lineSeparator) {
         return new CSVFormat(delimiter, encapsulator, commentStart, escape, ignoreSurroundingSpaces,
                 ignoreEmptyLines, lineSeparator, header);
     }
@@ -438,7 +438,7 @@ String[] getHeader() {
      *
      * @return A copy of this format using the specified header
      */
-    public CSVFormat withHeader(String... header) {
+    public CSVFormat withHeader(final String... header) {
         return new CSVFormat(delimiter, encapsulator, commentStart, escape, ignoreSurroundingSpaces,
                 ignoreEmptyLines, lineSeparator, header);
     }
@@ -449,7 +449,7 @@ public CSVFormat withHeader(String... header) {
      * @param in
      *            the input stream
      */
-    public Iterable<CSVRecord> parse(Reader in) throws IOException {
+    public Iterable<CSVRecord> parse(final Reader in) throws IOException {
         return new CSVParser(in, this);
     }
 
@@ -459,20 +459,20 @@ public Iterable<CSVRecord> parse(Reader in) throws IOException {
      * @param values
      *            the values to format
      */
-    public String format(String... values) {
-        StringWriter out = new StringWriter();
+    public String format(final String... values) {
+        final StringWriter out = new StringWriter();
         try {
             new CSVPrinter(out, this).println(values);
             return out.toString().trim();
-        } catch (IOException e) {
+        } catch (final IOException e) {
             // should not happen
             throw new IllegalStateException(e);
         }
     }
 
     @Override
     public String toString() {
-        StringBuilder sb = new StringBuilder();
+        final StringBuilder sb = new StringBuilder();
         sb.append("Delimiter=<").append(delimiter).append('>');
         if (isEscaping()) {
             sb.append(' ');

src/main/java/org/apache/commons/csv/CSVLexer.java

@@ -28,7 +28,7 @@
 class CSVLexer extends Lexer {
 
     // ctor needs to be public so can be called dynamically by PerformanceTest class
-    public CSVLexer(CSVFormat format, ExtendedBufferedReader in) {
+    public CSVLexer(final CSVFormat format, final ExtendedBufferedReader in) {
         super(format, in);
     }
 
@@ -44,7 +44,7 @@ public CSVLexer(CSVFormat format, ExtendedBufferedReader in) {
      *             on stream access error
      */
     @Override
-    Token nextToken(Token token) throws IOException {
+    Token nextToken(final Token token) throws IOException {
 
         // get the last read char (required for empty line detection)
         int lastChar = in.readAgain();
@@ -81,7 +81,7 @@ Token nextToken(Token token) throws IOException {
         }
 
         if (isStartOfLine(lastChar) && isCommentStart(c)) {
-            String comment = in.readLine().trim();
+            final String comment = in.readLine().trim();
             token.content.append(comment);
             token.type = COMMENT;
             return token;
@@ -141,7 +141,7 @@ Token nextToken(Token token) throws IOException {
      * @throws IOException
      *             on stream access error
      */
-    private Token simpleTokenLexer(Token tkn, int c) throws IOException {
+    private Token simpleTokenLexer(final Token tkn, int c) throws IOException {
         // Faster to use while(true)+break than while(tkn.type == INVALID)
         while (true) {
             if (isEndOfLine(c)) {
@@ -190,9 +190,9 @@ private Token simpleTokenLexer(Token tkn, int c) throws IOException {
      * @throws IOException
      *             on invalid state: EOF before closing encapsulator or invalid character before delimiter or EOL
      */
-    private Token encapsulatedTokenLexer(Token tkn) throws IOException {
+    private Token encapsulatedTokenLexer(final Token tkn) throws IOException {
         // save current line number in case needed for IOE
-        int startLineNumber = getLineNumber();
+        final int startLineNumber = getLineNumber();
         int c;
         while (true) {
             c = in.read();

src/main/java/org/apache/commons/csv/CSVParser.java

@@ -85,7 +85,7 @@ public class CSVParser implements Iterable<CSVRecord> {
      * @throws IllegalArgumentException
      *             thrown if the parameters of the format are inconsistent
      */
-    public CSVParser(Reader input) throws IOException {
+    public CSVParser(final Reader input) throws IOException {
         this(input, CSVFormat.DEFAULT);
     }
 
@@ -99,7 +99,7 @@ public CSVParser(Reader input) throws IOException {
      * @throws IllegalArgumentException
      *             thrown if the parameters of the format are inconsistent
      */
-    public CSVParser(Reader input, CSVFormat format) throws IOException {
+    public CSVParser(final Reader input, final CSVFormat format) throws IOException {
         format.validate();
 
         this.lexer = new CSVLexer(format, new ExtendedBufferedReader(input));
@@ -117,7 +117,7 @@ public CSVParser(Reader input, CSVFormat format) throws IOException {
      * @throws IllegalArgumentException
      *             thrown if the parameters of the format are inconsistent
      */
-    public CSVParser(String input, CSVFormat format) throws IOException {
+    public CSVParser(final String input, final CSVFormat format) throws IOException {
         this(new StringReader(input), format);
     }
 
@@ -204,7 +204,7 @@ CSVRecord getRecord() throws IOException {
      *             on parse error or input read-failure
      */
     public List<CSVRecord> getRecords() throws IOException {
-        List<CSVRecord> records = new ArrayList<CSVRecord>();
+        final List<CSVRecord> records = new ArrayList<CSVRecord>();
         CSVRecord rec;
         while ((rec = getRecord()) != null) {
             records.add(rec);
@@ -215,15 +215,15 @@ public List<CSVRecord> getRecords() throws IOException {
     /**
      * Initializes the name to index mapping if the format defines a header.
      */
-    private Map<String, Integer> initializeHeader(CSVFormat format) throws IOException {
+    private Map<String, Integer> initializeHeader(final CSVFormat format) throws IOException {
         Map<String, Integer> hdrMap = null;
         if (format.getHeader() != null) {
             hdrMap = new LinkedHashMap<String, Integer>();
 
             String[] header = null;
             if (format.getHeader().length == 0) {
                 // read the header from the first line of the file
-                CSVRecord rec = getRecord();
+                final CSVRecord rec = getRecord();
                 if (rec != null) {
                     header = rec.values();
                 }
@@ -252,7 +252,7 @@ public Iterator<CSVRecord> iterator() {
             private CSVRecord getNextRecord() {
                 try {
                     return getRecord();
-                } catch (IOException e) {
+                } catch (final IOException e) {
                     throw new RuntimeException(e);
                 }
             }

src/main/java/org/apache/commons/csv/CSVPrinter.java

@@ -45,7 +45,7 @@ public class CSVPrinter {
      * @throws IllegalArgumentException
      *             thrown if the parameters of the format are inconsistent
      */
-    public CSVPrinter(Appendable out, CSVFormat format) {
+    public CSVPrinter(final Appendable out, final CSVFormat format) {
         this.out = out;
         this.format = format == null ? CSVFormat.DEFAULT : format;
         this.format.validate();
@@ -81,8 +81,8 @@ public void flush() throws IOException {
      * @param values
      *            values to be outputted.
      */
-    public void println(String... values) throws IOException {
-        for (String value : values) {
+    public void println(final String... values) throws IOException {
+        for (final String value : values) {
             print(value);
         }
         println();
@@ -98,7 +98,7 @@ public void println(String... values) throws IOException {
      * @param comment
      *            the comment to output
      */
-    public void printComment(String comment) throws IOException {
+    public void printComment(final String comment) throws IOException {
         if (!format.isCommentingEnabled()) {
             return;
         }
@@ -108,7 +108,7 @@ public void printComment(String comment) throws IOException {
         out.append(format.getCommentStart());
         out.append(' ');
         for (int i = 0; i < comment.length(); i++) {
-            char c = comment.charAt(i);
+            final char c = comment.charAt(i);
             switch (c) {
             case '\r':
                 if (i + 1 < comment.length() && comment.charAt(i + 1) == '\n') {
@@ -128,7 +128,7 @@ public void printComment(String comment) throws IOException {
         println();
     }
 
-    private void print(CharSequence value, int offset, int len) throws IOException {
+    private void print(final CharSequence value, final int offset, final int len) throws IOException {
         if (format.isEncapsulating()) {
             printAndEncapsulate(value, offset, len);
         } else if (format.isEscaping()) {
@@ -147,15 +147,15 @@ void printSep() throws IOException {
         }
     }
 
-    void printAndEscape(CharSequence value, int offset, int len) throws IOException {
+    void printAndEscape(final CharSequence value, final int offset, final int len) throws IOException {
         int start = offset;
         int pos = offset;
-        int end = offset + len;
+        final int end = offset + len;
 
         printSep();
 
-        char delim = format.getDelimiter();
-        char escape = format.getEscape();
+        final char delim = format.getDelimiter();
+        final char escape = format.getEscape();
 
         while (pos < end) {
             char c = value.charAt(pos);
@@ -185,17 +185,17 @@ void printAndEscape(CharSequence value, int offset, int len) throws IOException
         }
     }
 
-    void printAndEncapsulate(CharSequence value, int offset, int len) throws IOException {
-        boolean first = newLine; // is this the first value on this line?
+    void printAndEncapsulate(final CharSequence value, final int offset, final int len) throws IOException {
+        final boolean first = newLine; // is this the first value on this line?
         boolean quote = false;
         int start = offset;
         int pos = offset;
-        int end = offset + len;
+        final int end = offset + len;
 
         printSep();
 
-        char delim = format.getDelimiter();
-        char encapsulator = format.getEncapsulator();
+        final char delim = format.getDelimiter();
+        final char encapsulator = format.getEncapsulator();
 
         if (len <= 0) {
             // always quote an empty token that is the first
@@ -252,7 +252,7 @@ void printAndEncapsulate(CharSequence value, int offset, int len) throws IOExcep
         // Pick up where we left off: pos should be positioned on the first character that caused
         // the need for encapsulation.
         while (pos < end) {
-            char c = value.charAt(pos);
+            final char c = value.charAt(pos);
             if (c == encapsulator) {
                 // write out the chunk up until this point
 
@@ -277,7 +277,7 @@ void printAndEncapsulate(CharSequence value, int offset, int len) throws IOExcep
      * @param value
      *            value to be outputted.
      */
-    public void print(String value, boolean checkForEscape) throws IOException {
+    public void print(String value, final boolean checkForEscape) throws IOException {
         if (value == null) {
             // null values are considered empty
             value = "";
@@ -298,7 +298,7 @@ public void print(String value, boolean checkForEscape) throws IOException {
      * @param value
      *            value to be outputted.
      */
-    public void print(String value) throws IOException {
+    public void print(final String value) throws IOException {
         print(value, true);
     }
 }

src/main/java/org/apache/commons/csv/CSVRecord.java

@@ -40,7 +40,7 @@ public class CSVRecord implements Serializable, Iterable<String> {
     /** The accumulated comments (if any) */
     private final String comment;
 
-    CSVRecord(String[] values, Map<String, Integer> mapping, String comment) {
+    CSVRecord(final String[] values, final Map<String, Integer> mapping, final String comment) {
         this.values = values != null ? values : EMPTY_STRING_ARRAY;
         this.mapping = mapping;
         this.comment = comment;
@@ -52,7 +52,7 @@ public class CSVRecord implements Serializable, Iterable<String> {
      * @param i
      *            the index of the column retrieved
      */
-    public String get(int i) {
+    public String get(final int i) {
         return values[i];
     }
 
@@ -65,12 +65,12 @@ public String get(int i) {
      * @throws IllegalStateException
      *             if no header mapping was provided
      */
-    public String get(String name) {
+    public String get(final String name) {
         if (mapping == null) {
             throw new IllegalStateException("No header mapping was specified, the record values can't be accessed by name");
         }
 
-        Integer index = mapping.get(name);
+        final Integer index = mapping.get(name);
 
         return index != null ? values[index.intValue()] : null;
     }
@@ -82,7 +82,7 @@ public String get(String name) {
      *            the name of the column to be retrieved.
      * @return whether a given columns is mapped.
      */
-    public boolean isMapped(String name) {
+    public boolean isMapped(final String name) {
         return mapping != null ? mapping.containsKey(name) : false;
     }