Apache
/
commons-csv
mirror of https://github.com/apache/commons-csv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarify JavaDoc for builder factory method, also remove trailing white spaces 

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1460134 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Benedikt Ritter 2013-03-23 12:01:25 +00:00
parent 77c6382ee5
commit 9bafed6b23
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/main/java/org/apache/commons/csv/CSVFormat.java
View File

@ -141,7 +141,7 @@ public class CSVFormat implements Serializable {
* *
* @param format * @param format
* The format to use values from * The format to use values from
* @return a new CSVFormatBuilder * @return a new CSVFormatBuilder
*/ */
public static CSVFormatBuilder newBuilder(final CSVFormat format) { public static CSVFormatBuilder newBuilder(final CSVFormat format) {
return new CSVFormatBuilder(format); return new CSVFormatBuilder(format);
@ -155,6 +155,9 @@ public class CSVFormat implements Serializable {
* <li>withEmptyLinesIgnored(true)</li> * <li>withEmptyLinesIgnored(true)</li>
* <li>withLineSeparator(CRLF)</li> * <li>withLineSeparator(CRLF)</li>
* </ul> * </ul>
*
* Shortcut for {@code CSVFormat.newBuilder(CSVFormat.DEFAULT)}
*
* @return a standard comma separated format builder, as for {@link #RFC4180} but allowing empty lines. * @return a standard comma separated format builder, as for {@link #RFC4180} but allowing empty lines.
*/ */
public static CSVFormatBuilder newBuilder() { public static CSVFormatBuilder newBuilder() {
@ -333,7 +336,7 @@ public class CSVFormat implements Serializable {
* *
* @param in * @param in
* the input stream * the input stream
* @throws IOException * @throws IOException
*/ */
public Iterable<CSVRecord> parse(final Reader in) throws IOException { public Iterable<CSVRecord> parse(final Reader in) throws IOException {
return new CSVParser(in, this); return new CSVParser(in, this);
@ -579,7 +582,7 @@ public class CSVFormat implements Serializable {
/** /**
* Builds a new CSVFormat configured with the values from this builder. * Builds a new CSVFormat configured with the values from this builder.
* *
* @return a new CSVFormat * @return a new CSVFormat
*/ */
public CSVFormat build() { public CSVFormat build() {