Skip to content

Commit

Permalink
Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Sep 15, 2024
1 parent e5fa9c9 commit 560a699
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
14 changes: 13 additions & 1 deletion src/main/java/org/apache/commons/csv/CSVFormat.java
Original file line number Diff line number Diff line change
Expand Up @@ -1441,15 +1441,19 @@ public static CSVFormat valueOf(final String format) {
return CSVFormat.Predefined.valueOf(format).getFormat();
}

/** How duplicate headers are handled. */
private final DuplicateHeaderMode duplicateHeaderMode;

/** Whether missing column names are allowed when parsing the header line. */
private final boolean allowMissingColumnNames;

/** Whether to flush on close. */
private final boolean autoFlush;

/** Set to null if commenting is disabled. */
private final Character commentMarker;

/** The character delimiting the values (typically ";", "," or "\t"). */
private final String delimiter;

/** Set to null if escaping is disabled. */
Expand All @@ -1461,12 +1465,13 @@ public static CSVFormat valueOf(final String format) {
/** Array of header comment lines. */
private final String[] headerComments;

/** Whether empty lines between records are ignored when parsing input. */
private final boolean ignoreEmptyLines;

/** Should ignore header names case. */
private final boolean ignoreHeaderCase;

/** TODO Should leading/trailing spaces be ignored around values?. */
/** Should leading/trailing spaces be ignored around values?. */
private final boolean ignoreSurroundingSpaces;

/** The string to be used for null values. */
Expand All @@ -1475,21 +1480,28 @@ public static CSVFormat valueOf(final String format) {
/** Set to null if quoting is disabled. */
private final Character quoteCharacter;

/** Set to {@code quoteCharacter + nullString + quoteCharacter} */
private final String quotedNullString;

/** The quote policy output fields. */
private final QuoteMode quoteMode;

/** For output. */
private final String recordSeparator;

/** Whether to skip the header record. */
private final boolean skipHeaderRecord;

/** Whether reading end-of-file is allowed even when input is malformed, helps Excel compatibility. */
private final boolean lenientEof;

/** Whether reading trailing data is allowed in records, helps Excel compatibility. */
private final boolean trailingData;

/** Whether to add a trailing delimiter. */
private final boolean trailingDelimiter;

/** Whether to trim leading and trailing blanks. */
private final boolean trim;

private CSVFormat(final Builder builder) {
Expand Down
4 changes: 4 additions & 0 deletions src/main/java/org/apache/commons/csv/CSVRecord.java
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ public final class CSVRecord implements Serializable, Iterable<String> {

private static final long serialVersionUID = 1L;

/**
* 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.
*/
private final long characterPosition;

/** The accumulated comments (if any) */
Expand Down

0 comments on commit 560a699

Please sign in to comment.