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
commit 8205bb6397be64f1ee446e856ba8d82e43d6810d Author: Gary Gregory <[email protected]> AuthorDate: Sat Jul 11 08:27:29 2026 -0400 Javadoc --- .../java/org/apache/commons/csv/CSVFormat.java | 26 +++++++++++----------- .../java/org/apache/commons/csv/CSVParser.java | 12 +++++----- .../java/org/apache/commons/csv/CSVPrinter.java | 4 ++-- .../java/org/apache/commons/csv/CSVRecord.java | 24 ++++++++++---------- .../apache/commons/csv/ExtendedBufferedReader.java | 12 +++++----- src/main/java/org/apache/commons/csv/Lexer.java | 12 +++++----- .../apache/commons/csv/CSVDuplicateHeaderTest.java | 4 ++-- 7 files changed, 47 insertions(+), 47 deletions(-) diff --git a/src/main/java/org/apache/commons/csv/CSVFormat.java b/src/main/java/org/apache/commons/csv/CSVFormat.java index d1e94ebe..40312425 100644 --- a/src/main/java/org/apache/commons/csv/CSVFormat.java +++ b/src/main/java/org/apache/commons/csv/CSVFormat.java @@ -1019,7 +1019,7 @@ public final class CSVFormat implements Serializable { /** * Gets the format. * - * @return the format. + * @return The format. */ public CSVFormat getFormat() { return format; @@ -1434,7 +1434,7 @@ public final class CSVFormat implements Serializable { * * @param <T> The array element type. * @param values the source array - * @return the cloned array. + * @return The cloned array. */ @SafeVarargs static <T> T[] clone(final T... values) { @@ -1748,7 +1748,7 @@ public final class CSVFormat implements Serializable { * Formats the specified values as a CSV record string. * * @param values the values to format. - * @return the formatted values. + * @return The formatted values. */ public String format(final Object... values) { return Uncheck.get(() -> format_(values)); @@ -1826,7 +1826,7 @@ public final class CSVFormat implements Serializable { * # 1970-01-01T00:00:00Z * </pre> * - * @return the comment start marker, may be {@code null} + * @return The comment start marker, may be {@code null} */ public Character getCommentMarker() { return commentMarker; @@ -1835,7 +1835,7 @@ public final class CSVFormat implements Serializable { /** * Gets the first character delimiting the values (typically ';', ',' or '\t'). * - * @return the first delimiter character. + * @return The first delimiter character. * @deprecated Use {@link #getDelimiterString()}. */ @Deprecated @@ -1846,7 +1846,7 @@ public final class CSVFormat implements Serializable { /** * Gets the character delimiting the values (typically ";", "," or "\t"). * - * @return the delimiter. + * @return The delimiter. */ char[] getDelimiterCharArray() { return delimiter.toCharArray(); @@ -1855,7 +1855,7 @@ public final class CSVFormat implements Serializable { /** * Gets the character delimiting the values (typically ";", "," or "\t"). * - * @return the delimiter. + * @return The delimiter. * @since 1.9.0 */ public String getDelimiterString() { @@ -1875,7 +1875,7 @@ public final class CSVFormat implements Serializable { /** * Gets the escape character. * - * @return the escape character, may be {@code 0} + * @return The escape character, may be {@code 0} */ char getEscapeChar() { return escapeCharacter != null ? escapeCharacter.charValue() : 0; // Explicit unboxing is intentional @@ -1884,7 +1884,7 @@ public final class CSVFormat implements Serializable { /** * Gets the escape character. * - * @return the escape character, may be {@code null} + * @return The escape character, may be {@code null} */ public Character getEscapeCharacter() { return escapeCharacter; @@ -1994,7 +1994,7 @@ public final class CSVFormat implements Serializable { * <li><strong>Writing:</strong> Writes {@code null} as the given {@code nullString} when writing records.</li> * </ul> * - * @return the String to convert to and from {@code null}. No substitution occurs if {@code null} + * @return The String to convert to and from {@code null}. No substitution occurs if {@code null} */ public String getNullString() { return nullString; @@ -2003,7 +2003,7 @@ public final class CSVFormat implements Serializable { /** * Gets the character used to encapsulate values containing special characters. * - * @return the quoteChar character, may be {@code null} + * @return The quoteChar character, may be {@code null} */ public Character getQuoteCharacter() { return quoteCharacter; @@ -2012,7 +2012,7 @@ public final class CSVFormat implements Serializable { /** * Gets the quote policy output fields. * - * @return the quote policy + * @return The quote policy */ public QuoteMode getQuoteMode() { return quoteMode; @@ -2021,7 +2021,7 @@ public final class CSVFormat implements Serializable { /** * Gets the record separator delimiting output records. * - * @return the record separator + * @return The record separator */ public String getRecordSeparator() { return recordSeparator; diff --git a/src/main/java/org/apache/commons/csv/CSVParser.java b/src/main/java/org/apache/commons/csv/CSVParser.java index 141eba73..4e11634e 100644 --- a/src/main/java/org/apache/commons/csv/CSVParser.java +++ b/src/main/java/org/apache/commons/csv/CSVParser.java @@ -244,7 +244,7 @@ public final class CSVParser implements Iterable<CSVRecord>, Closeable { * * @throws IOException on parse error or input read-failure * @throws CSVException on invalid input. - * @return the next record, or {@code null} if the end of the stream has been reached. + * @return The next record, or {@code null} if the end of the stream has been reached. */ private CSVRecord getNextRecord() { CSVRecord record = null; @@ -686,7 +686,7 @@ public final class CSVParser implements Iterable<CSVRecord>, Closeable { /** * Gets the first end-of-line string encountered. * - * @return the first end-of-line string. + * @return The first end-of-line string. * @since 1.5 */ public String getFirstEndOfLine() { @@ -697,7 +697,7 @@ public final class CSVParser implements Iterable<CSVRecord>, Closeable { * Gets the header comment, if any. * The header comment appears before the header record. * - * @return the header comment for this stream, or null if no comment is available. + * @return The header comment for this stream, or null if no comment is available. * @since 1.10.0 */ public String getHeaderComment() { @@ -728,7 +728,7 @@ public final class CSVParser implements Iterable<CSVRecord>, Closeable { /** * Gets the underlying header map. * - * @return the underlying header map. + * @return The underlying header map. */ Map<String, Integer> getHeaderMapRaw() { return headers.headerMap; @@ -787,7 +787,7 @@ public final class CSVParser implements Iterable<CSVRecord>, Closeable { * Gets the trailer comment, if any. * Trailer comments are located between the last record and EOF * - * @return the trailer comment for this stream, or null if no comment is available. + * @return The trailer comment for this stream, or null if no comment is available. * @since 1.10.0 */ public String getTrailerComment() { @@ -892,7 +892,7 @@ public final class CSVParser implements Iterable<CSVRecord>, Closeable { /** * Parses the next record from the current point in the stream. * - * @return the record as an array of values, or {@code null} if the end of the stream has been reached. + * @return The record as an array of values, or {@code null} if the end of the stream has been reached. * @throws IOException on parse error or input read-failure. * @throws CSVException on invalid CSV input data. */ diff --git a/src/main/java/org/apache/commons/csv/CSVPrinter.java b/src/main/java/org/apache/commons/csv/CSVPrinter.java index a7048fd6..1f8d6335 100644 --- a/src/main/java/org/apache/commons/csv/CSVPrinter.java +++ b/src/main/java/org/apache/commons/csv/CSVPrinter.java @@ -172,7 +172,7 @@ public final class CSVPrinter implements Flushable, Closeable { /** * Gets the target Appendable. * - * @return the target Appendable. + * @return The target Appendable. */ public Appendable getOut() { return appendable; @@ -181,7 +181,7 @@ public final class CSVPrinter implements Flushable, Closeable { /** * Gets the record count printed, this does not include comments or headers. * - * @return the record count, this does not include comments or headers. + * @return The record count, this does not include comments or headers. * @since 1.13.0 */ public long getRecordCount() { diff --git a/src/main/java/org/apache/commons/csv/CSVRecord.java b/src/main/java/org/apache/commons/csv/CSVRecord.java index 8dab14d9..649d9624 100644 --- a/src/main/java/org/apache/commons/csv/CSVRecord.java +++ b/src/main/java/org/apache/commons/csv/CSVRecord.java @@ -82,7 +82,7 @@ public final class CSVRecord implements Serializable, Iterable<String> { * * @param e * an enum - * @return the String at the given enum String + * @return The String at the given enum String */ public String get(final Enum<?> e) { return get(e == null ? null : e.name()); @@ -93,7 +93,7 @@ public final class CSVRecord implements Serializable, Iterable<String> { * * @param i * a column index (0-based) - * @return the String at the given index + * @return The String at the given index */ public String get(final int i) { return values[i]; @@ -112,7 +112,7 @@ public final class CSVRecord implements Serializable, Iterable<String> { * * @param name * the name of the column to be retrieved. - * @return the column value, maybe null depending on {@link CSVFormat#getNullString()}. + * @return The column value, maybe null depending on {@link CSVFormat#getNullString()}. * @throws IllegalStateException * if no header mapping was provided. * @throws IllegalArgumentException @@ -143,7 +143,7 @@ public final class CSVRecord implements Serializable, Iterable<String> { /** * Returns the starting position of this record in the source stream, measured in bytes. * - * @return the byte position of this record in the source stream. + * @return The byte position of this record in the source stream. * @since 1.13.0 */ public long getBytePosition() { @@ -154,7 +154,7 @@ public final class CSVRecord implements Serializable, Iterable<String> { * Returns the start position of this record as a character position in the source stream. This may or may not * correspond to the byte position depending on the character set. * - * @return the position of this record in the source stream. + * @return The position of this record in the source stream. */ public long getCharacterPosition() { return characterPosition; @@ -166,7 +166,7 @@ public final class CSVRecord implements Serializable, Iterable<String> { * If there is no following record (that is, the comment is at EOF), * then the comment will be ignored. * - * @return the comment for this record, or null if no comment for this record is available. + * @return The comment for this record, or null if no comment for this record is available. */ public String getComment() { return comment; @@ -184,7 +184,7 @@ public final class CSVRecord implements Serializable, Iterable<String> { * should be used when the record may have originated from a serialized form. * </p> * - * @return the parser. + * @return The parser. * @since 1.7 */ public CSVParser getParser() { @@ -199,7 +199,7 @@ public final class CSVRecord implements Serializable, Iterable<String> { * the current line number of the parser that created this record. * </p> * - * @return the number of this record. + * @return The number of this record. * @see CSVParser#getCurrentLineNumber() */ public long getRecordNumber() { @@ -283,7 +283,7 @@ public final class CSVRecord implements Serializable, Iterable<String> { * * @param <M> The map type. * @param map The Map to populate. - * @return the given map. + * @return The given map. * @since 1.9.0 */ public <M extends Map<String, String>> M putIn(final M map) { @@ -301,7 +301,7 @@ public final class CSVRecord implements Serializable, Iterable<String> { /** * Returns the number of values in this record. * - * @return the number of values. + * @return The number of values. */ public int size() { return values.length; @@ -310,7 +310,7 @@ public final class CSVRecord implements Serializable, Iterable<String> { /** * Returns a sequential ordered stream whose elements are the values. * - * @return the new stream. + * @return The new stream. * @since 1.9.0 */ public Stream<String> stream() { @@ -358,7 +358,7 @@ public final class CSVRecord implements Serializable, Iterable<String> { /** * Gets the values for this record. This is <strong>not</strong> a copy. * - * @return the values for this record, never null. + * @return The values for this record, never null. * @since 1.10.0 */ public String[] values() { diff --git a/src/main/java/org/apache/commons/csv/ExtendedBufferedReader.java b/src/main/java/org/apache/commons/csv/ExtendedBufferedReader.java index 20c1ef54..d32bac8c 100644 --- a/src/main/java/org/apache/commons/csv/ExtendedBufferedReader.java +++ b/src/main/java/org/apache/commons/csv/ExtendedBufferedReader.java @@ -101,7 +101,7 @@ final class ExtendedBufferedReader extends UnsynchronizedBufferedReader { /** * Gets the number of bytes read by the reader. * - * @return the number of bytes read by the read + * @return The number of bytes read by the read */ long getBytesRead() { return this.bytesRead; @@ -139,7 +139,7 @@ final class ExtendedBufferedReader extends UnsynchronizedBufferedReader { * </ul> * * @param current the current character to process. - * @return the byte length of the character. + * @return The byte length of the character. * @throws CharacterCodingException if the character cannot be encoded. */ private int getEncodedCharLength(final int current) throws CharacterCodingException { @@ -167,7 +167,7 @@ final class ExtendedBufferedReader extends UnsynchronizedBufferedReader { * include a character read using the {@link #peek()} method. If no character has been read then this will return {@link Constants#UNDEFINED}. If the end of * the stream was reached on the last read then this will return {@link IOUtils#EOF}. * - * @return the last character that was read + * @return The last character that was read */ int getLastChar() { return lastChar; @@ -176,7 +176,7 @@ final class ExtendedBufferedReader extends UnsynchronizedBufferedReader { /** * Returns the current line number * - * @return the current line number + * @return The current line number */ long getLineNumber() { // Check if we are at EOL or EOF or just starting @@ -189,7 +189,7 @@ final class ExtendedBufferedReader extends UnsynchronizedBufferedReader { /** * Gets the character position in the reader. * - * @return the current position in the reader (counting characters, not bytes since this is a Reader) + * @return The current position in the reader (counting characters, not bytes since this is a Reader) */ long getPosition() { return this.position; @@ -255,7 +255,7 @@ final class ExtendedBufferedReader extends UnsynchronizedBufferedReader { * Sets {@link #lastChar} to {@code Constants.EOF} at EOF, otherwise the last EOL character. * </p> * - * @return the line that was read, or null if reached EOF. + * @return The line that was read, or null if reached EOF. */ @Override public String readLine() throws IOException { diff --git a/src/main/java/org/apache/commons/csv/Lexer.java b/src/main/java/org/apache/commons/csv/Lexer.java index fe964480..60402d1b 100644 --- a/src/main/java/org/apache/commons/csv/Lexer.java +++ b/src/main/java/org/apache/commons/csv/Lexer.java @@ -100,7 +100,7 @@ final class Lexer implements Closeable { /** * Gets the number of bytes read. * - * @return the number of bytes read. + * @return The number of bytes read. */ long getBytesRead() { return reader.getBytesRead(); @@ -109,7 +109,7 @@ final class Lexer implements Closeable { /** * Gets the current character position. * - * @return the current character position. + * @return The current character position. */ long getCharacterPosition() { return reader.getPosition(); @@ -118,7 +118,7 @@ final class Lexer implements Closeable { /** * Gets the current line number. * - * @return the current line number. + * @return The current line number. */ long getCurrentLineNumber() { return reader.getLineNumber(); @@ -231,7 +231,7 @@ final class Lexer implements Closeable { * </p> * * @param token an existing Token object to reuse. The caller is responsible for initializing the Token. - * @return the next token found. + * @return The next token found. * @throws IOException on stream access error. * @throws CSVException Thrown on invalid input. */ @@ -412,7 +412,7 @@ final class Lexer implements Closeable { * * @param token the current token. * @param ch the current character. - * @return the filled token. + * @return The filled token. * @throws IOException on stream access error. * @throws CSVException Thrown on invalid input. */ @@ -482,7 +482,7 @@ final class Lexer implements Closeable { * Handle an escape sequence. The current character must be the escape character. On return, the next character is available by calling * {@link ExtendedBufferedReader#getLastChar()} on the input stream. * - * @return the unescaped character (as an int) or {@link IOUtils#EOF} if char following the escape is invalid. + * @return The unescaped character (as an int) or {@link IOUtils#EOF} if char following the escape is invalid. * @throws IOException if there is a problem reading the stream or the end of stream is detected: the escape character is not allowed at end of stream * @throws CSVException Thrown on invalid input. */ diff --git a/src/test/java/org/apache/commons/csv/CSVDuplicateHeaderTest.java b/src/test/java/org/apache/commons/csv/CSVDuplicateHeaderTest.java index 2f518a12..8a64c7f9 100644 --- a/src/test/java/org/apache/commons/csv/CSVDuplicateHeaderTest.java +++ b/src/test/java/org/apache/commons/csv/CSVDuplicateHeaderTest.java @@ -51,7 +51,7 @@ class CSVDuplicateHeaderTest { * for each test case. * </p> * - * @return the stream of arguments + * @return The stream of arguments */ static Stream<Arguments> duplicateHeaderAllowsMissingColumnsNamesData() { return duplicateHeaderData() @@ -82,7 +82,7 @@ class CSVDuplicateHeaderTest { * boolean valid * </pre> * - * @return the stream of arguments + * @return The stream of arguments */ static Stream<Arguments> duplicateHeaderData() { return Stream.of(
