Return-Path: X-Original-To: apmail-commons-commits-archive@minotaur.apache.org Delivered-To: apmail-commons-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 1C649F0D4 for ; Thu, 21 Mar 2013 15:20:57 +0000 (UTC) Received: (qmail 32339 invoked by uid 500); 21 Mar 2013 15:20:56 -0000 Delivered-To: apmail-commons-commits-archive@commons.apache.org Received: (qmail 32264 invoked by uid 500); 21 Mar 2013 15:20:56 -0000 Mailing-List: contact commits-help@commons.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@commons.apache.org Delivered-To: mailing list commits@commons.apache.org Received: (qmail 31980 invoked by uid 99); 21 Mar 2013 15:20:56 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 21 Mar 2013 15:20:56 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 21 Mar 2013 15:20:51 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 73B2023889BB for ; Thu, 21 Mar 2013 15:20:31 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r855435 [4/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... Date: Thu, 21 Mar 2013 15:20:21 -0000 To: commits@commons.apache.org From: ggregory@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20130321152031.73B2023889BB@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org 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 Thu Mar 21 15:20:15 2013 @@ -2,13 +2,11 @@ - - + CSVPrinter (Commons CSV 1.0-SNAPSHOT API) - @@ -56,7 +54,7 @@ function windowTitle()  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   @@ -95,16 +93,23 @@ Class CSVPrinter java.lang.Object extended by org.apache.commons.csv.CSVPrinter +
+
All Implemented Interfaces:
Closeable, Flushable
+
-
public class CSVPrinter
extends Object
+
public class CSVPrinter
extends Object
implements Flushable, Closeable

-Print values as a comma separated list. +Prints values in a CSV format.

+

+
Version:
+
$Id: CSVPrinter.java 1458805 2013-03-20 12:43:43Z britter $
+

@@ -122,7 +127,7 @@ Print values as a comma separated list. CSVFormat format)
-          Create a printer that will print values to the given stream following the CSVFormat. +          Creates a printer that will print values to the given stream following the CSVFormat.   @@ -137,27 +142,26 @@ Print values as a comma separated list.  void -flush() +close()
-          Flush the underlying stream. +             void -print(String value) +flush()
-          Print the string as the next value on the line. +          Flushes the underlying stream.  void -print(String value, - boolean checkForEscape) +print(Object value)
-          Print the string as the next value on the line. +          Prints the string as the next value on the line. @@ -165,7 +169,7 @@ Print values as a comma separated list. printComment(String comment)
-          Put a comment on a new line among the comma separated values. +          Prints a comment on a new line among the delimiter separated values. @@ -173,15 +177,47 @@ Print values as a comma separated list. println()
-          Output a blank line +          Outputs the line separator. + + + + void +printRecord(Iterable<?> values) + +
+          Prints a single line of delimiter separated values. + + + + void +printRecord(Object... values) + +
+          Prints a single line of delimiter separated values. + + + + void +printRecords(Iterable<?> values) + +
+          Prints all the objects in the given collection. + + + + void +printRecords(Object[] values) + +
+          Prints all the objects in the given array.  void -println(String... values) +printRecords(ResultSet resultSet)
-          Print a single line of comma separated values. +          Prints all the objects in the given JDBC result set.   @@ -209,13 +245,13 @@ Print values as a comma separated list.

CSVPrinter

