This is an automated email from the ASF dual-hosted git repository.
sebb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-csv.git
The following commit(s) were added to refs/heads/master by this push:
new 19eb70c8 Document explicit (un)boxing
19eb70c8 is described below
commit 19eb70c868902bd8a7fa067d77df8dcfa5b1eb0c
Author: Sebb <s...@apache.org>
AuthorDate: Tue Jul 9 22:48:01 2024 +0100
Document explicit (un)boxing
---
src/main/java/org/apache/commons/csv/CSVFormat.java | 20 ++++++++++----------
src/main/java/org/apache/commons/csv/CSVParser.java | 2 +-
src/main/java/org/apache/commons/csv/CSVPrinter.java | 4 ++--
src/main/java/org/apache/commons/csv/CSVRecord.java | 6 +++---
src/main/java/org/apache/commons/csv/Lexer.java | 2 +-
5 files changed, 17 insertions(+), 17 deletions(-)
diff --git a/src/main/java/org/apache/commons/csv/CSVFormat.java
b/src/main/java/org/apache/commons/csv/CSVFormat.java
index 5c511c60..0dd50031 100644
--- a/src/main/java/org/apache/commons/csv/CSVFormat.java
+++ b/src/main/java/org/apache/commons/csv/CSVFormat.java
@@ -1371,7 +1371,7 @@ public final class CSVFormat implements Serializable {
* @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());
+ return c != null && isLineBreak(c.charValue()); // N.B. Explicit
(un)boxing is intentional
}
/** Same test as in as {@link String#trim()}. */
@@ -1632,7 +1632,7 @@ public final class CSVFormat implements Serializable {
}
private void escape(final char c, final Appendable appendable) throws
IOException {
- append(escapeCharacter.charValue(), appendable);
+ append(escapeCharacter.charValue(), appendable); // N.B. Explicit
(un)boxing is intentional
append(c, appendable);
}
@@ -1769,7 +1769,7 @@ public final class CSVFormat implements Serializable {
* @return the escape character, may be {@code 0}
*/
char getEscapeChar() {
- return escapeCharacter != null ? escapeCharacter.charValue() : 0;
+ return escapeCharacter != null ? escapeCharacter.charValue() : 0; //
N.B. Explicit (un)boxing is intentional
}
/**
@@ -2081,7 +2081,7 @@ public final class CSVFormat implements Serializable {
}
final boolean quoteCharacterSet = isQuoteCharacterSet();
if (quoteCharacterSet) {
- append(getQuoteCharacter().charValue(), out);
+ append(getQuoteCharacter().charValue(), out); // N.B. Explicit
(un)boxing is intentional
}
// Stream the input to the output without reading or holding the whole
value in memory.
// AppendableOutputStream cannot "close" an Appendable.
@@ -2089,7 +2089,7 @@ public final class CSVFormat implements Serializable {
IOUtils.copy(inputStream, outputStream);
}
if (quoteCharacterSet) {
- append(getQuoteCharacter().charValue(), out);
+ append(getQuoteCharacter().charValue(), out); // N.B. Explicit
(un)boxing is intentional
}
}
@@ -2338,7 +2338,7 @@ public final class CSVFormat implements Serializable {
final int len = charSeq.length();
final char[] delim = getDelimiterCharArray();
final int delimLength = delim.length;
- final char quoteChar = getQuoteCharacter().charValue();
+ final char quoteChar = getQuoteCharacter().charValue(); // N.B.
Explicit (un)boxing 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
@@ -2441,7 +2441,7 @@ public final class CSVFormat implements Serializable {
printWithEscapes(reader, appendable);
return;
}
- final char quote = getQuoteCharacter().charValue();
+ final char quote = getQuoteCharacter().charValue(); // N.B. Explicit
(un)boxing is intentional
// (1) Append opening quote
append(quote, appendable);
// (2) Append Reader contents, doubling quotes
@@ -2522,13 +2522,13 @@ public final class CSVFormat implements Serializable {
if (containsLineBreak(delimiter)) {
throw new IllegalArgumentException("The delimiter cannot be a line
break");
}
- if (quoteCharacter != null && contains(delimiter,
quoteCharacter.charValue())) {
+ if (quoteCharacter != null && contains(delimiter,
quoteCharacter.charValue())) { // N.B. Explicit (un)boxing is intentional
throw new IllegalArgumentException("The quoteChar character and
the delimiter cannot be the same ('" + quoteCharacter + "')");
}
- if (escapeCharacter != null && contains(delimiter,
escapeCharacter.charValue())) {
+ if (escapeCharacter != null && contains(delimiter,
escapeCharacter.charValue())) { // N.B. Explicit (un)boxing is intentional
throw new IllegalArgumentException("The escape character and the
delimiter cannot be the same ('" + escapeCharacter + "')");
}
- if (commentMarker != null && contains(delimiter,
commentMarker.charValue())) {
+ if (commentMarker != null && contains(delimiter,
commentMarker.charValue())) { // N.B. Explicit (un)boxing 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
index 17e084f1..ac33f6b7 100644
--- a/src/main/java/org/apache/commons/csv/CSVParser.java
+++ b/src/main/java/org/apache/commons/csv/CSVParser.java
@@ -515,7 +515,7 @@ public final class CSVParser implements
Iterable<CSVRecord>, Closeable {
}
observedMissing |= blankHeader;
if (header != null) {
- hdrMap.put(header, Integer.valueOf(i));
+ hdrMap.put(header, Integer.valueOf(i)); // N.B.
Explicit (un)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
index fd62df25..393f6ab2 100644
--- a/src/main/java/org/apache/commons/csv/CSVPrinter.java
+++ b/src/main/java/org/apache/commons/csv/CSVPrinter.java
@@ -203,7 +203,7 @@ public final class CSVPrinter implements Flushable,
Closeable {
if (!newRecord) {
println();
}
- appendable.append(format.getCommentMarker().charValue());
+ appendable.append(format.getCommentMarker().charValue()); // N.B.
Explicit (un)boxing is intentional
appendable.append(SP);
for (int i = 0; i < comment.length(); i++) {
final char c = comment.charAt(i);
@@ -215,7 +215,7 @@ public final class CSVPrinter implements Flushable,
Closeable {
//$FALL-THROUGH$ break intentionally excluded.
case LF:
println();
- appendable.append(format.getCommentMarker().charValue());
+ appendable.append(format.getCommentMarker().charValue()); //
N.B. Explicit (un)boxing 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
index 189cc07e..0a084b01 100644
--- a/src/main/java/org/apache/commons/csv/CSVRecord.java
+++ b/src/main/java/org/apache/commons/csv/CSVRecord.java
@@ -122,11 +122,11 @@ public final class CSVRecord implements Serializable,
Iterable<String> {
headerMap.keySet()));
}
try {
- return values[index.intValue()];
+ return values[index.intValue()]; // N.B. Explicit (un)boxing is
intentional
} catch (final ArrayIndexOutOfBoundsException e) {
throw new IllegalArgumentException(String.format(
"Index for header '%s' is %d but CSVRecord only has %d
values!", name, index,
- Integer.valueOf(values.length)));
+ Integer.valueOf(values.length))); // N.B. Explicit (un)boxing
is intentional
}
}
@@ -245,7 +245,7 @@ public final class CSVRecord implements Serializable,
Iterable<String> {
* @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;
+ return isMapped(name) && getHeaderMapRaw().get(name).intValue() <
values.length; // N.B. Explicit (un)boxing is intentional
}
/**
diff --git a/src/main/java/org/apache/commons/csv/Lexer.java
b/src/main/java/org/apache/commons/csv/Lexer.java
index a612fdfa..91d97837 100644
--- a/src/main/java/org/apache/commons/csv/Lexer.java
+++ b/src/main/java/org/apache/commons/csv/Lexer.java
@@ -198,7 +198,7 @@ final class Lexer implements Closeable {
}
private char mapNullToDisabled(final Character c) {
- return c == null ? DISABLED : c.charValue();
+ return c == null ? DISABLED : c.charValue(); // N.B. Explicit
(un)boxing is intentional
}
/**
