You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2023/09/30 15:01:00 UTC
[commons-csv] branch master updated (5d255771 -> 547c5a24)
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-csv.git
from 5d255771 Proper use of JUnit APIs
new 8c4ecf73 Proper use of JUnit APIs
new 04b2773b Reuse Commons IO
new 9c17a19b Reuse Commons IO
new 547c5a24 Javadoc
The 4 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
pom.xml | 1 -
.../java/org/apache/commons/csv/CSVFormat.java | 37 ++++--
.../java/org/apache/commons/csv/CSVParser.java | 8 +-
.../java/org/apache/commons/csv/CSVPrinter.java | 21 +--
src/main/java/org/apache/commons/csv/IOUtils.java | 147 ---------------------
.../org/apache/commons/csv/CSVPrinterTest.java | 1 +
.../java/org/apache/commons/csv/CSVRecordTest.java | 7 +-
.../java/org/apache/commons/csv/IOUtilsTest.java | 33 -----
8 files changed, 36 insertions(+), 219 deletions(-)
delete mode 100644 src/main/java/org/apache/commons/csv/IOUtils.java
delete mode 100644 src/test/java/org/apache/commons/csv/IOUtilsTest.java
[commons-csv] 03/04: Reuse Commons IO
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-csv.git
commit 9c17a19b775cdb60d3417cb4af74e046c85c39a1
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat Sep 30 10:59:40 2023 -0400
Reuse Commons IO
---
.../java/org/apache/commons/csv/CSVFormat.java | 8 +++--
.../java/org/apache/commons/csv/CSVPrinter.java | 34 ++++------------------
2 files changed, 11 insertions(+), 31 deletions(-)
diff --git a/src/main/java/org/apache/commons/csv/CSVFormat.java b/src/main/java/org/apache/commons/csv/CSVFormat.java
index c89d6d4e..6c504bc9 100644
--- a/src/main/java/org/apache/commons/csv/CSVFormat.java
+++ b/src/main/java/org/apache/commons/csv/CSVFormat.java
@@ -49,6 +49,7 @@ import java.util.Objects;
import java.util.Set;
import org.apache.commons.io.IOUtils;
+import org.apache.commons.io.function.Uncheck;
/**
* Specifies the format of a CSV file for parsing and writing.
@@ -1577,15 +1578,16 @@ public final class CSVFormat implements Serializable {
* @return the formatted values
*/
public String format(final Object... values) {
+ return Uncheck.get(() -> format_(values));
+ }
+
+ private String format_(final Object... values) throws IOException {
final StringWriter out = new StringWriter();
try (CSVPrinter csvPrinter = new CSVPrinter(out, this)) {
csvPrinter.printRecord(values);
final String res = out.toString();
final int len = recordSeparator != null ? res.length() - recordSeparator.length() : res.length();
return res.substring(0, len);
- } catch (final IOException e) {
- // should not happen because a StringWriter does not do IO.
- throw new IllegalStateException(e);
}
}
diff --git a/src/main/java/org/apache/commons/csv/CSVPrinter.java b/src/main/java/org/apache/commons/csv/CSVPrinter.java
index 39ddb51d..6d8f8af8 100644
--- a/src/main/java/org/apache/commons/csv/CSVPrinter.java
+++ b/src/main/java/org/apache/commons/csv/CSVPrinter.java
@@ -31,6 +31,8 @@ import java.util.Arrays;
import java.util.Objects;
import java.util.stream.Stream;
+import org.apache.commons.io.function.IOStream;
+
/**
* Prints values in a {@link CSVFormat CSV format}.
*
@@ -70,19 +72,6 @@ import java.util.stream.Stream;
*/
public final class CSVPrinter implements Flushable, Closeable {
- /**
- * Throws the given throwable.
- *
- * @param <T> The throwable cast type.
- * @param throwable The throwable to rethrow.
- * @return nothing because we throw.
- * @throws T Always thrown.
- */
- @SuppressWarnings("unchecked")
- private static <T extends Throwable> RuntimeException rethrow(final Throwable throwable) throws T {
- throw (T) throwable;
- }
-
/** The place that the values get written. */
private final Appendable appendable;
@@ -308,14 +297,9 @@ public final class CSVPrinter implements Flushable, Closeable {
* If an I/O error occurs
* @since 1.10.0
*/
+ @SuppressWarnings("resource") // caller closes.
public synchronized void printRecord(final Stream<?> values) throws IOException {
- values.forEachOrdered(t -> {
- try {
- print(t);
- } catch (final IOException e) {
- throw rethrow(e);
- }
- });
+ IOStream.adapt(values).forEachOrdered(this::print);
println();
}
@@ -496,14 +480,8 @@ public final class CSVPrinter implements Flushable, Closeable {
* If an I/O error occurs
* @since 1.10.0
*/
- @SuppressWarnings("unused") // rethrow() throws IOException
+ @SuppressWarnings({ "resource" }) // Caller closes.
public void printRecords(final Stream<?> values) throws IOException {
- values.forEachOrdered(t -> {
- try {
- printRecordObject(t);
- } catch (final IOException e) {
- throw rethrow(e);
- }
- });
+ IOStream.adapt(values).forEachOrdered(this::printRecordObject);
}
}
[commons-csv] 02/04: Reuse Commons IO
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-csv.git
commit 04b2773baee1007413d78514c09c8392d3797dfb
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat Sep 30 10:44:29 2023 -0400
Reuse Commons IO
---
pom.xml | 1 -
.../java/org/apache/commons/csv/CSVFormat.java | 2 +
.../java/org/apache/commons/csv/CSVParser.java | 8 +-
.../java/org/apache/commons/csv/CSVPrinter.java | 17 ++-
src/main/java/org/apache/commons/csv/IOUtils.java | 147 ---------------------
.../org/apache/commons/csv/CSVPrinterTest.java | 1 +
.../java/org/apache/commons/csv/IOUtilsTest.java | 33 -----
7 files changed, 21 insertions(+), 188 deletions(-)
diff --git a/pom.xml b/pom.xml
index 243954bc..e8297b0d 100644
--- a/pom.xml
+++ b/pom.xml
@@ -51,7 +51,6 @@
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.14.0</version>
- <scope>test</scope>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
diff --git a/src/main/java/org/apache/commons/csv/CSVFormat.java b/src/main/java/org/apache/commons/csv/CSVFormat.java
index d6218213..c89d6d4e 100644
--- a/src/main/java/org/apache/commons/csv/CSVFormat.java
+++ b/src/main/java/org/apache/commons/csv/CSVFormat.java
@@ -48,6 +48,8 @@ import java.util.HashSet;
import java.util.Objects;
import java.util.Set;
+import org.apache.commons.io.IOUtils;
+
/**
* Specifies the format of a CSV file for parsing and writing.
*
diff --git a/src/main/java/org/apache/commons/csv/CSVParser.java b/src/main/java/org/apache/commons/csv/CSVParser.java
index 4ce3774b..85c7d8ea 100644
--- a/src/main/java/org/apache/commons/csv/CSVParser.java
+++ b/src/main/java/org/apache/commons/csv/CSVParser.java
@@ -47,6 +47,8 @@ import java.util.stream.Collectors;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;
+import org.apache.commons.io.function.Uncheck;
+
/**
* Parses CSV files according to the specified format.
*
@@ -144,11 +146,7 @@ public final class CSVParser implements Iterable<CSVRecord>, Closeable {
private CSVRecord current;
private CSVRecord getNextRecord() {
- try {
- return CSVParser.this.nextRecord();
- } catch (final IOException e) {
- throw new UncheckedIOException("Exception reading next record: " + e.toString(), e);
- }
+ return Uncheck.get(CSVParser.this::nextRecord);
}
@Override
diff --git a/src/main/java/org/apache/commons/csv/CSVPrinter.java b/src/main/java/org/apache/commons/csv/CSVPrinter.java
index 421de13e..39ddb51d 100644
--- a/src/main/java/org/apache/commons/csv/CSVPrinter.java
+++ b/src/main/java/org/apache/commons/csv/CSVPrinter.java
@@ -70,6 +70,19 @@ import java.util.stream.Stream;
*/
public final class CSVPrinter implements Flushable, Closeable {
+ /**
+ * Throws the given throwable.
+ *
+ * @param <T> The throwable cast type.
+ * @param throwable The throwable to rethrow.
+ * @return nothing because we throw.
+ * @throws T Always thrown.
+ */
+ @SuppressWarnings("unchecked")
+ private static <T extends Throwable> RuntimeException rethrow(final Throwable throwable) throws T {
+ throw (T) throwable;
+ }
+
/** The place that the values get written. */
private final Appendable appendable;
@@ -300,7 +313,7 @@ public final class CSVPrinter implements Flushable, Closeable {
try {
print(t);
} catch (final IOException e) {
- throw IOUtils.rethrow(e);
+ throw rethrow(e);
}
});
println();
@@ -489,7 +502,7 @@ public final class CSVPrinter implements Flushable, Closeable {
try {
printRecordObject(t);
} catch (final IOException e) {
- throw IOUtils.rethrow(e);
+ throw rethrow(e);
}
});
}
diff --git a/src/main/java/org/apache/commons/csv/IOUtils.java b/src/main/java/org/apache/commons/csv/IOUtils.java
deleted file mode 100644
index 4fb7120f..00000000
--- a/src/main/java/org/apache/commons/csv/IOUtils.java
+++ /dev/null
@@ -1,147 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.apache.commons.csv;
-
-import java.io.IOException;
-import java.io.Reader;
-import java.io.Writer;
-import java.nio.Buffer;
-import java.nio.CharBuffer;
-
-/** Copied from Apache Commons IO. */
-final class IOUtils {
-
- /**
- * The default buffer size ({@value}).
- */
- static final int DEFAULT_BUFFER_SIZE = 1024 * 4;
-
- /**
- * Represents the end-of-file (or stream).
- */
- private static final int EOF = -1;
-
- /**
- * Copies chars from a large (over 2GB) {@code Reader} to an {@code Appendable}.
- * <p>
- * This method buffers the input internally, so there is no need to use a
- * {@code BufferedReader}.
- * </p>
- * The buffer size is given by {@link #DEFAULT_BUFFER_SIZE}.
- *
- * @param input the {@code Reader} to read from
- * @param output the {@code Appendable} to append to
- * @return the number of characters copied
- * @throws NullPointerException if the input or output is null
- * @throws IOException if an I/O error occurs
- * @since 2.7
- */
- static long copy(final Reader input, final Appendable output) throws IOException {
- return copy(input, output, CharBuffer.allocate(DEFAULT_BUFFER_SIZE));
- }
-
- /**
- * Copies chars from a large (over 2GB) {@code Reader} to an {@code Appendable}.
- * <p>
- * This method uses the provided buffer, so there is no need to use a
- * {@code BufferedReader}.
- * </p>
- *
- * @param input the {@code Reader} to read from
- * @param output the {@code Appendable} to write to
- * @param buffer the buffer to be used for the copy
- * @return the number of characters copied
- * @throws NullPointerException if the input or output is null
- * @throws IOException if an I/O error occurs
- * @since 2.7
- */
- static long copy(final Reader input, final Appendable output, final CharBuffer buffer) throws IOException {
- long count = 0;
- int n;
- while (EOF != (n = input.read(buffer))) {
- ((Buffer) buffer).flip();
- output.append(buffer, 0, n);
- count += n;
- }
- return count;
- }
-
- /**
- * Copies chars from a large (over 2GB) {@code Reader} to a {@code Writer}.
- * <p>
- * This method buffers the input internally, so there is no need to use a
- * {@code BufferedReader}.
- * </p>
- * <p>
- * The buffer size is given by {@link #DEFAULT_BUFFER_SIZE}.
- * </p>
- *
- * @param input the {@code Reader} to read from
- * @param output the {@code Writer} to write to
- * @return the number of characters copied
- * @throws NullPointerException if the input or output is null
- * @throws IOException if an I/O error occurs
- * @since 1.3
- */
- static long copyLarge(final Reader input, final Writer output) throws IOException {
- return copyLarge(input, output, new char[DEFAULT_BUFFER_SIZE]);
- }
-
- /**
- * Copies chars from a large (over 2GB) {@code Reader} to a {@code Writer}.
- * <p>
- * This method uses the provided buffer, so there is no need to use a
- * {@code BufferedReader}.
- * </p>
- *
- * @param input the {@code Reader} to read from
- * @param output the {@code Writer} to write to
- * @param buffer the buffer to be used for the copy
- * @return the number of characters copied
- * @throws NullPointerException if the input or output is null
- * @throws IOException if an I/O error occurs
- * @since 2.2
- */
- static long copyLarge(final Reader input, final Writer output, final char[] buffer) throws IOException {
- long count = 0;
- int n;
- while (EOF != (n = input.read(buffer))) {
- output.write(buffer, 0, n);
- count += n;
- }
- return count;
- }
-
- /**
- * Throws the given throwable.
- *
- * @param <T> The throwable cast type.
- * @param throwable The throwable to rethrow.
- * @return nothing because we throw.
- * @throws T Always thrown.
- */
- @SuppressWarnings("unchecked")
- static <T extends Throwable> RuntimeException rethrow(final Throwable throwable) throws T {
- throw (T) throwable;
- }
-
- /** No instances. */
- private IOUtils() {
- // Noop
- }
-
-}
diff --git a/src/test/java/org/apache/commons/csv/CSVPrinterTest.java b/src/test/java/org/apache/commons/csv/CSVPrinterTest.java
index 33179246..6cc542dd 100644
--- a/src/test/java/org/apache/commons/csv/CSVPrinterTest.java
+++ b/src/test/java/org/apache/commons/csv/CSVPrinterTest.java
@@ -61,6 +61,7 @@ import java.util.Vector;
import java.util.stream.Stream;
import org.apache.commons.io.FileUtils;
+import org.apache.commons.io.IOUtils;
import org.apache.commons.io.output.NullOutputStream;
import org.apache.commons.lang3.StringUtils;
import org.h2.tools.SimpleResultSet;
diff --git a/src/test/java/org/apache/commons/csv/IOUtilsTest.java b/src/test/java/org/apache/commons/csv/IOUtilsTest.java
deleted file mode 100644
index 689fd195..00000000
--- a/src/test/java/org/apache/commons/csv/IOUtilsTest.java
+++ /dev/null
@@ -1,33 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.apache.commons.csv;
-
-import static org.junit.jupiter.api.Assertions.assertThrowsExactly;
-
-import java.io.IOException;
-
-import org.junit.jupiter.api.Test;
-
-public class IOUtilsTest {
-
- @Test
- public void testRethrow() {
- assertThrowsExactly(IOException.class, () -> IOUtils.rethrow(new IOException()));
- }
-
-}
[commons-csv] 01/04: Proper use of JUnit APIs
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-csv.git
commit 8c4ecf734e75bcb7c6fc2311fd28472a6bb86c10
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat Sep 30 10:39:58 2023 -0400
Proper use of JUnit APIs
---
src/test/java/org/apache/commons/csv/CSVRecordTest.java | 7 +------
1 file changed, 1 insertion(+), 6 deletions(-)
diff --git a/src/test/java/org/apache/commons/csv/CSVRecordTest.java b/src/test/java/org/apache/commons/csv/CSVRecordTest.java
index db1ef40c..975d45a5 100644
--- a/src/test/java/org/apache/commons/csv/CSVRecordTest.java
+++ b/src/test/java/org/apache/commons/csv/CSVRecordTest.java
@@ -255,12 +255,7 @@ public class CSVRecordTest {
assertFalse(rec.isSet("A"));
assertEquals(0, rec.toMap().size());
// This will throw
- try {
- rec.get("A");
- org.junit.jupiter.api.Assertions.fail("Access by name is not expected after deserialisation");
- } catch (final IllegalStateException expected) {
- // OK
- }
+ assertThrows(IllegalStateException.class, () -> rec.get("A"));
}
}
[commons-csv] 04/04: Javadoc
Posted by gg...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-csv.git
commit 547c5a24a329c306d41075cadb292e5eeebddac8
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sat Sep 30 11:00:49 2023 -0400
Javadoc
---
.../java/org/apache/commons/csv/CSVFormat.java | 27 ++++++++++++++--------
1 file changed, 18 insertions(+), 9 deletions(-)
diff --git a/src/main/java/org/apache/commons/csv/CSVFormat.java b/src/main/java/org/apache/commons/csv/CSVFormat.java
index 6c504bc9..43d9c64f 100644
--- a/src/main/java/org/apache/commons/csv/CSVFormat.java
+++ b/src/main/java/org/apache/commons/csv/CSVFormat.java
@@ -1413,31 +1413,40 @@ public final class CSVFormat implements Serializable {
private final boolean autoFlush;
- private final Character commentMarker; // null if commenting is disabled
+ /** null if commenting is disabled. */
+ private final Character commentMarker;
private final String delimiter;
- private final Character escapeCharacter; // null if escaping is disabled
+ /** null if escaping is disabled. */
+ private final Character escapeCharacter;
- private final String[] headers; // array of header column names
+ /** Array of header column names. */
+ private final String[] headers;
- private final String[] headerComments; // array of header comment lines
+ /** Array of header comment lines. */
+ private final String[] headerComments;
private final boolean ignoreEmptyLines;
- private final boolean ignoreHeaderCase; // should ignore header names case
+ /** Should ignore header names case. */
+ private final boolean ignoreHeaderCase;
- private final boolean ignoreSurroundingSpaces; // Should leading/trailing spaces be ignored around values?
+ /** TODO Should leading/trailing spaces be ignored around values?. */
+ private final boolean ignoreSurroundingSpaces;
- private final String nullString; // the string to be used for null values
+ /** The string to be used for null values. */
+ private final String nullString;
- private final Character quoteCharacter; // null if quoting is disabled
+ /** null if quoting is disabled. */
+ private final Character quoteCharacter;
private final String quotedNullString;
private final QuoteMode quoteMode;
- private final String recordSeparator; // for outputs
+ /** For output. */
+ private final String recordSeparator;
private final boolean skipHeaderRecord;