commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject svn commit: r1307210 - in /commons/proper/csv/trunk/src/main/java/org/apache/commons/csv: package-info.java package.html
Date Fri, 30 Mar 2012 01:51:29 GMT
Author: sebb
Date: Fri Mar 30 01:51:28 2012
New Revision: 1307210

URL: http://svn.apache.org/viewvc?rev=1307210&view=rev
Log:
Covert to new style package Javadoc; tidy

Added:
    commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/package-info.java
      - copied, changed from r1305693, commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/package.html
Removed:
    commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/package.html

Copied: commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/package-info.java (from
r1305693, commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/package.html)
URL: http://svn.apache.org/viewvc/commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/package-info.java?p2=commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/package-info.java&p1=commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/package.html&r1=1305693&r2=1307210&rev=1307210&view=diff
==============================================================================
--- commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/package.html (original)
+++ commons/proper/csv/trunk/src/main/java/org/apache/commons/csv/package-info.java Fri Mar
30 01:51:28 2012
@@ -1,87 +1,80 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements.  See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License.  You may obtain a copy of the License at
- 
-      http://www.apache.org/licenses/LICENSE-2.0
- 
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
---> 
-<html>
-<head>
-<title>org.apache.commons.csv package</title>
-</head>
-<body>
-<h3>Apache Commons CSV Format Support</h3>
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+/**
+ * Apache Commons CSV Format Support.
+ * 
+ * <p>CSV (or its dialects) are widely used as interfaces to legacy systems or
+ *    manual data-imports. Basically CSV stands for "Comma Separated Values" but
+ *    this simple abbreviation leads to more confusion than definitions.</p>
+ *    
+ * <p>Common to all file dialects is its basic structure: The CSV data-format
+ *    is record oriented, whereas each record starts on a new textual line. A
+ *    record is build of a list of values. Keep in mind that not all records
+ *    must have an equal number of values:</p>
+ * <pre>
+ *       csv    := records*
+ *       record := values*
+ * </pre>
+ * 
+ * <p>The following list contains the csv aspects the Commons CSV parser supports:</p>
+ * <dl>
+ *   <dt>Separators (for lines)</dt>
+ *   <dd>The record separators are hardcoded and cannot be changed. The must be '\r',
'\n' or '\r\n'.</dd>
+ * 
+ *   <dt>Delimiter (for values)</dt>
+ *   <dd>The delimiter for values is freely configurable (default ',').</dd>
+ * 
+ *   <dt>Comments</dt>
+ *   <dd>Some CSV-dialects support a simple comment syntax. A comment is a record
+ *       which must start with a designated character (the commentStarter). A record
+ *       of this kind is treated as comment and gets removed from the input (default none)</dd>
+ * 
+ *   <dt>Encapsulator</dt>
+ *  <dd>Two encapsulator characters (default '"') are used to enclose -&gt; complex
values.</dd>
+ *       
+ *   <dt>Simple values</dt>
+ *   <dd>A simple value consist of all characters (except the delimiter) until 
+ *       (but not including) the next delimiter or a record-terminator. Optionally
+ *       all surrounding whitespaces of a simple value can be ignored (default: true).</dd>
+ *      
+ *   <dt>Complex values</dt>
+ *   <dd>Complex values are encapsulated within a pair of the defined encapsulator
characters.
+ *       The encapsulator itself must be escaped or doubled when used inside complex values.
+ *       Complex values preserve all kind of formatting (including newlines -&gt; multiline-values)</dd>
+ * 
+ *  <dt>Empty line skipping</dt>
+ *   <dd>Optionally empty lines in CSV files can be skipped. 
+ *       Otherwise, empty lines will return a record with a single empty value.</dd>
+ * </dl>
+ * 
+ * <p>In addition to individually defined dialects, two predefined dialects (strict-csv,
and excel-csv) 
+ *    can be set directly.</p> <!-- TODO fix -->
+ * 
+ * <p>Example usage:</p>
+ * <blockquote><pre>
+ * Reader in = new StringReader("a,b,c");
+ * for (CSVRecord record : CSVFormat.DEFAULT.parse(in)) {
+ *     for (int i = 0; i &lt; record.length; i++) {
+ *         System.out.println("value " + i + "=" + record.get(i));
+ *     }
+ * }
+ * </pre></blockquote>
+ */
 
-<p>CSV (or its dialects) are widely used as interfaces to legacy systems or
-   manual data-imports. Basically CSV stands for "Comma Separated Values" but
-   this simple abbreviation leads to more confusion than definitions.</p>
-   
-<p>Common to all file dialects is its basic structure: The CSV data-format
-   is record oriented, whereas each record starts on a new textual line. A
-   record is build of a list of values. Keep in mind that not all records
-   must have an equal number of values:</p>
-<pre>
-      csv    := records*
-      record := values*
-</pre>
-
-<p>The following list contains the csv aspects the Commons CSV parser supports:</p>
-<dl>
-  <dt>Separators (for lines)</dt>
-  <dd>The record separators are hardcoded and cannot be changed. The must be '\n' or
'\r\n'.</dd>
-
-  <dt>Delimiter (for values)</dt>
-  <dd>The delimiter for values is freely configurable (default ',').</dd>
-
-  <dt>Comments</dt>
-  <dd>Some CSV-dialects support a simple comment syntax. A comment is a record
-      which must start with a designated character (the commentStarter). A record
-      of this kind is treated as comment and gets removed from the input (default '(char)0')</dd>
- 
-  <dt>Encapsulator</dt>
-  <dd>Two encapsulator characters (default '"') are used to enclose -&gt; complex
values.</dd>
-      
-  <dt>Simple values</dt>
-  <dd>A simple value consist of all characters (except the separator) until 
-      (but not including) the next separator or a record-terminator. Optionally
-      all leading whitespaces of a simple value can be ignored (default: true).</dd>
-     
-  <dt>Complex values</dt>
-  <dd>Complex values are encapsulated within the defined encapsulator character.
-      The encapsulator itself must be escaped by '\' or doubled when used inside complex
values.
-      Complex values preserve all kind of formatting (including newlines -&gt; multiline-values)</dd>
-
-  <dt>Unicode escapes</dt>
-  <dd>Some non-unicode CSVs use unicode escaping sequences for certain unicode characters.
The standard
-      unicode-escaping is '\uXXXX' whereas XXXX is the unicode-character-code in hex-format.
The parser
-      can optionally resolve unicode escapes (default: disabled).</dd>
-
-  <dt>Empty line skipping</dt>
-  <dd>Optionally empty lines in CSV files might be skiped. Not skiping empty lines
will return
-      an empty record on '\nEOF' combinations.</dd>
-</dl>
-
-<p>In addition to individually defined dialects, two predefined dialects (strict-csv,
and excel-csv) 
-   can be set directly.</p>  
-
-<p>Example usage:</p>
-<blockquote><pre>
-Reader in = new StringReader("a,b,c");
-for (CSVRecord record : CSVFormat.DEFAULT.parse(in)) {
-    for (int i = 0; i &lt; record.length; i++) {
-        System.out.println("value " + i + "=" + record.get(i));
-    }
-}
-</pre></blockquote>
-</body>
-</html>
+package org.apache.commons.csv;



Mime
View raw message