Better inline comments

Author: garydgregory

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

@@ -1479,7 +1479,7 @@ private static boolean isLineBreak(final char c) {
      * @return true if {@code c} is a line break character (and not null).
      */
     private static boolean isLineBreak(final Character c) {
-        return c != null && isLineBreak(c.charValue()); // Explicit (un)boxing is intentional
+        return c != null && isLineBreak(c.charValue()); // Explicit unboxing is intentional
     }
 
     /** Same test as in as {@link String#trim()}. */
@@ -1700,7 +1700,7 @@ public boolean equals(final Object obj) {
     }
 
     private void escape(final char c, final Appendable appendable) throws IOException {
-        append(escapeCharacter.charValue(), appendable); // Explicit (un)boxing is intentional
+        append(escapeCharacter.charValue(), appendable); // Explicit unboxing is intentional
         append(c, appendable);
     }
 
@@ -1838,7 +1838,7 @@ public DuplicateHeaderMode getDuplicateHeaderMode() {
      * @return the escape character, may be {@code 0}
      */
     char getEscapeChar() {
-        return escapeCharacter != null ? escapeCharacter.charValue() : 0; // Explicit (un)boxing is intentional
+        return escapeCharacter != null ? escapeCharacter.charValue() : 0; // Explicit unboxing is intentional
     }
 
     /**
@@ -2161,15 +2161,15 @@ private void print(final InputStream inputStream, final Appendable out, final bo
         }
         final boolean quoteCharacterSet = isQuoteCharacterSet();
         if (quoteCharacterSet) {
-            append(getQuoteCharacter().charValue(), out); // Explicit (un)boxing is intentional
+            append(getQuoteCharacter().charValue(), out); // Explicit unboxing is intentional
         }
         // Stream the input to the output without reading or holding the whole value in memory.
         // AppendableOutputStream cannot "close" an Appendable.
         try (OutputStream outputStream = new Base64OutputStream(new AppendableOutputStream<>(out))) {
             IOUtils.copy(inputStream, outputStream);
         }
         if (quoteCharacterSet) {
-            append(getQuoteCharacter().charValue(), out); // Explicit (un)boxing is intentional
+            append(getQuoteCharacter().charValue(), out); // Explicit unboxing is intentional
         }
     }
 
@@ -2418,7 +2418,7 @@ private void printWithQuotes(final Object object, final CharSequence charSeq, fi
         final int len = charSeq.length();
         final char[] delim = getDelimiterCharArray();
         final int delimLength = delim.length;
-        final char quoteChar = getQuoteCharacter().charValue(); // Explicit (un)boxing is intentional
+        final char quoteChar = getQuoteCharacter().charValue(); // Explicit unboxing is intentional
         // If escape char not specified, default to the quote char
         // This avoids having to keep checking whether there is an escape character
         // at the cost of checking against quote twice
@@ -2521,7 +2521,7 @@ private void printWithQuotes(final Reader reader, final Appendable appendable) t
             printWithEscapes(reader, appendable);
             return;
         }
-        final char quote = getQuoteCharacter().charValue(); // Explicit (un)boxing is intentional
+        final char quote = getQuoteCharacter().charValue(); // Explicit unboxing is intentional
         // (1) Append opening quote
         append(quote, appendable);
         // (2) Append Reader contents, doubling quotes
@@ -2607,13 +2607,13 @@ boolean useRow(final long rowNum) {
      * @throws IllegalArgumentException Throw when any attribute is invalid or inconsistent with other attributes.
      */
     private void validate() throws IllegalArgumentException {
-        if (quoteCharacter != null && contains(delimiter, quoteCharacter.charValue())) { // Explicit (un)boxing is intentional
+        if (quoteCharacter != null && contains(delimiter, quoteCharacter.charValue())) { // Explicit unboxing is intentional
             throw new IllegalArgumentException("The quoteChar character and the delimiter cannot be the same ('" + quoteCharacter + "')");
         }
-        if (escapeCharacter != null && contains(delimiter, escapeCharacter.charValue())) { // Explicit (un)boxing is intentional
+        if (escapeCharacter != null && contains(delimiter, escapeCharacter.charValue())) { // Explicit unboxing is intentional
             throw new IllegalArgumentException("The escape character and the delimiter cannot be the same ('" + escapeCharacter + "')");
         }
-        if (commentMarker != null && contains(delimiter, commentMarker.charValue())) { // Explicit (un)boxing is intentional
+        if (commentMarker != null && contains(delimiter, commentMarker.charValue())) { // Explicit unboxing is intentional
             throw new IllegalArgumentException("The comment start character and the delimiter cannot be the same ('" + commentMarker + "')");
         }
         if (quoteCharacter != null && quoteCharacter.equals(commentMarker)) {

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

@@ -650,7 +650,7 @@ private Headers createHeaders() throws IOException {
                     }
                     observedMissing |= blankHeader;
                     if (header != null) {
-                        headerMap.put(header, Integer.valueOf(i)); // Explicit (un)boxing is intentional
+                        headerMap.put(header, Integer.valueOf(i)); // Explicit boxing is intentional
                         if (headerNames == null) {
                             headerNames = new ArrayList<>(headerRecord.length);
                         }

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

@@ -235,7 +235,7 @@ public void printComment(final String comment) throws IOException {
             if (!newRecord) {
                 println();
             }
-            appendable.append(format.getCommentMarker().charValue()); // Explicit (un)boxing is intentional
+            appendable.append(format.getCommentMarker().charValue()); // Explicit unboxing is intentional
             appendable.append(SP);
             for (int i = 0; i < comment.length(); i++) {
                 final char c = comment.charAt(i);
@@ -247,7 +247,7 @@ public void printComment(final String comment) throws IOException {
                     // falls-through: break intentionally excluded.
                 case LF:
                     println();
-                    appendable.append(format.getCommentMarker().charValue()); // Explicit (un)boxing is intentional
+                    appendable.append(format.getCommentMarker().charValue()); // Explicit unboxing is intentional
                     appendable.append(SP);
                     break;
                 default:

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

@@ -132,13 +132,11 @@ public String get(final String name) {
             throw new IllegalArgumentException(String.format("Mapping for %s not found, expected one of %s", name, headerMap.keySet()));
         }
         try {
-            return values[index.intValue()]; // Explicit (un)boxing is intentional
+            return values[index.intValue()]; // Explicit unboxing is intentional
         } catch (final ArrayIndexOutOfBoundsException e) {
+            // Explicit boxing is intentional
             throw new IllegalArgumentException(
-                    String.format("Index for header '%s' is %d but CSVRecord only has %d values!", name, index, Integer.valueOf(values.length))); // Explicit
-                                                                                                                                                  // (un)boxing
-                                                                                                                                                  // is
-                                                                                                                                                  // intentional
+                    String.format("Index for header '%s' is %d but CSVRecord only has %d values!", name, index, Integer.valueOf(values.length)));
         }
     }
 
@@ -267,7 +265,7 @@ public boolean isSet(final int index) {
      * @return whether a given column is mapped and has a value.
      */
     public boolean isSet(final String name) {
-        return isMapped(name) && getHeaderMapRaw().get(name).intValue() < values.length; // Explicit (un)boxing is intentional
+        return isMapped(name) && getHeaderMapRaw().get(name).intValue() < values.length; // Explicit unboxing is intentional
     }
 
     /**

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

@@ -40,7 +40,7 @@ final class Constants {
     /** RFC 4180 defines line breaks as CRLF. */
     static final String CRLF = "\r\n";
 
-    static final Character DOUBLE_QUOTE_CHAR = Character.valueOf('"');  // Explicit (un)boxing is intentional.
+    static final Character DOUBLE_QUOTE_CHAR = Character.valueOf('"');  // Explicit boxing is intentional.
 
     static final String EMPTY = "";