You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2013/03/26 23:16:20 UTC
svn commit: r856056 [1/26] - in
/websites/production/commons/content/proper/commons-csv: ./ apidocs/
apidocs/org/apache/commons/csv/ apidocs/org/apache/commons/csv/class-use/
apidocs/src-html/org/apache/commons/csv/ cobertura/ testapidocs/
testapidocs/...
Author: ggregory
Date: Tue Mar 26 22:16:19 2013
New Revision: 856056
Log:
Site checkin for project Commons CSV
Modified:
websites/production/commons/content/proper/commons-csv/apidocs/index-all.html
websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html
websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVFormat.html
websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVParser.html
websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVPrinter.html
websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/class-use/CSVFormat.CSVFormatBuilder.html
websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/class-use/CSVRecord.html
websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/package-summary.html
websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/package-use.html
websites/production/commons/content/proper/commons-csv/apidocs/src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html
websites/production/commons/content/proper/commons-csv/apidocs/src-html/org/apache/commons/csv/CSVFormat.html
websites/production/commons/content/proper/commons-csv/apidocs/src-html/org/apache/commons/csv/CSVParser.html
websites/production/commons/content/proper/commons-csv/apidocs/src-html/org/apache/commons/csv/CSVPrinter.html
websites/production/commons/content/proper/commons-csv/changes-report.html
websites/production/commons/content/proper/commons-csv/checkstyle.html
websites/production/commons/content/proper/commons-csv/checkstyle.rss
websites/production/commons/content/proper/commons-csv/cobertura/frame-sourcefiles-org.apache.commons.csv.html
websites/production/commons/content/proper/commons-csv/cobertura/frame-sourcefiles.html
websites/production/commons/content/proper/commons-csv/cobertura/frame-summary-org.apache.commons.csv.html
websites/production/commons/content/proper/commons-csv/cobertura/frame-summary.html
websites/production/commons/content/proper/commons-csv/cobertura/org.apache.commons.csv.CSVFormat.html
websites/production/commons/content/proper/commons-csv/cobertura/org.apache.commons.csv.CSVLexer.html
websites/production/commons/content/proper/commons-csv/cobertura/org.apache.commons.csv.CSVParser.html
websites/production/commons/content/proper/commons-csv/cobertura/org.apache.commons.csv.CSVPrinter.html
websites/production/commons/content/proper/commons-csv/cobertura/org.apache.commons.csv.CSVRecord.html
websites/production/commons/content/proper/commons-csv/cobertura/org.apache.commons.csv.Constants.html
websites/production/commons/content/proper/commons-csv/cobertura/org.apache.commons.csv.ExtendedBufferedReader.html
websites/production/commons/content/proper/commons-csv/cobertura/org.apache.commons.csv.Lexer.html
websites/production/commons/content/proper/commons-csv/cobertura/org.apache.commons.csv.Quote.html
websites/production/commons/content/proper/commons-csv/cobertura/org.apache.commons.csv.Token.html
websites/production/commons/content/proper/commons-csv/cpd.html
websites/production/commons/content/proper/commons-csv/cvs-usage.html
websites/production/commons/content/proper/commons-csv/dependencies.html
websites/production/commons/content/proper/commons-csv/distribution-management.html
websites/production/commons/content/proper/commons-csv/downloads.html
websites/production/commons/content/proper/commons-csv/examples.html
websites/production/commons/content/proper/commons-csv/findbugs.html
websites/production/commons/content/proper/commons-csv/index.html
websites/production/commons/content/proper/commons-csv/integration.html
websites/production/commons/content/proper/commons-csv/issue-tracking.html
websites/production/commons/content/proper/commons-csv/javancss.html
websites/production/commons/content/proper/commons-csv/jdepend-report.html
websites/production/commons/content/proper/commons-csv/mail-lists.html
websites/production/commons/content/proper/commons-csv/pmd.html
websites/production/commons/content/proper/commons-csv/project-info.html
websites/production/commons/content/proper/commons-csv/project-reports.html
websites/production/commons/content/proper/commons-csv/project-summary.html
websites/production/commons/content/proper/commons-csv/rat-report.html
websites/production/commons/content/proper/commons-csv/source-repository.html
websites/production/commons/content/proper/commons-csv/surefire-report.html
websites/production/commons/content/proper/commons-csv/taglist.html
websites/production/commons/content/proper/commons-csv/team-list.html
websites/production/commons/content/proper/commons-csv/testapidocs/index-all.html
websites/production/commons/content/proper/commons-csv/testapidocs/org/apache/commons/csv/CSVFormatBuilderTest.html
websites/production/commons/content/proper/commons-csv/testapidocs/org/apache/commons/csv/CSVFormatTest.html
websites/production/commons/content/proper/commons-csv/testapidocs/org/apache/commons/csv/CSVLexerTest.html
websites/production/commons/content/proper/commons-csv/testapidocs/org/apache/commons/csv/CSVParserTest.html
websites/production/commons/content/proper/commons-csv/testapidocs/org/apache/commons/csv/CSVPrinterTest.html
websites/production/commons/content/proper/commons-csv/testapidocs/src-html/org/apache/commons/csv/CSVFileParserTest.html
websites/production/commons/content/proper/commons-csv/testapidocs/src-html/org/apache/commons/csv/CSVFormatBuilderTest.html
websites/production/commons/content/proper/commons-csv/testapidocs/src-html/org/apache/commons/csv/CSVFormatTest.html
websites/production/commons/content/proper/commons-csv/testapidocs/src-html/org/apache/commons/csv/CSVLexerTest.html
websites/production/commons/content/proper/commons-csv/testapidocs/src-html/org/apache/commons/csv/CSVParserTest.html
websites/production/commons/content/proper/commons-csv/testapidocs/src-html/org/apache/commons/csv/CSVPrinterTest.html
websites/production/commons/content/proper/commons-csv/testapidocs/src-html/org/apache/commons/csv/PerformanceTest.html
websites/production/commons/content/proper/commons-csv/xref-test/org/apache/commons/csv/CSVFileParserTest.html
websites/production/commons/content/proper/commons-csv/xref-test/org/apache/commons/csv/CSVFormatBuilderTest.html
websites/production/commons/content/proper/commons-csv/xref-test/org/apache/commons/csv/CSVFormatTest.html
websites/production/commons/content/proper/commons-csv/xref-test/org/apache/commons/csv/CSVLexerTest.html
websites/production/commons/content/proper/commons-csv/xref-test/org/apache/commons/csv/CSVParserTest.html
websites/production/commons/content/proper/commons-csv/xref-test/org/apache/commons/csv/CSVPrinterTest.html
websites/production/commons/content/proper/commons-csv/xref-test/org/apache/commons/csv/PerformanceTest.html
websites/production/commons/content/proper/commons-csv/xref/org/apache/commons/csv/CSVFormat.html
websites/production/commons/content/proper/commons-csv/xref/org/apache/commons/csv/CSVLexer.html
websites/production/commons/content/proper/commons-csv/xref/org/apache/commons/csv/CSVParser.html
websites/production/commons/content/proper/commons-csv/xref/org/apache/commons/csv/CSVPrinter.html
websites/production/commons/content/proper/commons-csv/xref/org/apache/commons/csv/ExtendedBufferedReader.html
websites/production/commons/content/proper/commons-csv/xref/org/apache/commons/csv/Lexer.html
Modified: websites/production/commons/content/proper/commons-csv/apidocs/index-all.html
==============================================================================
--- websites/production/commons/content/proper/commons-csv/apidocs/index-all.html (original)
+++ websites/production/commons/content/proper/commons-csv/apidocs/index-all.html Tue Mar 26 22:16:19 2013
@@ -91,7 +91,7 @@ Method in class org.apache.commons.csv.<
<DT><A HREF="./org/apache/commons/csv/CSVPrinter.html#close()"><B>close()</B></A> -
Method in class org.apache.commons.csv.<A HREF="./org/apache/commons/csv/CSVPrinter.html" title="class in org.apache.commons.csv">CSVPrinter</A>
<DD>
-<DT><A HREF="./org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv"><B>CSVFormat</B></A> - Class in <A HREF="./org/apache/commons/csv/package-summary.html">org.apache.commons.csv</A><DD>The format specification of a CSV file.<DT><A HREF="./org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv"><B>CSVFormat.CSVFormatBuilder</B></A> - Class in <A HREF="./org/apache/commons/csv/package-summary.html">org.apache.commons.csv</A><DD>Builds CSVFormat objects.<DT><A HREF="./org/apache/commons/csv/CSVParser.html" title="class in org.apache.commons.csv"><B>CSVParser</B></A> - Class in <A HREF="./org/apache/commons/csv/package-summary.html">org.apache.commons.csv</A><DD>Parses CSV files according to the specified configuration.<DT><A HREF="./org/apache/commons/csv/CSVParser.html#CSVParser(java.io.Reader)"><B>CSVParser(Reader)</B></A> -
+<DT><A HREF="./org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv"><B>CSVFormat</B></A> - Class in <A HREF="./org/apache/commons/csv/package-summary.html">org.apache.commons.csv</A><DD>Specifies the format of a CSV file and parses input.<DT><A HREF="./org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv"><B>CSVFormat.CSVFormatBuilder</B></A> - Class in <A HREF="./org/apache/commons/csv/package-summary.html">org.apache.commons.csv</A><DD>Builds CSVFormat objects.<DT><A HREF="./org/apache/commons/csv/CSVParser.html" title="class in org.apache.commons.csv"><B>CSVParser</B></A> - Class in <A HREF="./org/apache/commons/csv/package-summary.html">org.apache.commons.csv</A><DD>Parses CSV files according to the specified configuration.<DT><A HREF="./org/apache/commons/csv/CSVParser.html#CSVParser(java.io.Reader)"><B>CSVParser(Reader)</B></A> -
Constructor for class org.apache.commons.csv.<A HREF="./org/apache/commons/csv/CSVParser.html" title="class in org.apache.commons.csv">CSVParser</A>
<DD>CSV parser using the default <A HREF="./org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv"><CODE>CSVFormat</CODE></A>.
<DT><A HREF="./org/apache/commons/csv/CSVParser.html#CSVParser(java.io.Reader, org.apache.commons.csv.CSVFormat)"><B>CSVParser(Reader, CSVFormat)</B></A> -
@@ -132,7 +132,7 @@ Method in class org.apache.commons.csv.<
<DD>Flushes the underlying stream.
<DT><A HREF="./org/apache/commons/csv/CSVFormat.html#format(java.lang.Object...)"><B>format(Object...)</B></A> -
Method in class org.apache.commons.csv.<A HREF="./org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A>
-<DD>Format the specified values.
+<DD>Formats the specified values.
</DL>
<HR>
<A NAME="_G_"><!-- --></A><H2>
@@ -253,6 +253,9 @@ Static method in class org.apache.common
<A NAME="_P_"><!-- --></A><H2>
<B>P</B></H2>
<DL>
+<DT><A HREF="./org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#parse(java.io.Reader)"><B>parse(Reader)</B></A> -
+Method in class org.apache.commons.csv.<A HREF="./org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A>
+<DD>Parses the specified content.
<DT><A HREF="./org/apache/commons/csv/CSVFormat.html#parse(java.io.Reader)"><B>parse(Reader)</B></A> -
Method in class org.apache.commons.csv.<A HREF="./org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A>
<DD>Parses the specified content.
@@ -309,6 +312,9 @@ Method in class org.apache.commons.csv.<
<DT><A HREF="./org/apache/commons/csv/CSVFormat.html#TDF"><B>TDF</B></A> -
Static variable in class org.apache.commons.csv.<A HREF="./org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A>
<DD>Tab-delimited format, with quote; leading and trailing spaces ignored.
+<DT><A HREF="./org/apache/commons/csv/CSVFormat.html#toBuilder()"><B>toBuilder()</B></A> -
+Method in class org.apache.commons.csv.<A HREF="./org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A>
+<DD>Creates a builder based on this format.
<DT><A HREF="./org/apache/commons/csv/CSVFormat.html#toString()"><B>toString()</B></A> -
Method in class org.apache.commons.csv.<A HREF="./org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A>
<DD>
Modified: websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html
==============================================================================
--- websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html (original)
+++ websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html Tue Mar 26 22:16:19 2013
@@ -98,7 +98,7 @@ Class CSVFormat.CSVFormatBuilder</H2>
</DL>
<HR>
<DL>
-<DT><PRE>public static class <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.498"><B>CSVFormat.CSVFormatBuilder</B></A><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
+<DT><PRE>public static class <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.503"><B>CSVFormat.CSVFormatBuilder</B></A><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
</PRE>
<P>
@@ -128,6 +128,14 @@ Builds CSVFormat objects.
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><<A HREF="../../../../org/apache/commons/csv/CSVRecord.html" title="class in org.apache.commons.csv">CSVRecord</A>></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#parse(java.io.Reader)">parse</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> in)</CODE>
+
+<BR>
+ Parses the specified content.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#withCommentStart(char)">withCommentStart</A></B>(char commentStart)</CODE>
@@ -256,7 +264,7 @@ Builds CSVFormat objects.
<A NAME="build()"><!-- --></A><H3>
build</H3>
<PRE>
-public <A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.585"><B>build</B></A>()</PRE>
+public <A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.590"><B>build</B></A>()</PRE>
<DL>
<DD>Builds a new CSVFormat configured with the values from this builder.
<P>
@@ -267,10 +275,28 @@ public <A HREF="../../../../org/apache/c
</DL>
<HR>
+<A NAME="parse(java.io.Reader)"><!-- --></A><H3>
+parse</H3>
+<PRE>
+public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><<A HREF="../../../../org/apache/commons/csv/CSVRecord.html" title="class in org.apache.commons.csv">CSVRecord</A>> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.606"><B>parse</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> in)
+ throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
+<DL>
+<DD>Parses the specified content. Short-hand for:
+ <pre>format.build().parse(in);</pre>
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>in</CODE> - the input stream
+<DT><B>Returns:</B><DD>a CSVRecord stream
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - If an I/O error occurs</DL>
+</DD>
+</DL>
+<HR>
+
<A NAME="withDelimiter(char)"><!-- --></A><H3>
withDelimiter</H3>
<PRE>
-public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.636"><B>withDelimiter</B></A>(char delimiter)</PRE>
+public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.655"><B>withDelimiter</B></A>(char delimiter)</PRE>
<DL>
<DD>Sets the delimiter of the format to the specified character.
<P>
@@ -286,7 +312,7 @@ public <A HREF="../../../../org/apache/c
<A NAME="withQuoteChar(char)"><!-- --></A><H3>
withQuoteChar</H3>
<PRE>
-public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.653"><B>withQuoteChar</B></A>(char quoteChar)</PRE>
+public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.672"><B>withQuoteChar</B></A>(char quoteChar)</PRE>
<DL>
<DD>Sets the quoteChar of the format to the specified character.
<P>
@@ -302,7 +328,7 @@ public <A HREF="../../../../org/apache/c
<A NAME="withQuoteChar(java.lang.Character)"><!-- --></A><H3>
withQuoteChar</H3>
<PRE>
-public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.666"><B>withQuoteChar</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</A> quoteChar)</PRE>
+public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.685"><B>withQuoteChar</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</A> quoteChar)</PRE>
<DL>
<DD>Sets the quoteChar of the format to the specified character.
<P>
@@ -318,7 +344,7 @@ public <A HREF="../../../../org/apache/c
<A NAME="withCommentStart(char)"><!-- --></A><H3>
withCommentStart</H3>
<PRE>
-public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.685"><B>withCommentStart</B></A>(char commentStart)</PRE>
+public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.704"><B>withCommentStart</B></A>(char commentStart)</PRE>
<DL>
<DD>Sets the comment start marker of the format to the specified character.
@@ -336,7 +362,7 @@ public <A HREF="../../../../org/apache/c
<A NAME="withCommentStart(java.lang.Character)"><!-- --></A><H3>
withCommentStart</H3>
<PRE>
-public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.700"><B>withCommentStart</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</A> commentStart)</PRE>
+public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.719"><B>withCommentStart</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</A> commentStart)</PRE>
<DL>
<DD>Sets the comment start marker of the format to the specified character.
@@ -354,7 +380,7 @@ public <A HREF="../../../../org/apache/c
<A NAME="withEscape(char)"><!-- --></A><H3>
withEscape</H3>
<PRE>
-public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.717"><B>withEscape</B></A>(char escape)</PRE>
+public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.736"><B>withEscape</B></A>(char escape)</PRE>
<DL>
<DD>Sets the escape character of the format to the specified character.
<P>
@@ -370,7 +396,7 @@ public <A HREF="../../../../org/apache/c
<A NAME="withEscape(java.lang.Character)"><!-- --></A><H3>
withEscape</H3>
<PRE>
-public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.730"><B>withEscape</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</A> escape)</PRE>
+public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.749"><B>withEscape</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</A> escape)</PRE>
<DL>
<DD>Sets the escape character of the format to the specified character.
<P>
@@ -386,7 +412,7 @@ public <A HREF="../../../../org/apache/c
<A NAME="withHeader(java.lang.String...)"><!-- --></A><H3>
withHeader</H3>
<PRE>
-public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.757"><B>withHeader</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>... header)</PRE>
+public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.776"><B>withHeader</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>... header)</PRE>
<DL>
<DD>Sets the header of the format. The header can either be parsed automatically from the
input file with:
@@ -411,7 +437,7 @@ public <A HREF="../../../../org/apache/c
<A NAME="withIgnoreSurroundingSpaces(boolean)"><!-- --></A><H3>
withIgnoreSurroundingSpaces</H3>
<PRE>
-public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.770"><B>withIgnoreSurroundingSpaces</B></A>(boolean ignoreSurroundingSpaces)</PRE>
+public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.789"><B>withIgnoreSurroundingSpaces</B></A>(boolean ignoreSurroundingSpaces)</PRE>
<DL>
<DD>Sets the trimming behavior of the format.
<P>
@@ -426,7 +452,7 @@ public <A HREF="../../../../org/apache/c
<A NAME="withIgnoreEmptyLines(boolean)"><!-- --></A><H3>
withIgnoreEmptyLines</H3>
<PRE>
-public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.783"><B>withIgnoreEmptyLines</B></A>(boolean ignoreEmptyLines)</PRE>
+public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.802"><B>withIgnoreEmptyLines</B></A>(boolean ignoreEmptyLines)</PRE>
<DL>
<DD>Sets the empty line skipping behavior of the format.
<P>
@@ -441,7 +467,7 @@ public <A HREF="../../../../org/apache/c
<A NAME="withRecordSeparator(char)"><!-- --></A><H3>
withRecordSeparator</H3>
<PRE>
-public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.796"><B>withRecordSeparator</B></A>(char recordSeparator)</PRE>
+public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.815"><B>withRecordSeparator</B></A>(char recordSeparator)</PRE>
<DL>
<DD>Sets the record separator of the format to the specified character.
<P>
@@ -455,7 +481,7 @@ public <A HREF="../../../../org/apache/c
<A NAME="withRecordSeparator(java.lang.String)"><!-- --></A><H3>
withRecordSeparator</H3>
<PRE>
-public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.808"><B>withRecordSeparator</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> recordSeparator)</PRE>
+public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.827"><B>withRecordSeparator</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> recordSeparator)</PRE>
<DL>
<DD>Sets the record separator of the format to the specified String.
<P>
@@ -469,7 +495,7 @@ public <A HREF="../../../../org/apache/c
<A NAME="withQuotePolicy(org.apache.commons.csv.Quote)"><!-- --></A><H3>
withQuotePolicy</H3>
<PRE>
-public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.821"><B>withQuotePolicy</B></A>(<A HREF="../../../../org/apache/commons/csv/Quote.html" title="enum in org.apache.commons.csv">Quote</A> quotePolicy)</PRE>
+public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#line.840"><B>withQuotePolicy</B></A>(<A HREF="../../../../org/apache/commons/csv/Quote.html" title="enum in org.apache.commons.csv">Quote</A> quotePolicy)</PRE>
<DL>
<DD>Sets the output quote policy of the format to the specified value.
<P>
Modified: websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVFormat.html
==============================================================================
--- websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVFormat.html (original)
+++ websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVFormat.html Tue Mar 26 22:16:19 2013
@@ -98,19 +98,29 @@ Class CSVFormat</H2>
</DL>
<HR>
<DL>
-<DT><PRE>public class <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.41"><B>CSVFormat</B></A><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DL>
+<DT><PRE>public class <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.51"><B>CSVFormat</B></A><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DL>
</PRE>
<P>
-The format specification of a CSV file.
-
+Specifies the format of a CSV file and parses input.
+ <p>
This class is immutable.
+ </p>
+ You can extend a format through a builder. For example, to extend the Excel format with columns header, you write:
+ </p>
+ <pre>CSVFormat.EXCEL.toBuilder().withHeader("Col1", "Col2", "Col3").build();</pre>
+ <p>
+ You can parse through a format. For example, to parse an Excel file with columns header, you write:
+ </p>
+ <pre>Reader in = ...;
+CSVFormat.EXCEL.toBuilder().withHeader("Col1", "Col2", "Col3").parse(in);</pre>
+ <p>
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
- <DD>$Id: CSVFormat.java 1459447 2013-03-21 18:47:40Z ggregory $</DD>
+ <DD>$Id: CSVFormat.java 1461240 2013-03-26 17:48:22Z ggregory $</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.apache.commons.csv.CSVFormat">Serialized Form</A></DL>
<HR>
@@ -204,7 +214,7 @@ The format specification of a CSV file.
<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#format(java.lang.Object...)">format</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>... values)</CODE>
<BR>
- Format the specified values.</TD>
+ Formats the specified values.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -336,6 +346,14 @@ The format specification of a CSV file.
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#toBuilder()">toBuilder</A></B>()</CODE>
+
+<BR>
+ Creates a builder based on this format.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#toString()">toString</A></B>()</CODE>
@@ -368,9 +386,10 @@ The format specification of a CSV file.
<A NAME="RFC4180"><!-- --></A><H3>
RFC4180</H3>
<PRE>
-public static final <A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.63"><B>RFC4180</B></A></PRE>
+public static final <A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.74"><B>RFC4180</B></A></PRE>
<DL>
<DD>Comma separated format as defined by <a href="http://tools.ietf.org/html/rfc4180">RFC 4180</a>.
+ <h3>RFC 4180:</h3>
<ul>
<li>withDelimiter(',')</li>
<li>withQuoteChar('"')</li>
@@ -385,15 +404,19 @@ public static final <A HREF="../../../..
<A NAME="DEFAULT"><!-- --></A><H3>
DEFAULT</H3>
<PRE>
-public static final <A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.77"><B>DEFAULT</B></A></PRE>
+public static final <A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.92"><B>DEFAULT</B></A></PRE>
<DL>
<DD>Standard comma separated format, as for <A HREF="../../../../org/apache/commons/csv/CSVFormat.html#RFC4180"><CODE>RFC4180</CODE></A> but allowing empty lines.
+ <h3>RFC 4180:</h3>
<ul>
<li>withDelimiter(',')</li>
<li>withQuoteChar('"')</li>
- <li>withIgnoreEmptyLines(true)</li>
<li>withLineSeparator(CRLF)</li>
</ul>
+ <h3>Additional:</h3>
+ <ul>
+ <li>withIgnoreEmptyLines(true)</li>
+ </ul>
<P>
<DL>
</DL>
@@ -403,7 +426,7 @@ public static final <A HREF="../../../..
<A NAME="EXCEL"><!-- --></A><H3>
EXCEL</H3>
<PRE>
-public static final <A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.98"><B>EXCEL</B></A></PRE>
+public static final <A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.113"><B>EXCEL</B></A></PRE>
<DL>
<DD>Excel file format (using a comma as the value delimiter). Note that the actual value delimiter used by Excel is
locale dependent, it might be necessary to customize this format to accommodate to your regional settings.
@@ -429,7 +452,7 @@ public static final <A HREF="../../../..
<A NAME="TDF"><!-- --></A><H3>
TDF</H3>
<PRE>
-public static final <A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.104"><B>TDF</B></A></PRE>
+public static final <A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.119"><B>TDF</B></A></PRE>
<DL>
<DD>Tab-delimited format, with quote; leading and trailing spaces ignored.
<P>
@@ -441,7 +464,7 @@ public static final <A HREF="../../../..
<A NAME="MYSQL"><!-- --></A><H3>
MYSQL</H3>
<PRE>
-public static final <A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.118"><B>MYSQL</B></A></PRE>
+public static final <A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.133"><B>MYSQL</B></A></PRE>
<DL>
<DD>Default MySQL format used by the <tt>SELECT INTO OUTFILE</tt> and <tt>LOAD DATA INFILE</tt> operations. This is
a tab-delimited format with a LF character as the line separator. Values are not quoted and special characters
@@ -465,7 +488,7 @@ public static final <A HREF="../../../..
<A NAME="newBuilder(char)"><!-- --></A><H3>
newBuilder</H3>
<PRE>
-public static <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.135"><B>newBuilder</B></A>(char delimiter)</PRE>
+public static <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.150"><B>newBuilder</B></A>(char delimiter)</PRE>
<DL>
<DD>Creates a new CSV format builder.
<P>
@@ -484,7 +507,7 @@ public static <A HREF="../../../../org/a
<A NAME="newBuilder(org.apache.commons.csv.CSVFormat)"><!-- --></A><H3>
newBuilder</H3>
<PRE>
-public static <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.146"><B>newBuilder</B></A>(<A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A> format)</PRE>
+public static <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.161"><B>newBuilder</B></A>(<A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A> format)</PRE>
<DL>
<DD>Creates a CSVFormatBuilder, using the values of the given CSVFormat.
<P>
@@ -501,7 +524,7 @@ public static <A HREF="../../../../org/a
<A NAME="newBuilder()"><!-- --></A><H3>
newBuilder</H3>
<PRE>
-public static <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.160"><B>newBuilder</B></A>()</PRE>
+public static <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.178"><B>newBuilder</B></A>()</PRE>
<DL>
<DD>Creates a standard comma separated format builder, as for <A HREF="../../../../org/apache/commons/csv/CSVFormat.html#RFC4180"><CODE>RFC4180</CODE></A> but allowing empty lines.
<ul>
@@ -510,6 +533,8 @@ public static <A HREF="../../../../org/a
<li>withEmptyLinesIgnored(true)</li>
<li>withLineSeparator(CRLF)</li>
</ul>
+
+ Shortcut for <code>CSVFormat.newBuilder(CSVFormat.DEFAULT)</code>
<P>
<DD><DL>
</DL>
@@ -524,7 +549,7 @@ public static <A HREF="../../../../org/a
<A NAME="getDelimiter()"><!-- --></A><H3>
getDelimiter</H3>
<PRE>
-public char <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.238"><B>getDelimiter</B></A>()</PRE>
+public char <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.256"><B>getDelimiter</B></A>()</PRE>
<DL>
<DD>Returns the character delimiting the values (typically ';', ',' or '\t').
<P>
@@ -541,7 +566,7 @@ public char <A HREF="../../../../src-htm
<A NAME="getQuoteChar()"><!-- --></A><H3>
getQuoteChar</H3>
<PRE>
-public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.247"><B>getQuoteChar</B></A>()</PRE>
+public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.265"><B>getQuoteChar</B></A>()</PRE>
<DL>
<DD>Returns the character used to encapsulate values containing special characters.
<P>
@@ -558,7 +583,7 @@ public <A HREF="http://download.oracle.c
<A NAME="isQuoting()"><!-- --></A><H3>
isQuoting</H3>
<PRE>
-public boolean <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.256"><B>isQuoting</B></A>()</PRE>
+public boolean <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.274"><B>isQuoting</B></A>()</PRE>
<DL>
<DD>Returns whether an quoteChar has been defined.
<P>
@@ -575,7 +600,7 @@ public boolean <A HREF="../../../../src-
<A NAME="getCommentStart()"><!-- --></A><H3>
getCommentStart</H3>
<PRE>
-public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.265"><B>getCommentStart</B></A>()</PRE>
+public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.283"><B>getCommentStart</B></A>()</PRE>
<DL>
<DD>Returns the character marking the start of a line comment.
<P>
@@ -592,7 +617,7 @@ public <A HREF="http://download.oracle.c
<A NAME="isCommentingEnabled()"><!-- --></A><H3>
isCommentingEnabled</H3>
<PRE>
-public boolean <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.276"><B>isCommentingEnabled</B></A>()</PRE>
+public boolean <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.294"><B>isCommentingEnabled</B></A>()</PRE>
<DL>
<DD>Specifies whether comments are supported by this format.
@@ -611,7 +636,7 @@ public boolean <A HREF="../../../../src-
<A NAME="getEscape()"><!-- --></A><H3>
getEscape</H3>
<PRE>
-public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.285"><B>getEscape</B></A>()</PRE>
+public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Character.html?is-external=true" title="class or interface in java.lang">Character</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.303"><B>getEscape</B></A>()</PRE>
<DL>
<DD>Returns the escape character.
<P>
@@ -628,7 +653,7 @@ public <A HREF="http://download.oracle.c
<A NAME="isEscaping()"><!-- --></A><H3>
isEscaping</H3>
<PRE>
-public boolean <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.294"><B>isEscaping</B></A>()</PRE>
+public boolean <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.312"><B>isEscaping</B></A>()</PRE>
<DL>
<DD>Returns whether escape are being processed.
<P>
@@ -645,7 +670,7 @@ public boolean <A HREF="../../../../src-
<A NAME="getIgnoreSurroundingSpaces()"><!-- --></A><H3>
getIgnoreSurroundingSpaces</H3>
<PRE>
-public boolean <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.304"><B>getIgnoreSurroundingSpaces</B></A>()</PRE>
+public boolean <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.322"><B>getIgnoreSurroundingSpaces</B></A>()</PRE>
<DL>
<DD>Specifies whether spaces around values are ignored when parsing input.
<P>
@@ -663,7 +688,7 @@ public boolean <A HREF="../../../../src-
<A NAME="getIgnoreEmptyLines()"><!-- --></A><H3>
getIgnoreEmptyLines</H3>
<PRE>
-public boolean <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.314"><B>getIgnoreEmptyLines</B></A>()</PRE>
+public boolean <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.332"><B>getIgnoreEmptyLines</B></A>()</PRE>
<DL>
<DD>Specifies whether empty lines between records are ignored when parsing input.
<P>
@@ -681,7 +706,7 @@ public boolean <A HREF="../../../../src-
<A NAME="getRecordSeparator()"><!-- --></A><H3>
getRecordSeparator</H3>
<PRE>
-public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.323"><B>getRecordSeparator</B></A>()</PRE>
+public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.341"><B>getRecordSeparator</B></A>()</PRE>
<DL>
<DD>Returns the line separator delimiting output records.
<P>
@@ -698,7 +723,7 @@ public <A HREF="http://download.oracle.c
<A NAME="parse(java.io.Reader)"><!-- --></A><H3>
parse</H3>
<PRE>
-public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><<A HREF="../../../../org/apache/commons/csv/CSVRecord.html" title="class in org.apache.commons.csv">CSVRecord</A>> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.338"><B>parse</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> in)
+public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><<A HREF="../../../../org/apache/commons/csv/CSVRecord.html" title="class in org.apache.commons.csv">CSVRecord</A>> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.358"><B>parse</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> in)
throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Parses the specified content.
@@ -708,8 +733,9 @@ public <A HREF="http://download.oracle.c
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>in</CODE> - the input stream
+<DT><B>Returns:</B><DD>a stream of CSVRecord
<DT><B>Throws:</B>
-<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
+<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - If an I/O error occurs</DL>
</DD>
</DL>
<HR>
@@ -717,15 +743,16 @@ public <A HREF="http://download.oracle.c
<A NAME="format(java.lang.Object...)"><!-- --></A><H3>
format</H3>
<PRE>
-public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.348"><B>format</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>... values)</PRE>
+public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.369"><B>format</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>... values)</PRE>
<DL>
-<DD>Format the specified values.
+<DD>Formats the specified values.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>values</CODE> - the values to format</DL>
+<DT><B>Parameters:</B><DD><CODE>values</CODE> - the values to format
+<DT><B>Returns:</B><DD>the formatted values</DL>
</DD>
</DL>
<HR>
@@ -733,7 +760,7 @@ public <A HREF="http://download.oracle.c
<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
-public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.360"><B>toString</B></A>()</PRE>
+public <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.381"><B>toString</B></A>()</PRE>
<DL>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
@@ -747,7 +774,7 @@ public <A HREF="http://download.oracle.c
<A NAME="getQuotePolicy()"><!-- --></A><H3>
getQuotePolicy</H3>
<PRE>
-public <A HREF="../../../../org/apache/commons/csv/Quote.html" title="enum in org.apache.commons.csv">Quote</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.389"><B>getQuotePolicy</B></A>()</PRE>
+public <A HREF="../../../../org/apache/commons/csv/Quote.html" title="enum in org.apache.commons.csv">Quote</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.410"><B>getQuotePolicy</B></A>()</PRE>
<DL>
<DD>Returns the quote policy output fields.
<P>
@@ -764,7 +791,7 @@ public <A HREF="../../../../org/apache/c
<A NAME="hashCode()"><!-- --></A><H3>
hashCode</H3>
<PRE>
-public int <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.394"><B>hashCode</B></A>()</PRE>
+public int <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.415"><B>hashCode</B></A>()</PRE>
<DL>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
@@ -778,7 +805,7 @@ public int <A HREF="../../../../src-html
<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
-public boolean <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.412"><B>equals</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> obj)</PRE>
+public boolean <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.433"><B>equals</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> obj)</PRE>
<DL>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
@@ -787,6 +814,23 @@ public boolean <A HREF="../../../../src-
</DL>
</DD>
</DL>
+<HR>
+
+<A NAME="toBuilder()"><!-- --></A><H3>
+toBuilder</H3>
+<PRE>
+public <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A> <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.496"><B>toBuilder</B></A>()</PRE>
+<DL>
+<DD>Creates a builder based on this format.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>a new builder</DL>
+</DD>
+</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
Modified: websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVParser.html
==============================================================================
--- websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVParser.html (original)
+++ websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVParser.html Tue Mar 26 22:16:19 2013
@@ -98,7 +98,7 @@ Class CSVParser</H2>
</DL>
<HR>
<DL>
-<DT><PRE>public class <A HREF="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.71"><B>CSVParser</B></A><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><<A HREF="../../../../org/apache/commons/csv/CSVRecord.html" title="class in org.apache.commons.csv">CSVRecord</A>></DL>
+<DT><PRE>public class <A HREF="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.83"><B>CSVParser</B></A><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><<A HREF="../../../../org/apache/commons/csv/CSVRecord.html" title="class in org.apache.commons.csv">CSVRecord</A>></DL>
</PRE>
<P>
@@ -108,28 +108,40 @@ Parses CSV files according to the specif
specification of a <A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv"><CODE>CSVFormat</CODE></A>.
<p>
- Parsing of a csv-string having tabs as separators, '"' as an optional value encapsulator, and comments starting with
- '#':
+ To parse a CSV input with tabs as separators, '"' (double-quote) as an optional value encapsulator,
+ and comments starting with '#', you write:
</p>
<pre>
- CSVFormat format = new CSVFormat('\t', '"', '#');
Reader in = new StringReader("a\tb\nc\td");
- List<CSVRecord> records = new CSVParser(in, format).getRecords();
+ Iterable<CSVRecord> parser = CSVFormat.newBuilder()
+ .withCommentStart('#')
+ .withDelimiter('\t')
+ .withQuoteChar('"').parse(in);
+ for (CSVRecord csvRecord : parse) {
+ ...
+ }
</pre>
<p>
- Parsing of a csv-string in Excel CSV format, using a for-each loop:
+ To parse CSV input in a given format like Excel, you write:
</p>
<pre>
Reader in = new StringReader("a;b\nc;d");
- CSVParser parser = new CSVParser(in, CSVFormat.EXCEL);
+ Iterable<CSVRecord> parser = CSVFormat.EXCEL.parse(in);
for (CSVRecord record : parser) {
...
}
</pre>
-
+ <p>
+ You may also get a List of records:
+ </p>
+ <pre>
+ Reader in = new StringReader("a;b\nc;d");
+ CSVParser parser = new CSVParser(in, CSVFormat.EXCEL);
+ List<CSVRecord> list = parser.getRecords();
+ </pre>
<p>
Internal parser state is completely covered by the format and the reader-state.
</p>
@@ -142,7 +154,7 @@ Parses CSV files according to the specif
<P>
<DL>
<DT><B>Version:</B></DT>
- <DD>$Id: CSVParser.java 1459447 2013-03-21 18:47:40Z ggregory $</DD>
+ <DD>$Id: CSVParser.java 1461307 2013-03-26 20:52:28Z ggregory $</DD>
</DL>
<HR>
@@ -253,7 +265,7 @@ Parses CSV files according to the specif
<A NAME="CSVParser(java.io.Reader)"><!-- --></A><H3>
CSVParser</H3>
<PRE>
-public <A HREF="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.91"><B>CSVParser</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> input)
+public <A HREF="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.105"><B>CSVParser</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> input)
throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>CSV parser using the default <A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv"><CODE>CSVFormat</CODE></A>.
@@ -262,14 +274,14 @@ public <A HREF="../../../../src-html/org
<DT><B>Parameters:</B><DD><CODE>input</CODE> - a Reader containing "csv-formatted" input
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - thrown if the parameters of the format are inconsistent
-<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
+<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - If an I/O error occurs</DL>
</DL>
<HR>
<A NAME="CSVParser(java.io.Reader, org.apache.commons.csv.CSVFormat)"><!-- --></A><H3>
CSVParser</H3>
<PRE>
-public <A HREF="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.105"><B>CSVParser</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> input,
+public <A HREF="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.121"><B>CSVParser</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> input,
<A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A> format)
throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
<DL>
@@ -279,14 +291,14 @@ public <A HREF="../../../../src-html/org
<DT><B>Parameters:</B><DD><CODE>input</CODE> - a Reader containing CSV-formatted input<DD><CODE>format</CODE> - the CSVFormat used for CSV parsing
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - thrown if the parameters of the format are inconsistent
-<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
+<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - If an I/O error occurs</DL>
</DL>
<HR>
<A NAME="CSVParser(java.lang.String, org.apache.commons.csv.CSVFormat)"><!-- --></A><H3>
CSVParser</H3>
<PRE>
-public <A HREF="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.120"><B>CSVParser</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> input,
+public <A HREF="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.138"><B>CSVParser</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> input,
<A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A> format)
throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
<DL>
@@ -296,7 +308,7 @@ public <A HREF="../../../../src-html/org
<DT><B>Parameters:</B><DD><CODE>input</CODE> - a String containing "csv-formatted" input<DD><CODE>format</CODE> - the CSVFormat used for CSV parsing
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - thrown if the parameters of the format are inconsistent
-<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
+<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - If an I/O error occurs</DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
@@ -312,7 +324,7 @@ public <A HREF="../../../../src-html/org
<A NAME="getHeaderMap()"><!-- --></A><H3>
getHeaderMap</H3>
<PRE>
-public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</A>> <A HREF="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.132"><B>getHeaderMap</B></A>()</PRE>
+public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>,<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</A>> <A HREF="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.150"><B>getHeaderMap</B></A>()</PRE>
<DL>
<DD>Returns a copy of the header map that iterates in column order.
<p>
@@ -332,7 +344,7 @@ public <A HREF="http://download.oracle.c
<A NAME="getLineNumber()"><!-- --></A><H3>
getLineNumber</H3>
<PRE>
-public long <A HREF="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.143"><B>getLineNumber</B></A>()</PRE>
+public long <A HREF="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.161"><B>getLineNumber</B></A>()</PRE>
<DL>
<DD>Returns the current line number in the input stream.
<p/>
@@ -351,7 +363,7 @@ public long <A HREF="../../../../src-htm
<A NAME="getRecordNumber()"><!-- --></A><H3>
getRecordNumber</H3>
<PRE>
-public long <A HREF="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.154"><B>getRecordNumber</B></A>()</PRE>
+public long <A HREF="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.172"><B>getRecordNumber</B></A>()</PRE>
<DL>
<DD>Returns the current record number in the input stream.
<p/>
@@ -370,7 +382,7 @@ public long <A HREF="../../../../src-htm
<A NAME="getRecords()"><!-- --></A><H3>
getRecords</H3>
<PRE>
-public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../org/apache/commons/csv/CSVRecord.html" title="class in org.apache.commons.csv">CSVRecord</A>> <A HREF="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.216"><B>getRecords</B></A>()
+public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../org/apache/commons/csv/CSVRecord.html" title="class in org.apache.commons.csv">CSVRecord</A>> <A HREF="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.234"><B>getRecords</B></A>()
throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Parses the CSV input according to the given format and returns the content as an array of <A HREF="../../../../org/apache/commons/csv/CSVRecord.html" title="class in org.apache.commons.csv"><CODE>CSVRecord</CODE></A>
@@ -393,7 +405,7 @@ public <A HREF="http://download.oracle.c
<A NAME="iterator()"><!-- --></A><H3>
iterator</H3>
<PRE>
-public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../../org/apache/commons/csv/CSVRecord.html" title="class in org.apache.commons.csv">CSVRecord</A>> <A HREF="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.258"><B>iterator</B></A>()</PRE>
+public <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</A><<A HREF="../../../../org/apache/commons/csv/CSVRecord.html" title="class in org.apache.commons.csv">CSVRecord</A>> <A HREF="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.276"><B>iterator</B></A>()</PRE>
<DL>
<DD>Returns an iterator on the records. IOExceptions occurring during the iteration are wrapped in a
RuntimeException.
Modified: websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVPrinter.html
==============================================================================
--- websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVPrinter.html (original)
+++ websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVPrinter.html Tue Mar 26 22:16:19 2013
@@ -108,7 +108,7 @@ Prints values in a CSV format.
<P>
<DL>
<DT><B>Version:</B></DT>
- <DD>$Id: CSVPrinter.java 1458805 2013-03-20 12:43:43Z britter $</DD>
+ <DD>$Id: CSVPrinter.java 1461240 2013-03-26 17:48:22Z ggregory $</DD>
</DL>
<HR>
@@ -272,7 +272,7 @@ public <A HREF="../../../../src-html/org
<A NAME="println()"><!-- --></A><H3>
println</H3>
<PRE>
-public void <A HREF="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.71"><B>println</B></A>()
+public void <A HREF="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.74"><B>println</B></A>()
throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Outputs the line separator.
@@ -283,7 +283,7 @@ public void <A HREF="../../../../src-htm
<DD><DL>
<DT><B>Throws:</B>
-<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
+<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - If an I/O error occurs</DL>
</DD>
</DL>
<HR>
@@ -291,7 +291,7 @@ public void <A HREF="../../../../src-htm
<A NAME="flush()"><!-- --></A><H3>
flush</H3>
<PRE>
-public void <A HREF="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.81"><B>flush</B></A>()
+public void <A HREF="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.85"><B>flush</B></A>()
throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Flushes the underlying stream.
@@ -302,7 +302,7 @@ public void <A HREF="../../../../src-htm
<DD><DL>
<DT><B>Throws:</B>
-<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
+<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - If an I/O error occurs</DL>
</DD>
</DL>
<HR>
@@ -310,7 +310,7 @@ public void <A HREF="../../../../src-htm
<A NAME="printRecord(java.lang.Object...)"><!-- --></A><H3>
printRecord</H3>
<PRE>
-public void <A HREF="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.94"><B>printRecord</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>... values)
+public void <A HREF="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.100"><B>printRecord</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>... values)
throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Prints a single line of delimiter separated values. The values will be quoted if needed. Quotes and newLine
@@ -322,7 +322,7 @@ public void <A HREF="../../../../src-htm
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>values</CODE> - values to output.
<DT><B>Throws:</B>
-<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
+<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - If an I/O error occurs</DL>
</DD>
</DL>
<HR>
@@ -330,7 +330,7 @@ public void <A HREF="../../../../src-htm
<A NAME="printRecord(java.lang.Iterable)"><!-- --></A><H3>
printRecord</H3>
<PRE>
-public void <A HREF="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.108"><B>printRecord</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><?> values)
+public void <A HREF="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.116"><B>printRecord</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><?> values)
throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Prints a single line of delimiter separated values. The values will be quoted if needed. Quotes and newLine
@@ -342,7 +342,7 @@ public void <A HREF="../../../../src-htm
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>values</CODE> - values to output.
<DT><B>Throws:</B>
-<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
+<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - If an I/O error occurs</DL>
</DD>
</DL>
<HR>
@@ -350,7 +350,7 @@ public void <A HREF="../../../../src-htm
<A NAME="printComment(java.lang.String)"><!-- --></A><H3>
printComment</H3>
<PRE>
-public void <A HREF="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.125"><B>printComment</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> comment)
+public void <A HREF="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.135"><B>printComment</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> comment)
throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Prints a comment on a new line among the delimiter separated values. Comments will always begin on a new line
@@ -365,7 +365,7 @@ public void <A HREF="../../../../src-htm
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>comment</CODE> - the comment to output
<DT><B>Throws:</B>
-<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL>
+<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - If an I/O error occurs</DL>
</DD>
</DL>
<HR>
@@ -373,7 +373,7 @@ public void <A HREF="../../../../src-htm
<A NAME="print(java.lang.Object)"><!-- --></A><H3>
print</H3>
<PRE>
-public void <A HREF="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.335"><B>print</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> value)
+public void <A HREF="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.345"><B>print</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> value)
throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Prints the string as the next value on the line. The value will be escaped or encapsulated as needed.
@@ -392,7 +392,7 @@ public void <A HREF="../../../../src-htm
<A NAME="printRecords(java.lang.Object[])"><!-- --></A><H3>
printRecords</H3>
<PRE>
-public void <A HREF="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.349"><B>printRecords</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>[] values)
+public void <A HREF="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.359"><B>printRecords</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>[] values)
throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Prints all the objects in the given array.
@@ -411,7 +411,7 @@ public void <A HREF="../../../../src-htm
<A NAME="printRecords(java.lang.Iterable)"><!-- --></A><H3>
printRecords</H3>
<PRE>
-public void <A HREF="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.369"><B>printRecords</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><?> values)
+public void <A HREF="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.379"><B>printRecords</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><?> values)
throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Prints all the objects in the given collection.
@@ -430,7 +430,7 @@ public void <A HREF="../../../../src-htm
<A NAME="printRecords(java.sql.ResultSet)"><!-- --></A><H3>
printRecords</H3>
<PRE>
-public void <A HREF="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.389"><B>printRecords</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</A> resultSet)
+public void <A HREF="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.400"><B>printRecords</B></A>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/sql/ResultSet.html?is-external=true" title="class or interface in java.sql">ResultSet</A> resultSet)
throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A>,
<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
<DL>
@@ -444,7 +444,7 @@ public void <A HREF="../../../../src-htm
the values to print.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE> - If an I/O error occurs
-<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE></DL>
+<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/sql/SQLException.html?is-external=true" title="class or interface in java.sql">SQLException</A></CODE> - if a database access error occurs</DL>
</DD>
</DL>
<HR>
@@ -452,7 +452,7 @@ public void <A HREF="../../../../src-htm
<A NAME="close()"><!-- --></A><H3>
close</H3>
<PRE>
-public void <A HREF="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.399"><B>close</B></A>()
+public void <A HREF="../../../../src-html/org/apache/commons/csv/CSVPrinter.html#line.410"><B>close</B></A>()
throws <A HREF="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD><DL>
Modified: websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/class-use/CSVFormat.CSVFormatBuilder.html
==============================================================================
--- websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/class-use/CSVFormat.CSVFormatBuilder.html (original)
+++ websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/class-use/CSVFormat.CSVFormatBuilder.html Tue Mar 26 22:16:19 2013
@@ -122,6 +122,14 @@ Uses of <A HREF="../../../../../org/apac
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A></CODE></FONT></TD>
+<TD><CODE><B>CSVFormat.</B><B><A HREF="../../../../../org/apache/commons/csv/CSVFormat.html#toBuilder()">toBuilder</A></B>()</CODE>
+
+<BR>
+ Creates a builder based on this format.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="../../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A></CODE></FONT></TD>
<TD><CODE><B>CSVFormat.CSVFormatBuilder.</B><B><A HREF="../../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#withCommentStart(char)">withCommentStart</A></B>(char commentStart)</CODE>
<BR>
Modified: websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/class-use/CSVRecord.html
==============================================================================
--- websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/class-use/CSVRecord.html (original)
+++ websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/class-use/CSVRecord.html Tue Mar 26 22:16:19 2013
@@ -120,6 +120,14 @@ Uses of <A HREF="../../../../../org/apac
<BR>
Parses the specified content.</TD>
</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A><<A HREF="../../../../../org/apache/commons/csv/CSVRecord.html" title="class in org.apache.commons.csv">CSVRecord</A>></CODE></FONT></TD>
+<TD><CODE><B>CSVFormat.CSVFormatBuilder.</B><B><A HREF="../../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html#parse(java.io.Reader)">parse</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io">Reader</A> in)</CODE>
+
+<BR>
+ Parses the specified content.</TD>
+</TR>
</TABLE>
<P>
Modified: websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/package-summary.html
==============================================================================
--- websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/package-summary.html (original)
+++ websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/package-summary.html Tue Mar 26 22:16:19 2013
@@ -94,7 +94,7 @@ Apache Commons CSV Format Support.
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A></B></TD>
-<TD>The format specification of a CSV file.</TD>
+<TD>Specifies the format of a CSV file and parses input.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A></B></TD>
Modified: websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/package-use.html
==============================================================================
--- websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/package-use.html (original)
+++ websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/package-use.html Tue Mar 26 22:16:19 2013
@@ -91,7 +91,7 @@ Classes in <A HREF="../../../../org/apac
<TD><B><A HREF="../../../../org/apache/commons/csv/class-use/CSVFormat.html#org.apache.commons.csv"><B>CSVFormat</B></A></B>
<BR>
- The format specification of a CSV file.</TD>
+ Specifies the format of a CSV file and parses input.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><B><A HREF="../../../../org/apache/commons/csv/class-use/CSVFormat.CSVFormatBuilder.html#org.apache.commons.csv"><B>CSVFormat.CSVFormatBuilder</B></A></B>