Better inline comments

garydgregory · garydgregory · commit ca64eb8439b2 · 2026-06-05T07:27:06.000-04:00
diff --git a/src/main/java/org/apache/commons/csv/CSVFormat.java b/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)) {
diff --git a/src/main/java/org/apache/commons/csv/CSVParser.java b/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);
                         }
diff --git a/src/main/java/org/apache/commons/csv/CSVPrinter.java b/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:
diff --git a/src/main/java/org/apache/commons/csv/CSVRecord.java b/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
     }
 
     /**
diff --git a/src/main/java/org/apache/commons/csv/Constants.java b/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 = "";
 

Original file line number	Diff line number	Diff line change
`@@ -1479,7 +1479,7 @@ private static boolean isLineBreak(final char c) {`
`1479`	`1479`	`* @return true if {@code c} is a line break character (and not null).`
`1480`	`1480`	`*/`
`1481`	`1481`	`private static boolean isLineBreak(final Character c) {`
`1482`		`- return c != null && isLineBreak(c.charValue()); // Explicit (un)boxing is intentional`
	`1482`	`+ return c != null && isLineBreak(c.charValue()); // Explicit unboxing is intentional`
`1483`	`1483`	`}`
`1484`	`1484`
`1485`	`1485`	`/** Same test as in as {@link String#trim()}. */`
`@@ -1700,7 +1700,7 @@ public boolean equals(final Object obj) {`
`1700`	`1700`	`}`
`1701`	`1701`
`1702`	`1702`	`private void escape(final char c, final Appendable appendable) throws IOException {`
`1703`		`- append(escapeCharacter.charValue(), appendable); // Explicit (un)boxing is intentional`
	`1703`	`+ append(escapeCharacter.charValue(), appendable); // Explicit unboxing is intentional`
`1704`	`1704`	`append(c, appendable);`
`1705`	`1705`	`}`
`1706`	`1706`
`@@ -1838,7 +1838,7 @@ public DuplicateHeaderMode getDuplicateHeaderMode() {`
`1838`	`1838`	`* @return the escape character, may be {@code 0}`
`1839`	`1839`	`*/`
`1840`	`1840`	`char getEscapeChar() {`
`1841`		`- return escapeCharacter != null ? escapeCharacter.charValue() : 0; // Explicit (un)boxing is intentional`
	`1841`	`+ return escapeCharacter != null ? escapeCharacter.charValue() : 0; // Explicit unboxing is intentional`
`1842`	`1842`	`}`
`1843`	`1843`
`1844`	`1844`	`/**`
`@@ -2161,15 +2161,15 @@ private void print(final InputStream inputStream, final Appendable out, final bo`
`2161`	`2161`	`}`
`2162`	`2162`	`final boolean quoteCharacterSet = isQuoteCharacterSet();`
`2163`	`2163`	`if (quoteCharacterSet) {`
`2164`		`- append(getQuoteCharacter().charValue(), out); // Explicit (un)boxing is intentional`
	`2164`	`+ append(getQuoteCharacter().charValue(), out); // Explicit unboxing is intentional`
`2165`	`2165`	`}`
`2166`	`2166`	`// Stream the input to the output without reading or holding the whole value in memory.`
`2167`	`2167`	`// AppendableOutputStream cannot "close" an Appendable.`
`2168`	`2168`	`try (OutputStream outputStream = new Base64OutputStream(new AppendableOutputStream<>(out))) {`
`2169`	`2169`	`IOUtils.copy(inputStream, outputStream);`
`2170`	`2170`	`}`
`2171`	`2171`	`if (quoteCharacterSet) {`
`2172`		`- append(getQuoteCharacter().charValue(), out); // Explicit (un)boxing is intentional`
	`2172`	`+ append(getQuoteCharacter().charValue(), out); // Explicit unboxing is intentional`
`2173`	`2173`	`}`
`2174`	`2174`	`}`
`2175`	`2175`
`@@ -2418,7 +2418,7 @@ private void printWithQuotes(final Object object, final CharSequence charSeq, fi`
`2418`	`2418`	`final int len = charSeq.length();`
`2419`	`2419`	`final char[] delim = getDelimiterCharArray();`
`2420`	`2420`	`final int delimLength = delim.length;`
`2421`		`- final char quoteChar = getQuoteCharacter().charValue(); // Explicit (un)boxing is intentional`
	`2421`	`+ final char quoteChar = getQuoteCharacter().charValue(); // Explicit unboxing is intentional`
`2422`	`2422`	`// If escape char not specified, default to the quote char`
`2423`	`2423`	`// This avoids having to keep checking whether there is an escape character`
`2424`	`2424`	`// at the cost of checking against quote twice`
`@@ -2521,7 +2521,7 @@ private void printWithQuotes(final Reader reader, final Appendable appendable) t`
`2521`	`2521`	`printWithEscapes(reader, appendable);`
`2522`	`2522`	`return;`
`2523`	`2523`	`}`
`2524`		`- final char quote = getQuoteCharacter().charValue(); // Explicit (un)boxing is intentional`
	`2524`	`+ final char quote = getQuoteCharacter().charValue(); // Explicit unboxing is intentional`
`2525`	`2525`	`// (1) Append opening quote`
`2526`	`2526`	`append(quote, appendable);`
`2527`	`2527`	`// (2) Append Reader contents, doubling quotes`
`@@ -2607,13 +2607,13 @@ boolean useRow(final long rowNum) {`
`2607`	`2607`	`* @throws IllegalArgumentException Throw when any attribute is invalid or inconsistent with other attributes.`
`2608`	`2608`	`*/`
`2609`	`2609`	`private void validate() throws IllegalArgumentException {`
`2610`		`- if (quoteCharacter != null && contains(delimiter, quoteCharacter.charValue())) { // Explicit (un)boxing is intentional`
	`2610`	`+ if (quoteCharacter != null && contains(delimiter, quoteCharacter.charValue())) { // Explicit unboxing is intentional`
`2611`	`2611`	`throw new IllegalArgumentException("The quoteChar character and the delimiter cannot be the same ('" + quoteCharacter + "')");`
`2612`	`2612`	`}`
`2613`		`- if (escapeCharacter != null && contains(delimiter, escapeCharacter.charValue())) { // Explicit (un)boxing is intentional`
	`2613`	`+ if (escapeCharacter != null && contains(delimiter, escapeCharacter.charValue())) { // Explicit unboxing is intentional`
`2614`	`2614`	`throw new IllegalArgumentException("The escape character and the delimiter cannot be the same ('" + escapeCharacter + "')");`
`2615`	`2615`	`}`
`2616`		`- if (commentMarker != null && contains(delimiter, commentMarker.charValue())) { // Explicit (un)boxing is intentional`
	`2616`	`+ if (commentMarker != null && contains(delimiter, commentMarker.charValue())) { // Explicit unboxing is intentional`
`2617`	`2617`	`throw new IllegalArgumentException("The comment start character and the delimiter cannot be the same ('" + commentMarker + "')");`
`2618`	`2618`	`}`
`2619`	`2619`	`if (quoteCharacter != null && quoteCharacter.equals(commentMarker)) {`
Original file line number	Diff line number	Diff line change
`@@ -650,7 +650,7 @@ private Headers createHeaders() throws IOException {`
`650`	`650`	`}`
`651`	`651`	`observedMissing \|= blankHeader;`
`652`	`652`	`if (header != null) {`
`653`		`- headerMap.put(header, Integer.valueOf(i)); // Explicit (un)boxing is intentional`
	`653`	`+ headerMap.put(header, Integer.valueOf(i)); // Explicit boxing is intentional`
`654`	`654`	`if (headerNames == null) {`
`655`	`655`	`headerNames = new ArrayList<>(headerRecord.length);`
`656`	`656`	`}`
Original file line number	Diff line number	Diff line change
`@@ -132,13 +132,11 @@ public String get(final String name) {`
`132`	`132`	`throw new IllegalArgumentException(String.format("Mapping for %s not found, expected one of %s", name, headerMap.keySet()));`
`133`	`133`	`}`
`134`	`134`	`try {`
`135`		`- return values[index.intValue()]; // Explicit (un)boxing is intentional`
	`135`	`+ return values[index.intValue()]; // Explicit unboxing is intentional`
`136`	`136`	`} catch (final ArrayIndexOutOfBoundsException e) {`
	`137`	`+ // Explicit boxing is intentional`
`137`	`138`	`throw new IllegalArgumentException(`
`138`		`- String.format("Index for header '%s' is %d but CSVRecord only has %d values!", name, index, Integer.valueOf(values.length))); // Explicit`
`139`		`- // (un)boxing`
`140`		`- // is`
`141`		`- // intentional`
	`139`	`+ String.format("Index for header '%s' is %d but CSVRecord only has %d values!", name, index, Integer.valueOf(values.length)));`
`142`	`140`	`}`
`143`	`141`	`}`
`144`	`142`
`@@ -267,7 +265,7 @@ public boolean isSet(final int index) {`
`267`	`265`	`* @return whether a given column is mapped and has a value.`
`268`	`266`	`*/`
`269`	`267`	`public boolean isSet(final String name) {`
`270`		`- return isMapped(name) && getHeaderMapRaw().get(name).intValue() < values.length; // Explicit (un)boxing is intentional`
	`268`	`+ return isMapped(name) && getHeaderMapRaw().get(name).intValue() < values.length; // Explicit unboxing is intentional`
`271`	`269`	`}`
`272`	`270`
`273`	`271`	`/**`