Javadoc: @version.

git-svn-id: https://svn.apache.org/repos/asf/commons/proper/csv/trunk@1398183 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Gary D. Gregory 2012-10-15 03:25:52 +00:00
parent fc11e68728
commit 6eddd544e5
22 changed files with 65 additions and 0 deletions

View File

@ -34,6 +34,8 @@ import java.io.StringWriter;
* The format specification of a CSV file. * The format specification of a CSV file.
* *
* This class is immutable. * This class is immutable.
*
* @version $Id: $
*/ */
public class CSVFormat implements Serializable { public class CSVFormat implements Serializable {

View File

@ -25,6 +25,11 @@ import static org.apache.commons.csv.Token.Type.TOKEN;
import java.io.IOException; import java.io.IOException;
/**
*
*
* @version $Id$
*/
final class CSVLexer extends Lexer { final class CSVLexer extends Lexer {
/** ctor needs to be public so can be called dynamically by PerformanceTest class */ /** ctor needs to be public so can be called dynamically by PerformanceTest class */

View File

@ -65,6 +65,8 @@ import java.util.NoSuchElementException;
* <p> * <p>
* see <a href="package-summary.html">package documentation</a> for more details * see <a href="package-summary.html">package documentation</a> for more details
* </p> * </p>
*
* @version $Id: $
*/ */
public class CSVParser implements Iterable<CSVRecord> { public class CSVParser implements Iterable<CSVRecord> {

View File

@ -30,6 +30,8 @@ import java.sql.SQLException;
/** /**
* Prints values in a CSV format. * Prints values in a CSV format.
*
* @version $Id: $
*/ */
public class CSVPrinter { public class CSVPrinter {

View File

@ -24,6 +24,8 @@ import java.util.Map;
/** /**
* A CSV record * A CSV record
*
* @version $Id: $
*/ */
public class CSVRecord implements Serializable, Iterable<String> { public class CSVRecord implements Serializable, Iterable<String> {

View File

@ -31,6 +31,8 @@ import java.io.Reader;
* <p> * <p>
* In particular the reader supports a look-ahead option, which allows you to see the next char returned by * In particular the reader supports a look-ahead option, which allows you to see the next char returned by
* {@link #read()}. * {@link #read()}.
*
* @version $Id: $
*/ */
final class ExtendedBufferedReader extends BufferedReader { final class ExtendedBufferedReader extends BufferedReader {

View File

@ -29,6 +29,8 @@ import java.io.IOException;
/** /**
* Abstract lexer class; contains common utility routines shared by lexers * Abstract lexer class; contains common utility routines shared by lexers
*
* @version $Id$
*/ */
abstract class Lexer { abstract class Lexer {

View File

@ -18,6 +18,8 @@ package org.apache.commons.csv;
/** /**
* Defines quote behavior when printing. * Defines quote behavior when printing.
*
* @version $Id$
*/ */
public enum Quote { public enum Quote {

View File

@ -23,6 +23,8 @@ import static org.apache.commons.csv.Token.Type.INVALID;
* Internal token representation. * Internal token representation.
* <p/> * <p/>
* It is used as contract between the lexer and the parser. * It is used as contract between the lexer and the parser.
*
* @version $Id$
*/ */
final class Token { final class Token {

View File

@ -40,6 +40,7 @@ import org.junit.runners.Parameterized.Parameters;
/** /**
* Parse tests using test files * Parse tests using test files
* *
* @version $Id$
*/ */
@RunWith(Parameterized.class) @RunWith(Parameterized.class)
public class CSVFileParserTest { public class CSVFileParserTest {

View File

@ -31,6 +31,11 @@ import java.io.ObjectOutputStream;
import org.junit.Test; import org.junit.Test;
/**
*
*
* @version $Id: $
*/
public class CSVFormatTest { public class CSVFormatTest {
@Test @Test

View File

@ -24,6 +24,11 @@ import static org.apache.commons.csv.Token.Type.TOKEN;
import java.io.IOException; import java.io.IOException;
/**
*
*
* @version $Id$
*/
class CSVLexer1 extends Lexer { class CSVLexer1 extends Lexer {
private final StringBuilder wsBuf = new StringBuilder(); private final StringBuilder wsBuf = new StringBuilder();

View File

@ -25,6 +25,11 @@ import static org.apache.commons.csv.Token.Type.TOKEN;
import java.io.IOException; import java.io.IOException;
/**
*
*
* @version $Id$
*/
class CSVLexer1306663 extends Lexer { class CSVLexer1306663 extends Lexer {
// ctor needs to be public so can be called dynamically by PerformanceTest class // ctor needs to be public so can be called dynamically by PerformanceTest class

View File

@ -25,6 +25,11 @@ import static org.apache.commons.csv.Token.Type.TOKEN;
import java.io.IOException; import java.io.IOException;
/**
*
*
* @version $Id$
*/
class CSVLexer1306667 extends Lexer { class CSVLexer1306667 extends Lexer {
// ctor needs to be public so can be called dynamically by PerformanceTest class // ctor needs to be public so can be called dynamically by PerformanceTest class

View File

@ -31,6 +31,7 @@ import java.io.IOException;
* Unfortunately it is twice as slow. * Unfortunately it is twice as slow.
* For reference purpose only. * For reference purpose only.
* *
* @version $Id$
*/ */
class CSVLexer3 extends Lexer { class CSVLexer3 extends Lexer {

View File

@ -31,6 +31,11 @@ import java.io.StringReader;
import org.junit.Test; import org.junit.Test;
/**
*
*
* @version $Id$
*/
public class CSVLexerTest { public class CSVLexerTest {
private Lexer getLexer(final String input, final CSVFormat format) { private Lexer getLexer(final String input, final CSVFormat format) {

View File

@ -51,6 +51,8 @@ import org.junit.Test;
* section. In case a test fails, you should follow a top-down approach for * section. In case a test fails, you should follow a top-down approach for
* fixing a potential bug (its likely that the parser itself fails if the lexer * fixing a potential bug (its likely that the parser itself fails if the lexer
* has problems...). * has problems...).
*
* @version $Id: $
*/ */
public class CSVParserTest { public class CSVParserTest {

View File

@ -32,6 +32,11 @@ import java.util.Random;
import org.junit.Test; import org.junit.Test;
/**
*
*
* @version $Id: $
*/
public class CSVPrinterTest { public class CSVPrinterTest {
public static String printable(final String s) { public static String printable(final String s) {

View File

@ -27,6 +27,11 @@ import java.io.StringReader;
import org.junit.Test; import org.junit.Test;
/**
*
*
* @version $Id: $
*/
public class ExtendedBufferedReaderTest { public class ExtendedBufferedReaderTest {
@Test @Test

View File

@ -35,6 +35,7 @@ import org.apache.commons.io.IOUtils;
* *
* Requires test file to be downloaded separately. * Requires test file to be downloaded separately.
* *
* @version $Id$
*/ */
@SuppressWarnings("boxing") @SuppressWarnings("boxing")
public class PerformanceTest { public class PerformanceTest {

View File

@ -24,6 +24,8 @@ import org.junit.Assert;
/** /**
* Utility methods for test cases * Utility methods for test cases
*
* @version $Id$
*/ */
public class Utils { public class Utils {

View File

@ -39,6 +39,8 @@ import org.junit.Test;
* Tests performance. * Tests performance.
* *
* To run this test, use: mvn test -Dtest=PeformanceTest * To run this test, use: mvn test -Dtest=PeformanceTest
*
* @version $Id$
*/ */
public class PerformanceTest { public class PerformanceTest {