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/21 16:20:21 UTC
svn commit: r855435 [3/45] - in
/websites/production/commons/content/proper/commons-csv: ./ apidocs/
apidocs/org/apache/commons/csv/ apidocs/org/apache/commons/csv/class-use/
apidocs/org/apache/commons/csv/writer/
apidocs/src-html/org/apache/commons/cs...
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 Thu Mar 21 15:20:15 2013
@@ -2,13 +2,11 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_29) on Sat Mar 10 00:28:02 GMT 2012 -->
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
CSVFormat (Commons CSV 1.0-SNAPSHOT API)
</TITLE>
-<META NAME="date" CONTENT="2012-03-10">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
@@ -56,7 +54,7 @@ function windowTitle()
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
- <A HREF="../../../../org/apache/commons/csv/CSVParser.html" title="class in org.apache.commons.csv"><B>NEXT CLASS</B></A></FONT></TD>
+ <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/commons/csv/CSVFormat.html" target="_top"><B>FRAMES</B></A>
<A HREF="CSVFormat.html" target="_top"><B>NO FRAMES</B></A>
@@ -76,7 +74,7 @@ function windowTitle()
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+ SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
@@ -96,26 +94,45 @@ Class CSVFormat</H2>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.commons.csv.CSVFormat</B>
</PRE>
<DL>
-<DT><B>All Implemented Interfaces:</B> <DD><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>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A></DD>
+<DT><B>All Implemented Interfaces:</B> <DD><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></DD>
</DL>
<HR>
<DL>
-<DT><PRE>public class <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.30"><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/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A>, <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.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>
</PRE>
<P>
-The format specification of a CSV file.
-
- This class is thread-safe.
+The format specification of a CSV file.
+
+ This class is immutable.
<P>
<P>
<DL>
+<DT><B>Version:</B></DT>
+ <DD>$Id: CSVFormat.java 1458794 2013-03-20 12:39:18Z britter $</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../serialized-form.html#org.apache.commons.csv.CSVFormat">Serialized Form</A></DL>
<HR>
<P>
-<!-- =========== FIELD SUMMARY =========== -->
+<!-- ======== NESTED CLASS SUMMARY ======== -->
+
+<A NAME="nested_class_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Nested Class Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static class</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv">CSVFormat.CSVFormatBuilder</A></B></CODE>
+
+<BR>
+ </TD>
+</TR>
+</TABLE>
+ <!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
@@ -129,7 +146,7 @@ The format specification of a CSV file.
<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#DEFAULT">DEFAULT</A></B></CODE>
<BR>
- Standard comma separated format as defined by <a href="http://tools.ietf.org/html/rfc4180">RFC 4180</a>.</TD>
+ Standard comma separated format, as for <A HREF="../../../../org/apache/commons/csv/CSVFormat.html#RFC4180"><CODE>RFC4180</CODE></A> but allowing empty lines.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -145,8 +162,15 @@ The format specification of a CSV file.
<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#MYSQL">MYSQL</A></B></CODE>
<BR>
- Default MySQL format used by the <tt>SELECT INTO OUTFILE</tt> and
- <tt>LOAD DATA INFILE</tt> operations.</TD>
+ Default MySQL format used by the <tt>SELECT INTO OUTFILE</tt> and <tt>LOAD DATA INFILE</tt> operations.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>static <A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#RFC4180">RFC4180</A></B></CODE>
+
+<BR>
+ Comma separated format as defined by <a href="http://tools.ietf.org/html/rfc4180">RFC 4180</a>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -154,7 +178,7 @@ The format specification of a CSV file.
<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#TDF">TDF</A></B></CODE>
<BR>
- Tabulation delimited format.</TD>
+ Tab-delimited format, with quote; leading and trailing spaces ignored.</TD>
</TR>
</TABLE>
@@ -168,8 +192,8 @@ The format specification of a CSV file.
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE>protected <A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A></CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#clone()">clone</A></B>()</CODE>
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#equals(java.lang.Object)">equals</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> obj)</CODE>
<BR>
</TD>
@@ -177,14 +201,14 @@ The format specification of a CSV file.
<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#format(java.lang.String...)">format</A></B>(<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>... values)</CODE>
+<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>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> char</CODE></FONT></TD>
+<CODE> <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></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#getCommentStart()">getCommentStart</A></B>()</CODE>
<BR>
@@ -200,15 +224,7 @@ The format specification of a CSV file.
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> char</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#getEncapsulator()">getEncapsulator</A></B>()</CODE>
-
-<BR>
- Returns the character used to encapsulate values containing special characters.</TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> char</CODE></FONT></TD>
+<CODE> <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></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#getEscape()">getEscape</A></B>()</CODE>
<BR>
@@ -216,139 +232,115 @@ 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="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#getLineSeparator()">getLineSeparator</A></B>()</CODE>
-
-<BR>
- Returns the line separator delimiting the records.</TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> boolean</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#isCommentingDisabled()">isCommentingDisabled</A></B>()</CODE>
-
-<BR>
- Tells if comments are supported by this format.</TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> boolean</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#isEmptyLinesIgnored()">isEmptyLinesIgnored</A></B>()</CODE>
-
-<BR>
- Tells if the empty lines between the records are ignored.</TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#isLeadingSpacesIgnored()">isLeadingSpacesIgnored</A></B>()</CODE>
+<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#getIgnoreEmptyLines()">getIgnoreEmptyLines</A></B>()</CODE>
<BR>
- Tells if the spaces characters at the beginning of the values are ignored when parsing a file.</TD>
+ Specifies whether empty lines between records are ignored when parsing input.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#isTrailingSpacesIgnored()">isTrailingSpacesIgnored</A></B>()</CODE>
+<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#getIgnoreSurroundingSpaces()">getIgnoreSurroundingSpaces</A></B>()</CODE>
<BR>
- Tells if the spaces characters at the end of the values are ignored when parsing a file.</TD>
+ Specifies whether spaces around values are ignored when parsing input.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> boolean</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#isUnicodeEscapesInterpreted()">isUnicodeEscapesInterpreted</A></B>()</CODE>
+<CODE> <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></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#getQuoteChar()">getQuoteChar</A></B>()</CODE>
<BR>
- Tells if unicode escape sequences (i.e <span>\</span>u1234) are turned into their corresponding character.</TD>
+ Returns the character used to encapsulate values containing special characters.</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="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#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>
+<CODE> <A HREF="../../../../org/apache/commons/csv/Quote.html" title="enum in org.apache.commons.csv">Quote</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#getQuotePolicy()">getQuotePolicy</A></B>()</CODE>
<BR>
- Parses the specified content.</TD>
+ Returns the quote policy output fields.</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.html" title="class in org.apache.commons.csv">CSVFormat</A></CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#withCommentStart(char)">withCommentStart</A></B>(char commentStart)</CODE>
+<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#getRecordSeparator()">getRecordSeparator</A></B>()</CODE>
<BR>
- Returns a copy of this format using the specified character as the comment start marker.</TD>
+ Returns the line separator delimiting output records.</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.html" title="class in org.apache.commons.csv">CSVFormat</A></CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#withDelimiter(char)">withDelimiter</A></B>(char delimiter)</CODE>
+<CODE> int</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#hashCode()">hashCode</A></B>()</CODE>
<BR>
- Returns a copy of this format using the specified delimiter character.</TD>
+ </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.html" title="class in org.apache.commons.csv">CSVFormat</A></CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#withEmptyLinesIgnored(boolean)">withEmptyLinesIgnored</A></B>(boolean emptyLinesIgnored)</CODE>
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#isCommentingEnabled()">isCommentingEnabled</A></B>()</CODE>
<BR>
- Returns a copy of this format with the specified empty line skipping behavior.</TD>
+ Specifies whether comments are supported by 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.html" title="class in org.apache.commons.csv">CSVFormat</A></CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#withEncapsulator(char)">withEncapsulator</A></B>(char encapsulator)</CODE>
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#isEscaping()">isEscaping</A></B>()</CODE>
<BR>
- Returns a copy of this format using the specified encapsulator character.</TD>
+ Returns whether escape are being processed.</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.html" title="class in org.apache.commons.csv">CSVFormat</A></CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#withEscape(char)">withEscape</A></B>(char escape)</CODE>
+<CODE> boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#isQuoting()">isQuoting</A></B>()</CODE>
<BR>
- Returns a copy of this format using the specified escape character.</TD>
+ Returns whether an quoteChar has been defined.</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.html" title="class in org.apache.commons.csv">CSVFormat</A></CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#withLeadingSpacesIgnored(boolean)">withLeadingSpacesIgnored</A></B>(boolean leadingSpacesIgnored)</CODE>
+<CODE>static <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#newBuilder()">newBuilder</A></B>()</CODE>
<BR>
- Returns a copy of this format with the specified left trimming behavior.</TD>
+ 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.</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.html" title="class in org.apache.commons.csv">CSVFormat</A></CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#withLineSeparator(java.lang.String)">withLineSeparator</A></B>(<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> lineSeparator)</CODE>
+<CODE>static <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#newBuilder(char)">newBuilder</A></B>(char delimiter)</CODE>
<BR>
- Returns a copy of this format using the specified line separator.</TD>
+ Creates a new CSV format builder.</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.html" title="class in org.apache.commons.csv">CSVFormat</A></CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#withSurroundingSpacesIgnored(boolean)">withSurroundingSpacesIgnored</A></B>(boolean surroundingSpacesIgnored)</CODE>
+<CODE>static <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#newBuilder(org.apache.commons.csv.CSVFormat)">newBuilder</A></B>(<A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv">CSVFormat</A> format)</CODE>
<BR>
- Returns a copy of this format with the specified trimming behavior.</TD>
+ </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.html" title="class in org.apache.commons.csv">CSVFormat</A></CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#withTrailingSpacesIgnored(boolean)">withTrailingSpacesIgnored</A></B>(boolean trailingSpacesIgnored)</CODE>
+<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.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>
- Returns a copy of this format with the specified right trimming behavior.</TD>
+ 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.html" title="class in org.apache.commons.csv">CSVFormat</A></CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVFormat.html#withUnicodeEscapesInterpreted(boolean)">withUnicodeEscapesInterpreted</A></B>(boolean unicodeEscapesInterpreted)</CODE>
+<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>
<BR>
- Returns a copy of this format with the specified unicode escaping behavior.</TD>
+ </TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
@@ -357,7 +349,7 @@ The format specification of a CSV file.
<TH ALIGN="left"><B>Methods inherited from class java.lang.<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></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><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>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <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>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <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>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
+<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javas
e/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
@@ -373,12 +365,35 @@ The format specification of a CSV file.
</TR>
</TABLE>
+<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>
+<DL>
+<DD>Comma separated format as defined by <a href="http://tools.ietf.org/html/rfc4180">RFC 4180</a>.
+ <ul>
+ <li>withDelimiter(',')</li>
+ <li>withQuoteChar('"')</li>
+ <li>withLineSeparator(CRLF)</li>
+ </ul>
+<P>
+<DL>
+</DL>
+</DL>
+<HR>
+
<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.52"><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.77"><B>DEFAULT</B></A></PRE>
<DL>
-<DD>Standard comma separated format as defined by <a href="http://tools.ietf.org/html/rfc4180">RFC 4180</a>.
+<DD>Standard comma separated format, as for <A HREF="../../../../org/apache/commons/csv/CSVFormat.html#RFC4180"><CODE>RFC4180</CODE></A> but allowing empty lines.
+ <ul>
+ <li>withDelimiter(',')</li>
+ <li>withQuoteChar('"')</li>
+ <li>withIgnoreEmptyLines(true)</li>
+ <li>withLineSeparator(CRLF)</li>
+ </ul>
<P>
<DL>
</DL>
@@ -388,17 +403,23 @@ 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.65"><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.98"><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 accomodate to your
- regional settings.
- <p/>
- For example for parsing or generating a CSV file on a French system
- the following format will be used:
-
- <pre>CSVFormat fmt = CSVFormat.EXCEL.withDelimiter(';');</pre>
+<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.
+ <p/>
+ For example for parsing or generating a CSV file on a French system the following format will be used:
+
+ <pre>
+ CSVFormat fmt = CSVFormat.newBuilder(EXCEL).withDelimiter(';').build();
+ </pre>
+ Settings are:
+ <ul>
+ <li>withDelimiter(',')</li>
+ <li>withQuoteChar('"')</li>
+ <li>withLineSeparator(CRLF)</li>
+ </ul>
+ Note: this is currently the same as RFC4180
<P>
<DL>
</DL>
@@ -408,9 +429,9 @@ 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.68"><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.104"><B>TDF</B></A></PRE>
<DL>
-<DD>Tabulation delimited format.
+<DD>Tab-delimited format, with quote; leading and trailing spaces ignored.
<P>
<DL>
</DL>
@@ -420,15 +441,15 @@ 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.78"><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.118"><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 tabulation delimited
- format with a LF character as the line separator. Values are not quoted
- and special characters are escaped with '\'.
+<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
+ are escaped with '\'.
<P>
<DL>
-<DT><B>See Also:</B><DD><a href="http://dev.mysql.com/doc/refman/5.1/en/load-data.html">http://dev.mysql.com/doc/refman/5.1/en/load-data.html</a></DL>
+<DT><B>See Also:</B><DD><a href="http://dev.mysql.com/doc/refman/5.1/en/load-data.html">
+ http://dev.mysql.com/doc/refman/5.1/en/load-data.html</a></DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
@@ -441,398 +462,323 @@ public static final <A HREF="../../../..
</TR>
</TABLE>
-<A NAME="getDelimiter()"><!-- --></A><H3>
-getDelimiter</H3>
+<A NAME="newBuilder(char)"><!-- --></A><H3>
+newBuilder</H3>
<PRE>
-public char <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.170"><B>getDelimiter</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.135"><B>newBuilder</B></A>(char delimiter)</PRE>
<DL>
-<DD>Returns the character delimiting the values (typically ';', ',' or '\t').
+<DD>Creates a new CSV format builder.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-
-<DT><B>Returns:</B><DD>the delimiter character</DL>
-</DD>
-</DL>
-<HR>
-
-<A NAME="withDelimiter(char)"><!-- --></A><H3>
-withDelimiter</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.html#line.181"><B>withDelimiter</B></A>(char delimiter)</PRE>
-<DL>
-<DD>Returns a copy of this format using the specified delimiter character.
-<P>
-<DD><DL>
-</DL>
-</DD>
-<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>delimiter</CODE> - the delimiter character
-<DT><B>Returns:</B><DD>A copy of this format using the specified delimiter character
+<DT><B>Parameters:</B><DD><CODE>delimiter</CODE> - the char used for value separation, must not be a line break character
+<DT><B>Returns:</B><DD>a new CSV format builder.
<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 specified character is a line break</DL>
+<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> - if the delimiter is a line break character</DL>
</DD>
</DL>
<HR>
-<A NAME="getEncapsulator()"><!-- --></A><H3>
-getEncapsulator</H3>
+<A NAME="newBuilder(org.apache.commons.csv.CSVFormat)"><!-- --></A><H3>
+newBuilder</H3>
<PRE>
-public char <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.196"><B>getEncapsulator</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.139"><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>Returns the character used to encapsulate values containing special characters.
-<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-
-<DT><B>Returns:</B><DD>the encapsulator character</DL>
-</DD>
</DL>
-<HR>
-
-<A NAME="withEncapsulator(char)"><!-- --></A><H3>
-withEncapsulator</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.html#line.207"><B>withEncapsulator</B></A>(char encapsulator)</PRE>
-<DL>
-<DD>Returns a copy of this format using the specified encapsulator character.
-<P>
-<DD><DL>
-</DL>
-</DD>
-<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>encapsulator</CODE> - the encapsulator character
-<DT><B>Returns:</B><DD>A copy of this format using the specified encapsulator character
-<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 specified character is a line break</DL>
</DD>
</DL>
<HR>
-<A NAME="getCommentStart()"><!-- --></A><H3>
-getCommentStart</H3>
+<A NAME="newBuilder()"><!-- --></A><H3>
+newBuilder</H3>
<PRE>
-public char <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.226"><B>getCommentStart</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.153"><B>newBuilder</B></A>()</PRE>
<DL>
-<DD>Returns the character marking the start of a line comment.
+<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>
+ <li>withDelimiter(',')</li>
+ <li>withQuoteChar('"')</li>
+ <li>withEmptyLinesIgnored(true)</li>
+ <li>withLineSeparator(CRLF)</li>
+ </ul>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Returns:</B><DD>the comment start marker.</DL>
+<DT><B>Returns:</B><DD>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.</DL>
</DD>
</DL>
<HR>
-<A NAME="withCommentStart(char)"><!-- --></A><H3>
-withCommentStart</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.html#line.237"><B>withCommentStart</B></A>(char commentStart)</PRE>
-<DL>
-<DD>Returns a copy of this format using the specified character as the comment start marker.
-<P>
-<DD><DL>
-</DL>
-</DD>
-<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>commentStart</CODE> - the comment start marker
-<DT><B>Returns:</B><DD>A copy of this format using the specified character as the comment start marker
-<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 specified character is a line break</DL>
-</DD>
-</DL>
-<HR>
-
-<A NAME="isCommentingDisabled()"><!-- --></A><H3>
-isCommentingDisabled</H3>
+<A NAME="getDelimiter()"><!-- --></A><H3>
+getDelimiter</H3>
<PRE>
-public boolean <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.252"><B>isCommentingDisabled</B></A>()</PRE>
+public char <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.231"><B>getDelimiter</B></A>()</PRE>
<DL>
-<DD>Tells if comments are supported by this format.
+<DD>Returns the character delimiting the values (typically ';', ',' or '\t').
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Returns:</B><DD><tt>true</tt> is comments are supported, <tt>false</tt> otherwise</DL>
+<DT><B>Returns:</B><DD>the delimiter character</DL>
</DD>
</DL>
<HR>
-<A NAME="getEscape()"><!-- --></A><H3>
-getEscape</H3>
+<A NAME="getQuoteChar()"><!-- --></A><H3>
+getQuoteChar</H3>
<PRE>
-public char <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.261"><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.240"><B>getQuoteChar</B></A>()</PRE>
<DL>
-<DD>Returns the escape character.
+<DD>Returns the character used to encapsulate values containing special characters.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Returns:</B><DD>the escape character</DL>
+<DT><B>Returns:</B><DD>the quoteChar character</DL>
</DD>
</DL>
<HR>
-<A NAME="withEscape(char)"><!-- --></A><H3>
-withEscape</H3>
+<A NAME="isQuoting()"><!-- --></A><H3>
+isQuoting</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.html#line.272"><B>withEscape</B></A>(char escape)</PRE>
+public boolean <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.249"><B>isQuoting</B></A>()</PRE>
<DL>
-<DD>Returns a copy of this format using the specified escape character.
+<DD>Returns whether an quoteChar has been defined.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>escape</CODE> - the escape character
-<DT><B>Returns:</B><DD>A copy of this format using the specified escape character
-<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 specified character is a line break</DL>
+
+<DT><B>Returns:</B><DD><code>true</code> if an quoteChar is defined</DL>
</DD>
</DL>
<HR>
-<A NAME="isLeadingSpacesIgnored()"><!-- --></A><H3>
-isLeadingSpacesIgnored</H3>
+<A NAME="getCommentStart()"><!-- --></A><H3>
+getCommentStart</H3>
<PRE>
-public boolean <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.291"><B>isLeadingSpacesIgnored</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.258"><B>getCommentStart</B></A>()</PRE>
<DL>
-<DD>Tells if the spaces characters at the beginning of the values are ignored when parsing a file.
+<DD>Returns the character marking the start of a line comment.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Returns:</B><DD><tt>true</tt> if leading spaces are removed, <tt>false</tt> if they are preserved.</DL>
+<DT><B>Returns:</B><DD>the comment start marker.</DL>
</DD>
</DL>
<HR>
-<A NAME="withLeadingSpacesIgnored(boolean)"><!-- --></A><H3>
-withLeadingSpacesIgnored</H3>
+<A NAME="isCommentingEnabled()"><!-- --></A><H3>
+isCommentingEnabled</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.html#line.302"><B>withLeadingSpacesIgnored</B></A>(boolean leadingSpacesIgnored)</PRE>
+public boolean <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.269"><B>isCommentingEnabled</B></A>()</PRE>
<DL>
-<DD>Returns a copy of this format with the specified left trimming behavior.
-<P>
-<DD><DL>
-</DL>
-</DD>
-<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>leadingSpacesIgnored</CODE> - the left trimming behavior, <tt>true</tt> to remove the leading spaces,
- <tt>false</tt> to leave the spaces as is.
-<DT><B>Returns:</B><DD>A copy of this format with the specified left trimming behavior.</DL>
-</DD>
-</DL>
-<HR>
+<DD>Specifies whether comments are supported by this format.
-<A NAME="isTrailingSpacesIgnored()"><!-- --></A><H3>
-isTrailingSpacesIgnored</H3>
-<PRE>
-public boolean <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.313"><B>isTrailingSpacesIgnored</B></A>()</PRE>
-<DL>
-<DD>Tells if the spaces characters at the end of the values are ignored when parsing a file.
+ Note that the comment introducer character is only recognised at the start of a line.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Returns:</B><DD><tt>true</tt> if trailing spaces are removed, <tt>false</tt> if they are preserved.</DL>
+<DT><B>Returns:</B><DD><tt>true</tt> is comments are supported, <tt>false</tt> otherwise</DL>
</DD>
</DL>
<HR>
-<A NAME="withTrailingSpacesIgnored(boolean)"><!-- --></A><H3>
-withTrailingSpacesIgnored</H3>
+<A NAME="getEscape()"><!-- --></A><H3>
+getEscape</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.html#line.324"><B>withTrailingSpacesIgnored</B></A>(boolean trailingSpacesIgnored)</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.278"><B>getEscape</B></A>()</PRE>
<DL>
-<DD>Returns a copy of this format with the specified right trimming behavior.
+<DD>Returns the escape character.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>trailingSpacesIgnored</CODE> - the right trimming behavior, <tt>true</tt> to remove the trailing spaces,
- <tt>false</tt> to leave the spaces as is.
-<DT><B>Returns:</B><DD>A copy of this format with the specified right trimming behavior.</DL>
+
+<DT><B>Returns:</B><DD>the escape character</DL>
</DD>
</DL>
<HR>
-<A NAME="withSurroundingSpacesIgnored(boolean)"><!-- --></A><H3>
-withSurroundingSpacesIgnored</H3>
+<A NAME="isEscaping()"><!-- --></A><H3>
+isEscaping</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.html#line.337"><B>withSurroundingSpacesIgnored</B></A>(boolean surroundingSpacesIgnored)</PRE>
+public boolean <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.287"><B>isEscaping</B></A>()</PRE>
<DL>
-<DD>Returns a copy of this format with the specified trimming behavior.
+<DD>Returns whether escape are being processed.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>surroundingSpacesIgnored</CODE> - the trimming behavior, <tt>true</tt> to remove the surrounding spaces,
- <tt>false</tt> to leave the spaces as is.
-<DT><B>Returns:</B><DD>A copy of this format with the specified trimming behavior.</DL>
+
+<DT><B>Returns:</B><DD><code>true</code> if escapes are processed</DL>
</DD>
</DL>
<HR>
-<A NAME="isUnicodeEscapesInterpreted()"><!-- --></A><H3>
-isUnicodeEscapesInterpreted</H3>
+<A NAME="getIgnoreSurroundingSpaces()"><!-- --></A><H3>
+getIgnoreSurroundingSpaces</H3>
<PRE>
-public boolean <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.349"><B>isUnicodeEscapesInterpreted</B></A>()</PRE>
+public boolean <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.297"><B>getIgnoreSurroundingSpaces</B></A>()</PRE>
<DL>
-<DD>Tells if unicode escape sequences (i.e <span>\</span>u1234) are turned into their corresponding character.
+<DD>Specifies whether spaces around values are ignored when parsing input.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Returns:</B><DD><tt>true</tt> if unicode escape sequences are interpreted, <tt>false</tt> if they are left as is.</DL>
+<DT><B>Returns:</B><DD><tt>true</tt> if spaces around values are ignored, <tt>false</tt> if they are treated as part of the
+ value.</DL>
</DD>
</DL>
<HR>
-<A NAME="withUnicodeEscapesInterpreted(boolean)"><!-- --></A><H3>
-withUnicodeEscapesInterpreted</H3>
+<A NAME="getIgnoreEmptyLines()"><!-- --></A><H3>
+getIgnoreEmptyLines</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.html#line.360"><B>withUnicodeEscapesInterpreted</B></A>(boolean unicodeEscapesInterpreted)</PRE>
+public boolean <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.307"><B>getIgnoreEmptyLines</B></A>()</PRE>
<DL>
-<DD>Returns a copy of this format with the specified unicode escaping behavior.
+<DD>Specifies whether empty lines between records are ignored when parsing input.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>unicodeEscapesInterpreted</CODE> - the escaping behavior, <tt>true</tt> to interpret unicode escape sequences,
- <tt>false</tt> to leave the escape sequences as is.
-<DT><B>Returns:</B><DD>A copy of this format with the specified unicode escaping behavior.</DL>
+
+<DT><B>Returns:</B><DD><tt>true</tt> if empty lines between records are ignored, <tt>false</tt> if they are turned into empty
+ records.</DL>
</DD>
</DL>
<HR>
-<A NAME="isEmptyLinesIgnored()"><!-- --></A><H3>
-isEmptyLinesIgnored</H3>
+<A NAME="getRecordSeparator()"><!-- --></A><H3>
+getRecordSeparator</H3>
<PRE>
-public boolean <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.371"><B>isEmptyLinesIgnored</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.316"><B>getRecordSeparator</B></A>()</PRE>
<DL>
-<DD>Tells if the empty lines between the records are ignored.
+<DD>Returns the line separator delimiting output records.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Returns:</B><DD><tt>true</tt> if empty lines between records are ignore, <tt>false</tt> if they are turned into empty records.</DL>
+<DT><B>Returns:</B><DD>the line separator</DL>
</DD>
</DL>
<HR>
-<A NAME="withEmptyLinesIgnored(boolean)"><!-- --></A><H3>
-withEmptyLinesIgnored</H3>
+<A NAME="parse(java.io.Reader)"><!-- --></A><H3>
+parse</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.html#line.382"><B>withEmptyLinesIgnored</B></A>(boolean emptyLinesIgnored)</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.330"><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>Returns a copy of this format with the specified empty line skipping behavior.
+<DD>Parses the specified content.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>emptyLinesIgnored</CODE> - the empty line skipping behavior, <tt>true</tt> to ignore the empty lines
- between the records, <tt>false</tt> to translate empty lines to empty records.
-<DT><B>Returns:</B><DD>A copy of this format with the specified empty line skipping behavior.</DL>
+<DT><B>Parameters:</B><DD><CODE>in</CODE> - the input 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></DL>
</DD>
</DL>
<HR>
-<A NAME="getLineSeparator()"><!-- --></A><H3>
-getLineSeparator</H3>
+<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.393"><B>getLineSeparator</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.340"><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>Returns the line separator delimiting the records.
+<DD>Format the specified values.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-
-<DT><B>Returns:</B><DD>the line separator</DL>
+<DT><B>Parameters:</B><DD><CODE>values</CODE> - the values to format</DL>
</DD>
</DL>
<HR>
-<A NAME="withLineSeparator(java.lang.String)"><!-- --></A><H3>
-withLineSeparator</H3>
+<A NAME="toString()"><!-- --></A><H3>
+toString</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.html#line.403"><B>withLineSeparator</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> lineSeparator)</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.352"><B>toString</B></A>()</PRE>
<DL>
-<DD>Returns a copy of this format using the specified line separator.
-<P>
<DD><DL>
-</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>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>lineSeparator</CODE> - the line separator
-<DT><B>Returns:</B><DD>A copy of this format using the specified line separator</DL>
+</DL>
</DD>
</DL>
<HR>
-<A NAME="parse(java.io.Reader)"><!-- --></A><H3>
-parse</H3>
+<A NAME="getQuotePolicy()"><!-- --></A><H3>
+getQuotePolicy</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="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.414"><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)</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.381"><B>getQuotePolicy</B></A>()</PRE>
<DL>
-<DD>Parses the specified content.
+<DD>Returns the quote policy output fields.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>in</CODE> - the input stream</DL>
+
+<DT><B>Returns:</B><DD>the quote policy</DL>
</DD>
</DL>
<HR>
-<A NAME="format(java.lang.String...)"><!-- --></A><H3>
-format</H3>
+<A NAME="hashCode()"><!-- --></A><H3>
+hashCode</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.423"><B>format</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>... values)</PRE>
+public int <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.386"><B>hashCode</B></A>()</PRE>
<DL>
-<DD>Format the specified values.
-<P>
<DD><DL>
-</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>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>values</CODE> - the values to format</DL>
+</DL>
</DD>
</DL>
<HR>
-<A NAME="clone()"><!-- --></A><H3>
-clone</H3>
+<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
+equals</H3>
<PRE>
-protected <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.435"><B>clone</B></A>()</PRE>
+public boolean <A HREF="../../../../src-html/org/apache/commons/csv/CSVFormat.html#line.404"><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#clone()" title="class or interface in java.lang">clone</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>
+<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>
</DD>
<DD><DL>
</DL>
@@ -869,7 +815,7 @@ protected <A HREF="../../../../org/apach
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
- <A HREF="../../../../org/apache/commons/csv/CSVParser.html" title="class in org.apache.commons.csv"><B>NEXT CLASS</B></A></FONT></TD>
+ <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/commons/csv/CSVFormat.html" target="_top"><B>FRAMES</B></A>
<A HREF="CSVFormat.html" target="_top"><B>NO FRAMES</B></A>
@@ -889,7 +835,7 @@ protected <A HREF="../../../../org/apach
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
+ SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
@@ -898,6 +844,6 @@ DETAIL: <A HREF="#field_detail">FIE
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
-Copyright © 2012 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
+Copyright © 2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
</BODY>
-</HTML>
+</HTML>
\ No newline at end of file
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 Thu Mar 21 15:20:15 2013
@@ -2,13 +2,11 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_29) on Sat Mar 10 00:28:03 GMT 2012 -->
-<META http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
CSVParser (Commons CSV 1.0-SNAPSHOT API)
</TITLE>
-<META NAME="date" CONTENT="2012-03-10">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
@@ -55,7 +53,7 @@ function windowTitle()
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv"><B>PREV CLASS</B></A>
+ <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv"><B>PREV CLASS</B></A>
<A HREF="../../../../org/apache/commons/csv/CSVPrinter.html" title="class in org.apache.commons.csv"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/commons/csv/CSVParser.html" target="_top"><B>FRAMES</B></A>
@@ -96,45 +94,56 @@ Class CSVParser</H2>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.commons.csv.CSVParser</B>
</PRE>
<DL>
-<DT><B>All Implemented Interfaces:</B> <DD><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="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]></DD>
+<DT><B>All Implemented Interfaces:</B> <DD><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>></DD>
</DL>
<HR>
<DL>
-<DT><PRE>public class <A HREF="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.62"><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="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>[]></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>
</PRE>
<P>
-Parses CSV files according to the specified configuration.
-
- Because CSV appears in many different dialects, the parser supports many
- configuration settings by allowing the 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 '#':</p>
- <pre>
- CSVFormat format = new CSVFormat('\t', '"', '#');
- Reader in = new StringReader("a\tb\nc\td");
- String[][] records = new CSVParser(in, format).getRecords();
- </pre>
-
- <p>Parsing of a csv-string in Excel CSV format, using a for-each loop:</p>
- <pre>
- Reader in = new StringReader("a;b\nc;d");
- CSVParser parser = new CSVParser(in, CSVFormat.EXCEL);
- for (String[] record : parser) {
- ...
- }
- </pre>
-
- <p>
- Internal parser state is completely covered by the format
- and the reader-state.</p>
-
- <p>see <a href="package-summary.html">package documentation</a>
- for more details</p>
+Parses CSV files according to the specified configuration.
+
+ Because CSV appears in many different dialects, the parser supports many configuration settings by allowing the
+ 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
+ '#':
+ </p>
+
+ <pre>
+ CSVFormat format = new CSVFormat('\t', '"', '#');
+ Reader in = new StringReader("a\tb\nc\td");
+ List<CSVRecord> records = new CSVParser(in, format).getRecords();
+ </pre>
+
+ <p>
+ Parsing of a csv-string in Excel CSV format, using a for-each loop:
+ </p>
+
+ <pre>
+ Reader in = new StringReader("a;b\nc;d");
+ CSVParser parser = new CSVParser(in, CSVFormat.EXCEL);
+ for (CSVRecord record : parser) {
+ ...
+ }
+ </pre>
+
+ <p>
+ Internal parser state is completely covered by the format and the reader-state.
+ </p>
+
+ <p>
+ see <a href="package-summary.html">package documentation</a> for more details
+ </p>
<P>
<P>
+<DL>
+<DT><B>Version:</B></DT>
+ <DD>$Id: CSVParser.java 1458683 2013-03-20 08:31:14Z britter $</DD>
+</DL>
<HR>
<P>
@@ -179,7 +188,15 @@ Parses CSV files according to the specif
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE> int</CODE></FONT></TD>
+<CODE> <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>></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVParser.html#getHeaderMap()">getHeaderMap</A></B>()</CODE>
+
+<BR>
+ Returns a copy of the header map that iterates in column order.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE> long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVParser.html#getLineNumber()">getLineNumber</A></B>()</CODE>
<BR>
@@ -187,16 +204,24 @@ Parses CSV files according to the specif
</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>
+<CODE> long</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVParser.html#getRecordNumber()">getRecordNumber</A></B>()</CODE>
+
+<BR>
+ Returns the current record number in the input stream.</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/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>></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVParser.html#getRecords()">getRecords</A></B>()</CODE>
<BR>
- Parses the CSV input according to the given format and returns the content
- as an array of records (whereas records are arrays of single values).</TD>
+ 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>
+ entries.</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/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</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>[]></CODE></FONT></TD>
+<CODE> <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>></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/commons/csv/CSVParser.html#iterator()">iterator</A></B>()</CODE>
<BR>
@@ -228,44 +253,50 @@ 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.81"><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)</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)
+ 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>.
<P>
<DL>
<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</DL>
+<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>
</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.92"><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)</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,
+ <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>
<DD>Customized CSV parser using the given <A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv"><CODE>CSVFormat</CODE></A>
<P>
<DL>
<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</DL>
+<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>
</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.109"><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)</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,
+ <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>
<DD>Customized CSV parser using the given <A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv"><CODE>CSVFormat</CODE></A>
<P>
<DL>
<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</DL>
+<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>
</DL>
<!-- ============ METHOD DETAIL ========== -->
@@ -278,55 +309,53 @@ public <A HREF="../../../../src-html/org
</TR>
</TABLE>
-<A NAME="getRecords()"><!-- --></A><H3>
-getRecords</H3>
+<A NAME="getHeaderMap()"><!-- --></A><H3>
+getHeaderMap</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/CSVParser.html#line.123"><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>
+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>
<DL>
-<DD>Parses the CSV input according to the given format and returns the content
- as an array of records (whereas records are arrays of single values).
- <p/>
- The returned content starts at the current parse-position in the stream.
+<DD>Returns a copy of the header map that iterates in column order.
+ <p>
+ The map keys are column names.
+ The map values are 0-based indices.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
-<DT><B>Returns:</B><DD>matrix of records x values ('null' when end of file)
-<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> - on parse error or input read-failure</DL>
+<DT><B>Returns:</B><DD>a copy of the header map that iterates in column order.</DL>
</DD>
</DL>
<HR>
-<A NAME="iterator()"><!-- --></A><H3>
-iterator</H3>
+<A NAME="getLineNumber()"><!-- --></A><H3>
+getLineNumber</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="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/CSVParser.html#line.182"><B>iterator</B></A>()</PRE>
+public long <A HREF="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.143"><B>getLineNumber</B></A>()</PRE>
<DL>
-<DD>Returns an iterator on the records. IOExceptions occuring
- during the iteration are wrapped in a RuntimeException.
+<DD>Returns the current line number in the input stream.
+ <p/>
+ ATTENTION: If your CSV input has multi-line values, the returned number does not correspond to the record number.
<P>
<DD><DL>
-<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true#iterator()" title="class or interface in java.lang">iterator</A></CODE> in interface <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="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></DL>
+</DL>
</DD>
<DD><DL>
-</DL>
+
+<DT><B>Returns:</B><DD>current line number</DL>
</DD>
</DL>
<HR>
-<A NAME="getLineNumber()"><!-- --></A><H3>
-getLineNumber</H3>
+<A NAME="getRecordNumber()"><!-- --></A><H3>
+getRecordNumber</H3>
<PRE>
-public int <A HREF="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.229"><B>getLineNumber</B></A>()</PRE>
+public long <A HREF="../../../../src-html/org/apache/commons/csv/CSVParser.html#line.154"><B>getRecordNumber</B></A>()</PRE>
<DL>
-<DD>Returns the current line number in the input stream.
- <p/>
- ATTENTION: in case your csv has multiline-values the returned
- number does not correspond to the record-number
+<DD>Returns the current record number in the input stream.
+ <p/>
+ ATTENTION: If your CSV input has multi-line values, the returned number does not correspond to the line number.
<P>
<DD><DL>
</DL>
@@ -336,6 +365,46 @@ public int <A HREF="../../../../src-html
<DT><B>Returns:</B><DD>current line number</DL>
</DD>
</DL>
+<HR>
+
+<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>()
+ 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>
+ entries.
+ <p/>
+ The returned content starts at the current parse-position in the stream.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>list of <A HREF="../../../../org/apache/commons/csv/CSVRecord.html" title="class in org.apache.commons.csv"><CODE>CSVRecord</CODE></A> entries, may be empty
+<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> - on parse error or input read-failure</DL>
+</DD>
+</DL>
+<HR>
+
+<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>
+<DL>
+<DD>Returns an iterator on the records. IOExceptions occurring during the iteration are wrapped in a
+ RuntimeException.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true#iterator()" title="class or interface in java.lang">iterator</A></CODE> in interface <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></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
@@ -366,7 +435,7 @@ public int <A HREF="../../../../src-html
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../org/apache/commons/csv/CSVFormat.html" title="class in org.apache.commons.csv"><B>PREV CLASS</B></A>
+ <A HREF="../../../../org/apache/commons/csv/CSVFormat.CSVFormatBuilder.html" title="class in org.apache.commons.csv"><B>PREV CLASS</B></A>
<A HREF="../../../../org/apache/commons/csv/CSVPrinter.html" title="class in org.apache.commons.csv"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/commons/csv/CSVParser.html" target="_top"><B>FRAMES</B></A>
@@ -396,6 +465,6 @@ DETAIL: FIELD | <A HREF="
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
-Copyright © 2012 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
+Copyright © 2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
</BODY>
-</HTML>
+</HTML>
\ No newline at end of file