Skip to content

Commit e28d4e9

Browse files
committed
Javadoc.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1459447 13f79535-47bb-0310-9956-ffa450edef68
1 parent 6e2c992 commit e28d4e9

2 files changed

Lines changed: 17 additions & 2 deletions

File tree

src/main/java/org/apache/commons/csv/CSVFormat.java

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,13 @@ public static CSVFormatBuilder newBuilder(final char delimiter) {
136136
return new CSVFormatBuilder(delimiter);
137137
}
138138

139+
/**
140+
* Creates a CSVFormatBuilder, using the values of the given CSVFormat.
141+
*
142+
* @param format
143+
* The format to use values from
144+
* @return a new CSVFormatBuilder
145+
*/
139146
public static CSVFormatBuilder newBuilder(final CSVFormat format) {
140147
return new CSVFormatBuilder(format);
141148
}
@@ -326,6 +333,7 @@ String[] getHeader() {
326333
*
327334
* @param in
328335
* the input stream
336+
* @throws IOException
329337
*/
330338
public Iterable<CSVRecord> parse(final Reader in) throws IOException {
331339
return new CSVParser(in, this);
@@ -484,6 +492,9 @@ else if (!recordSeparator.equals(other.recordSeparator))
484492
return true;
485493
}
486494

495+
/**
496+
* Builds CSVFormat objects.
497+
*/
487498
public static class CSVFormatBuilder {
488499

489500
private char delimiter;
@@ -540,7 +551,6 @@ public static class CSVFormatBuilder {
540551
}
541552

542553
/**
543-
*
544554
* Creates a CSVFormatBuilder, using the values of the given CSVFormat.
545555
*
546556
* @param format
@@ -567,6 +577,11 @@ public static class CSVFormatBuilder {
567577
this(delimiter, null, null, null, null, false, false, null, null);
568578
}
569579

580+
/**
581+
* Builds a new CSVFormat configured with the values from this builder.
582+
*
583+
* @return a new CSVFormat
584+
*/
570585
public CSVFormat build() {
571586
validate();
572587
return new CSVFormat(delimiter, quoteChar, quotePolicy, commentStart, escape,

src/main/java/org/apache/commons/csv/CSVParser.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ public CSVParser(final Reader input) throws IOException {
9696
* Customized CSV parser using the given {@link CSVFormat}
9797
*
9898
* @param input
99-
* a Reader containing "csv-formatted" input
99+
* a Reader containing CSV-formatted input
100100
* @param format
101101
* the CSVFormat used for CSV parsing
102102
* @throws IllegalArgumentException

0 commit comments

Comments
 (0)