-public CSVPrinter(Appendable out,
+public CSVPrinter(Appendable out,
                   CSVFormat format)
-
Create a printer that will print values to the given stream following the CSVFormat. -

- Currently, only a pure encapsulation format or a pure escaping format - is supported. Hybrid formats (encapsulation and escaping with a different character) are not supported. +

Creates a printer that will print values to the given stream following the CSVFormat. +

+ Currently, only a pure encapsulation format or a pure escaping format is supported. Hybrid formats + (encapsulation and escaping with a different character) are not supported.

Parameters:
out - stream to which to print.
format - the CSV format. If null the default format is used (CSVFormat.DEFAULT) @@ -236,12 +272,15 @@ public

println

-public void println()
+public void println()
              throws IOException
-
Output a blank line +
Outputs the line separator.

+
+
+
Throws:
IOException
@@ -252,12 +291,15 @@ public void

flush

-public void flush()
+public void flush()
            throws IOException
-
Flush the underlying stream. +
Flushes the underlying stream.

+
Specified by:
flush in interface Flushable
+
+
Throws:
IOException
@@ -265,18 +307,40 @@ public void

-println

+

+printRecord

-public void println(String... values)
-             throws IOException
+public void printRecord(Object... values) + throws IOException
-
Print a single line of comma separated values. - The values will be quoted if needed. Quotes and - newLine characters will be escaped. +
Prints a single line of delimiter separated values. The values will be quoted if needed. Quotes and newLine + characters will be escaped.

-
Parameters:
values - values to be outputted. +
+
+
+
Parameters:
values - values to output. +
Throws: +
IOException
+
+
+
+ +

+printRecord

+
+public void printRecord(Iterable<?> values)
+                 throws IOException
+
+
Prints a single line of delimiter separated values. The values will be quoted if needed. Quotes and newLine + characters will be escaped. +

+

+
+
+
+
Parameters:
values - values to output.
Throws:
IOException
@@ -286,17 +350,19 @@ public void

printComment

-public void printComment(String comment)
+public void printComment(String comment)
                   throws IOException
-
Put a comment on a new line among the comma separated values. Comments - will always begin on a new line and occupy a least one full line. The - character specified to start comments and a space will be inserted at - the beginning of each new line in the comment. -

+

Prints a comment on a new line among the delimiter separated values. Comments will always begin on a new line + and occupy a least one full line. The character specified to start comments and a space will be inserted at the + beginning of each new line in the comment. +

If comments are disabled in the current CSV format this method does nothing.

+
+
+
Parameters:
comment - the comment to output
Throws:
IOException
@@ -304,35 +370,96 @@ public void

+

print

-public void print(String value,
-                  boolean checkForEscape)
+public void print(Object value)
            throws IOException
-
Print the string as the next value on the line. The value - will be escaped or encapsulated as needed if checkForEscape==true +
Prints the string as the next value on the line. The value will be escaped or encapsulated as needed.

-
Parameters:
value - value to be outputted. +
+
+
+
Parameters:
value - value to be output.
Throws: -
IOException
+
IOException - If an I/O error occurs
-

-print

+

+printRecords

-public void print(String value)
-           throws IOException
+public void printRecords(Object[] values) + throws IOException +
+
Prints all the objects in the given array. +

+

+
+
+
+
Parameters:
values - the values to print. +
Throws: +
IOException - If an I/O error occurs
+
+
+
+ +

+printRecords

+
+public void printRecords(Iterable<?> values)
+                  throws IOException
-
Print the string as the next value on the line. The value - will be escaped or encapsulated as needed. +
Prints all the objects in the given collection.

-
Parameters:
value - value to be outputted. +
+
+
+
Parameters:
values - the values to print. +
Throws: +
IOException - If an I/O error occurs
+
+
+
+ +

+printRecords

+
+public void printRecords(ResultSet resultSet)
+                  throws SQLException,
+                         IOException
+
+
Prints all the objects in the given JDBC result set. +

+

+
+
+
+
Parameters:
resultSet - result set + the values to print. +
Throws: +
IOException - If an I/O error occurs +
SQLException
+
+
+
+ +

+close

+
+public void close()
+           throws IOException
+
+
+
Specified by:
close in interface Closeable
+
+
+
Throws:
IOException
@@ -368,7 +495,7 @@ public void  PREV CLASS  - NEXT CLASS + NEXT CLASS FRAMES    NO FRAMES   @@ -397,6 +524,6 @@ DETAIL: FIELD | The Apache Software Foundation. All Rights Reserved. +Copyright © 2013 The Apache Software Foundation. All Rights Reserved. - + \ No newline at end of file Added: websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVRecord.html ============================================================================== --- websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVRecord.html (added) +++ websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVRecord.html Thu Mar 21 15:20:15 2013 @@ -0,0 +1,432 @@ + + + + + + +CSVRecord (Commons CSV 1.0-SNAPSHOT API) + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.apache.commons.csv +
+Class CSVRecord

+
+java.lang.Object
+  extended by org.apache.commons.csv.CSVRecord
+
+
+
All Implemented Interfaces:
Serializable, Iterable<String>
+
+
+
+
public class CSVRecord
extends Object
implements Serializable, Iterable<String>
+ + +

+A CSV record parsed from a CSV file. +

+ +

+

+
Version:
+
$Id$
+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ Stringget(int i) + +
+          Returns a value by index.
+ Stringget(String name) + +
+          Returns a value by name.
+ StringgetComment() + +
+          Returns the comment for this record, if any.
+ longgetRecordNumber() + +
+          Returns the number of this record in the parsed CSV file.
+ booleanisMapped(String name) + +
+          Checks whether a given column is mapped.
+ booleanisSet(String name) + +
+          Checks whether a given columns is mapped and has a value.
+ Iterator<String>iterator() + +
+          Returns an iterator over the values of this record.
+ intsize() + +
+          Returns the number of values in this record.
+ StringtoString() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Method Detail
+ +

+get

+
+public String get(int i)
+
+
Returns a value by index. +

+

+
+
+
+
Parameters:
i - the index of the column retrieved
+
+
+
+ +

+get

+
+public String get(String name)
+
+
Returns a value by name. +

+

+
+
+
+
Parameters:
name - the name of the column to be retrieved. +
Returns:
the column value, or null if the column name is not found +
Throws: +
IllegalStateException - if no header mapping was provided
+
+
+
+ +

+isMapped

+
+public boolean isMapped(String name)
+
+
Checks whether a given column is mapped. +

+

+
+
+
+
Parameters:
name - the name of the column to be retrieved. +
Returns:
whether a given columns is mapped.
+
+
+
+ +

+isSet

+
+public boolean isSet(String name)
+
+
Checks whether a given columns is mapped and has a value. +

+

+
+
+
+
Parameters:
name - the name of the column to be retrieved. +
Returns:
whether a given columns is mapped.
+
+
+
+ +

+iterator

+
+public Iterator<String> iterator()
+
+
Returns an iterator over the values of this record. +

+

+
Specified by:
iterator in interface Iterable<String>
+
+
+ +
Returns:
an iterator over the values of this record.
+
+
+
+ +

+getComment

+
+public String getComment()
+
+
Returns the comment for this record, if any. +

+

+
+
+
+ +
Returns:
the comment for this record, or null if no comment for this + record is available.
+
+
+
+ +

+getRecordNumber

+
+public long getRecordNumber()
+
+
Returns the number of this record in the parsed CSV file. +

+

+
+
+
+ +
Returns:
the number of this record.
+
+
+
+ +

+size

+
+public int size()
+
+
Returns the number of values in this record. +

+

+
+
+
+ +
Returns:
the number of values.
+
+
+
+ +

+toString

+
+public String toString()
+
+
+
Overrides:
toString in class Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2013 The Apache Software Foundation. All Rights Reserved. + + \ No newline at end of file Propchange: websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVRecord.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/CSVRecord.html ------------------------------------------------------------------------------ svn:keywords = Id Added: websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/Quote.html ============================================================================== --- websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/Quote.html (added) +++ websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/Quote.html Thu Mar 21 15:20:15 2013 @@ -0,0 +1,371 @@ + + + + + + +Quote (Commons CSV 1.0-SNAPSHOT API) + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +org.apache.commons.csv +
+Enum Quote

+
+java.lang.Object
+  extended by java.lang.Enum<Quote>
+      extended by org.apache.commons.csv.Quote
+
+
+
All Implemented Interfaces:
Serializable, Comparable<Quote>
+
+
+
+
public enum Quote
extends Enum<Quote>
+ + +

+Defines quote behavior when printing. +

+ +

+

+
Version:
+
$Id$
+
+
+ +

+ + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
ALL + +
+          Quotes all fields.
MINIMAL + +
+          Quotes fields which contain special characters such as a delimiter, quote character or any of the characters in + line separator.
NON_NUMERIC + +
+          Quotes all non-numeric fields.
NONE + +
+          Never quotes fields.
+  + + + + + + + + + + + + + + + +
+Method Summary
+static QuotevalueOf(String name) + +
+          Returns the enum constant of this type with the specified name.
+static Quote[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they are declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+ALL

+
+public static final Quote ALL
+
+
Quotes all fields. +

+

+
+
+
+ +

+MINIMAL

+
+public static final Quote MINIMAL
+
+
Quotes fields which contain special characters such as a delimiter, quote character or any of the characters in + line separator. +

+

+
+
+
+ +

+NON_NUMERIC

+
+public static final Quote NON_NUMERIC
+
+
Quotes all non-numeric fields. +

+

+
+
+
+ +

+NONE

+
+public static final Quote NONE
+
+
Never quotes fields. When the delimiter occurs in data, it is preceded by the current escape character. If the + escape character is not set, printing will throw an exception if any characters that require escaping are + encountered. +

+

+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static Quote[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
+for (Quote c : Quote.values())
+    System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they are declared
+
+
+
+ +

+valueOf

+
+public static Quote valueOf(String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
IllegalArgumentException - if this enum type has no constant +with the specified name +
NullPointerException - if the argument is null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+Copyright © 2013 The Apache Software Foundation. All Rights Reserved. + + \ No newline at end of file Propchange: websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/Quote.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/Quote.html ------------------------------------------------------------------------------ svn:keywords = Id Added: 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 (added) +++ websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/class-use/CSVFormat.CSVFormatBuilder.html Thu Mar 21 15:20:15 2013 @@ -0,0 +1,284 @@ + + + + + + +Uses of Class org.apache.commons.csv.CSVFormat.CSVFormatBuilder (Commons CSV 1.0-SNAPSHOT API) + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
org.apache.commons.csv.CSVFormat.CSVFormatBuilder

+
+ + + + + +
+Uses of CSVFormat.CSVFormatBuilder in org.apache.commons.csv
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Methods in org.apache.commons.csv that return CSVFormat.CSVFormatBuilder
+static CSVFormat.CSVFormatBuilderCSVFormat.newBuilder() + +
+          Creates a standard comma separated format builder, as for CSVFormat.RFC4180 but allowing empty lines.
+static CSVFormat.CSVFormatBuilderCSVFormat.newBuilder(char delimiter) + +
+          Creates a new CSV format builder.
+static CSVFormat.CSVFormatBuilderCSVFormat.newBuilder(CSVFormat format) + +
+           
+ CSVFormat.CSVFormatBuilderCSVFormat.CSVFormatBuilder.withCommentStart(char commentStart) + +
+          Sets the comment start marker of the format to the specified character.
+ CSVFormat.CSVFormatBuilderCSVFormat.CSVFormatBuilder.withCommentStart(Character commentStart) + +
+          Sets the comment start marker of the format to the specified character.
+ CSVFormat.CSVFormatBuilderCSVFormat.CSVFormatBuilder.withDelimiter(char delimiter) + +
+          Sets the delimiter of the format to the specified character.
+ CSVFormat.CSVFormatBuilderCSVFormat.CSVFormatBuilder.withEscape(char escape) + +
+          Sets the escape character of the format to the specified character.
+ CSVFormat.CSVFormatBuilderCSVFormat.CSVFormatBuilder.withEscape(Character escape) + +
+          Sets the escape character of the format to the specified character.
+ CSVFormat.CSVFormatBuilderCSVFormat.CSVFormatBuilder.withHeader(String... header) + +
+          Sets the header of the format.
+ CSVFormat.CSVFormatBuilderCSVFormat.CSVFormatBuilder.withIgnoreEmptyLines(boolean ignoreEmptyLines) + +
+          Sets the empty line skipping behavior of the format.
+ CSVFormat.CSVFormatBuilderCSVFormat.CSVFormatBuilder.withIgnoreSurroundingSpaces(boolean ignoreSurroundingSpaces) + +
+          Sets the trimming behavior of the format.
+ CSVFormat.CSVFormatBuilderCSVFormat.CSVFormatBuilder.withQuoteChar(char quoteChar) + +
+          Sets the quoteChar of the format to the specified character.
+ CSVFormat.CSVFormatBuilderCSVFormat.CSVFormatBuilder.withQuoteChar(Character quoteChar) + +
+          Sets the quoteChar of the format to the specified character.
+ CSVFormat.CSVFormatBuilderCSVFormat.CSVFormatBuilder.withQuotePolicy(Quote quotePolicy) + +
+          Sets the output quote policy of the format to the specified value.
+ CSVFormat.CSVFormatBuilderCSVFormat.CSVFormatBuilder.withRecordSeparator(char recordSeparator) + +
+          Sets the record separator of the format to the specified character.
+ CSVFormat.CSVFormatBuilderCSVFormat.CSVFormatBuilder.withRecordSeparator(String recordSeparator) + +
+          Sets the record separator of the format to the specified String.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2013 The Apache Software Foundation. All Rights Reserved. + + \ No newline at end of file Propchange: websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/class-use/CSVFormat.CSVFormatBuilder.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: websites/production/commons/content/proper/commons-csv/apidocs/org/apache/commons/csv/class-use/CSVFormat.CSVFormatBuilder.html ------------------------------------------------------------------------------ svn:keywords = Id