This is an automated email from the ASF dual-hosted git repository.
garydgregory 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 578fd573 Javadoc
578fd573 is described below
commit 578fd573a9126a157a02ba6a6ebe3b2012938f28
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 09:08:27 2026 -0400
Javadoc
---
.../java/org/apache/commons/csv/CSVFormat.java | 34 +++++++++++-----------
.../java/org/apache/commons/csv/CSVParser.java | 18 ++++++------
.../java/org/apache/commons/csv/CSVRecord.java | 6 ++--
src/main/java/org/apache/commons/csv/Lexer.java | 2 +-
src/main/java/org/apache/commons/csv/Token.java | 2 +-
.../java/org/apache/commons/csv/UserGuideTest.java | 2 +-
6 files changed, 32 insertions(+), 32 deletions(-)
diff --git a/src/main/java/org/apache/commons/csv/CSVFormat.java
b/src/main/java/org/apache/commons/csv/CSVFormat.java
index 40312425..0fdd3cb5 100644
--- a/src/main/java/org/apache/commons/csv/CSVFormat.java
+++ b/src/main/java/org/apache/commons/csv/CSVFormat.java
@@ -206,7 +206,7 @@ public final class CSVFormat implements Serializable {
* @see Predefined#Default
* @see DuplicateHeaderMode#ALLOW_ALL
*
- * @return a copy of the builder
+ * @return A copy of the builder
*/
public static Builder create() {
// @formatter:off
@@ -223,7 +223,7 @@ public final class CSVFormat implements Serializable {
* Creates a new builder from the given format.
*
* @param csvFormat the source format.
- * @return a new builder.
+ * @return A new builder.
*/
public static Builder create(final CSVFormat csvFormat) {
return new Builder(csvFormat);
@@ -306,7 +306,7 @@ public final class CSVFormat implements Serializable {
/**
* Builds a new CSVFormat instance.
*
- * @return a new CSVFormat instance.
+ * @return A new CSVFormat instance.
* @deprecated Use {@link #get()}.
*/
@Deprecated
@@ -317,7 +317,7 @@ public final class CSVFormat implements Serializable {
/**
* Builds a new CSVFormat instance.
*
- * @return a new CSVFormat instance.
+ * @return A new CSVFormat instance.
* @since 1.13.0
*/
@Override
@@ -1465,7 +1465,7 @@ public final class CSVFormat implements Serializable {
/**
* Creates a null-safe copy of the given instance.
*
- * @return a copy of the given instance or null if the input is null.
+ * @return A copy of the given instance or null if the input is null.
*/
static CSVFormat copy(final CSVFormat format) {
return format != null ? format.copy() : null;
@@ -1513,7 +1513,7 @@ public final class CSVFormat implements Serializable {
* </p>
*
* @param delimiter the char used for value separation, must not be a line
break character
- * @return a new CSV format.
+ * @return A new CSV format.
* @throws IllegalArgumentException if the delimiter is a line break
character
* @see #DEFAULT
* @see #RFC4180
@@ -1673,7 +1673,7 @@ public final class CSVFormat implements Serializable {
/**
* Creates a new Builder for this instance.
*
- * @return a new Builder.
+ * @return A new Builder.
*/
public Builder builder() {
return Builder.create(this);
@@ -1682,7 +1682,7 @@ public final class CSVFormat implements Serializable {
/**
* Creates a copy of this instance.
*
- * @return a copy of this instance.
+ * @return A copy of this instance.
*/
CSVFormat copy() {
return builder().get();
@@ -1893,7 +1893,7 @@ public final class CSVFormat implements Serializable {
/**
* Gets a copy of the header array.
*
- * @return a copy of the header array; {@code null} if disabled, the empty
array if to be read from the file
+ * @return A copy of the header array; {@code null} if disabled, the empty
array if to be read from the file
*/
public String[] getHeader() {
return headers != null ? headers.clone() : null;
@@ -1930,7 +1930,7 @@ public final class CSVFormat implements Serializable {
* # 1970-01-01T00:00:00Z
* </pre>
*
- * @return a copy of the header comment array; {@code null} if disabled.
+ * @return A copy of the header comment array; {@code null} if disabled.
*/
public String[] getHeaderComments() {
return headerComments != null ? headerComments.clone() : null;
@@ -2163,7 +2163,7 @@ public final class CSVFormat implements Serializable {
* </p>
*
* @param reader the input stream
- * @return a parser over a stream of {@link CSVRecord}s.
+ * @return A parser over a stream of {@link CSVRecord}s.
* @throws IOException If an I/O error occurs
* @throws CSVException Thrown on invalid input.
*/
@@ -2179,7 +2179,7 @@ public final class CSVFormat implements Serializable {
* </p>
*
* @param out the output.
- * @return a printer to an output.
+ * @return A printer to an output.
* @throws IOException thrown if the optional header cannot be printed.
*/
public CSVPrinter print(final Appendable out) throws IOException {
@@ -2195,7 +2195,7 @@ public final class CSVFormat implements Serializable {
*
* @param out the output.
* @param charset A charset.
- * @return a printer to an output.
+ * @return A printer to an output.
* @throws IOException thrown if the optional header cannot be printed.
* @since 1.5
*/
@@ -2288,7 +2288,7 @@ public final class CSVFormat implements Serializable {
*
* @param out the output.
* @param charset A charset.
- * @return a printer to an output.
+ * @return A printer to an output.
* @throws IOException thrown if the optional header cannot be printed.
* @since 1.5
*/
@@ -2320,7 +2320,7 @@ public final class CSVFormat implements Serializable {
* See also {@link CSVPrinter}.
* </p>
*
- * @return a printer to {@link System#out}.
+ * @return A printer to {@link System#out}.
* @throws IOException thrown if the optional header cannot be printed.
* @since 1.5
*/
@@ -2716,7 +2716,7 @@ public final class CSVFormat implements Serializable {
/**
* Builds a new {@code CSVFormat} that allows duplicate header names.
*
- * @return a new {@code CSVFormat} that allows duplicate header names
+ * @return A new {@code CSVFormat} that allows duplicate header names
* @since 1.7
* @deprecated Use {@link Builder#setAllowDuplicateHeaderNames(boolean)
Builder#setAllowDuplicateHeaderNames(true)}
*/
@@ -2729,7 +2729,7 @@ public final class CSVFormat implements Serializable {
* Builds a new {@code CSVFormat} with duplicate header names behavior set
to the given value.
*
* @param allowDuplicateHeaderNames the duplicate header names behavior,
true to allow, false to disallow.
- * @return a new {@code CSVFormat} with duplicate header names behavior
set to the given value.
+ * @return A new {@code CSVFormat} with duplicate header names behavior
set to the given value.
* @since 1.7
* @deprecated Use {@link Builder#setAllowDuplicateHeaderNames(boolean)}
*/
diff --git a/src/main/java/org/apache/commons/csv/CSVParser.java
b/src/main/java/org/apache/commons/csv/CSVParser.java
index 4e11634e..0f3dd700 100644
--- a/src/main/java/org/apache/commons/csv/CSVParser.java
+++ b/src/main/java/org/apache/commons/csv/CSVParser.java
@@ -315,7 +315,7 @@ public final class CSVParser implements
Iterable<CSVRecord>, Closeable {
/**
* Creates a new builder.
*
- * @return a new builder.
+ * @return A new builder.
* @since 1.13.0
*/
public static Builder builder() {
@@ -331,7 +331,7 @@ public final class CSVParser implements
Iterable<CSVRecord>, Closeable {
* The Charset to decode the given file, {@code null} maps to
the {@link Charset#defaultCharset() default Charset}.
* @param format
* the CSVFormat used for CSV parsing, {@code null} maps to
{@link CSVFormat#DEFAULT}.
- * @return a new parser
+ * @return A new parser
* @throws IllegalArgumentException
* If the parameters of the format are inconsistent.
* @throws IOException
@@ -358,7 +358,7 @@ public final class CSVParser implements
Iterable<CSVRecord>, Closeable {
* The Charset to decode the given file, {@code null} maps to
the {@link Charset#defaultCharset() default Charset}.
* @param format
* the CSVFormat used for CSV parsing, {@code null} maps to
{@link CSVFormat#DEFAULT}.
- * @return a new CSVParser configured with the given reader and format.
+ * @return A new CSVParser configured with the given reader and format.
* @throws IllegalArgumentException
* If the parameters of the format are inconsistent or if
either reader or format are null.
* @throws IOException
@@ -380,7 +380,7 @@ public final class CSVParser implements
Iterable<CSVRecord>, Closeable {
* The Charset to decode the given file, {@code null} maps to
the {@link Charset#defaultCharset() default Charset}.
* @param format
* the CSVFormat used for CSV parsing, {@code null} maps to
{@link CSVFormat#DEFAULT}.
- * @return a new parser
+ * @return A new parser
* @throws IllegalArgumentException
* If the parameters of the format are inconsistent.
* @throws IOException
@@ -407,7 +407,7 @@ public final class CSVParser implements
Iterable<CSVRecord>, Closeable {
* a Reader containing CSV-formatted input. Must not be null.
* @param format
* the CSVFormat used for CSV parsing, {@code null} maps to
{@link CSVFormat#DEFAULT}.
- * @return a new CSVParser configured with the given reader and format.
+ * @return A new CSVParser configured with the given reader and format.
* @throws IllegalArgumentException
* If the parameters of the format are inconsistent or if
either reader or format are null.
* @throws IOException
@@ -426,7 +426,7 @@ public final class CSVParser implements
Iterable<CSVRecord>, Closeable {
* a CSV string. Must not be null.
* @param format
* the CSVFormat used for CSV parsing, {@code null} maps to
{@link CSVFormat#DEFAULT}.
- * @return a new parser
+ * @return A new parser
* @throws IllegalArgumentException
* If the parameters of the format are inconsistent.
* @throws IOException
@@ -453,7 +453,7 @@ public final class CSVParser implements
Iterable<CSVRecord>, Closeable {
* the charset for the resource, {@code null} maps to the
{@link Charset#defaultCharset() default Charset}.
* @param format
* the CSVFormat used for CSV parsing, {@code null} maps to
{@link CSVFormat#DEFAULT}.
- * @return a new parser
+ * @return A new parser
* @throws IllegalArgumentException
* If the parameters of the format are inconsistent.
* @throws IOException
@@ -714,7 +714,7 @@ public final class CSVParser implements
Iterable<CSVRecord>, Closeable {
* contain null or duplicate column names.
* </p>
*
- * @return a copy of the header map.
+ * @return A copy of the header map.
*/
public Map<String, Integer> getHeaderMap() {
if (headers.headerMap == null) {
@@ -952,7 +952,7 @@ public final class CSVParser implements
Iterable<CSVRecord>, Closeable {
* You can use {@link CSVFormat.Builder#setMaxRows(long)} to limit how
many rows a Stream produces.
* </p>
*
- * @return a sequential {@code Stream} with this collection as its source.
+ * @return A sequential {@code Stream} with this collection as its source.
* @since 1.9.0
*/
public Stream<CSVRecord> stream() {
diff --git a/src/main/java/org/apache/commons/csv/CSVRecord.java
b/src/main/java/org/apache/commons/csv/CSVRecord.java
index 649d9624..0e162989 100644
--- a/src/main/java/org/apache/commons/csv/CSVRecord.java
+++ b/src/main/java/org/apache/commons/csv/CSVRecord.java
@@ -271,7 +271,7 @@ public final class CSVRecord implements Serializable,
Iterable<String> {
/**
* Returns an iterator over the values of this record.
*
- * @return an iterator over the values of this record.
+ * @return An iterator over the values of this record.
*/
@Override
public Iterator<String> iterator() {
@@ -323,7 +323,7 @@ public final class CSVRecord implements Serializable,
Iterable<String> {
* Editing the list does not update this instance.
* </p>
*
- * @return a new List
+ * @return A new List
* @since 1.9.0
*/
public List<String> toList() {
@@ -348,7 +348,7 @@ public final class CSVRecord implements Serializable,
Iterable<String> {
* Returns a string representation of the contents of this record. The
result is constructed by comment, mapping,
* recordNumber and by passing the internal values array to {@link
Arrays#toString(Object[])}.
*
- * @return a String representation of this record.
+ * @return A String representation of this record.
*/
@Override
public String toString() {
diff --git a/src/main/java/org/apache/commons/csv/Lexer.java
b/src/main/java/org/apache/commons/csv/Lexer.java
index 60402d1b..e2d0570b 100644
--- a/src/main/java/org/apache/commons/csv/Lexer.java
+++ b/src/main/java/org/apache/commons/csv/Lexer.java
@@ -337,7 +337,7 @@ final class Lexer implements Closeable {
*
* @param token
* the current token
- * @return a valid token object
+ * @return A valid token object
* @throws IOException
* Thrown when in an invalid state: EOF before closing
encapsulator or invalid character before
* delimiter or EOL.
diff --git a/src/main/java/org/apache/commons/csv/Token.java
b/src/main/java/org/apache/commons/csv/Token.java
index 87af3356..42c4e3bd 100644
--- a/src/main/java/org/apache/commons/csv/Token.java
+++ b/src/main/java/org/apache/commons/csv/Token.java
@@ -71,7 +71,7 @@ final class Token {
/**
* Converts the token state to a string to ease debugging.
*
- * @return a string helpful for debugging.
+ * @return A string helpful for debugging.
*/
@Override
public String toString() {
diff --git a/src/test/java/org/apache/commons/csv/UserGuideTest.java
b/src/test/java/org/apache/commons/csv/UserGuideTest.java
index 6cd8c72d..42292fab 100644
--- a/src/test/java/org/apache/commons/csv/UserGuideTest.java
+++ b/src/test/java/org/apache/commons/csv/UserGuideTest.java
@@ -44,7 +44,7 @@ class UserGuideTest {
* Creates a reader capable of handling BOMs.
*
* @param path The path to read.
- * @return a new InputStreamReader for UTF-8 bytes.
+ * @return A new InputStreamReader for UTF-8 bytes.
* @throws IOException if an I/O error occurs.
*/
public InputStreamReader newReader(final Path path) throws IOException {
