Javadoc

Author: garydgregory

src/main/java/org/apache/commons/csv/CSVFormat.java

@@ -2315,7 +2315,7 @@ public synchronized void printRecord(final Appendable appendable, final Object..
     }
 
     /*
-     * Note: Must only be called if escaping is enabled, otherwise can throw exceptions.
+     * This method must only be called if escaping is enabled, otherwise can throw exceptions.
      */
     private void printWithEscapes(final CharSequence charSeq, final Appendable appendable) throws IOException {
         int start = 0;
@@ -2358,7 +2358,7 @@ private void printWithEscapes(final CharSequence charSeq, final Appendable appen
     }
 
     /*
-     * Note: Must only be called if escaping is enabled, otherwise can throw exceptions.
+     * This method must only be called if escaping is enabled, otherwise can throw exceptions.
      */
     private void printWithEscapes(final Reader reader, final Appendable appendable) throws IOException {
         int start = 0;
@@ -2408,9 +2408,9 @@ private void printWithEscapes(final Reader reader, final Appendable appendable)
     }
 
     /*
-     * Note: must only be called if quoting is enabled, otherwise will generate NPE
+     * This method must only be called if quoting is enabled, otherwise will generate NPE.
+     * The original object is needed so can check for Number
      */
-    // the original object is needed so can check for Number
     private void printWithQuotes(final Object object, final CharSequence charSeq, final Appendable out, final boolean newRecord) throws IOException {
         boolean quote = false;
         int start = 0;

src/main/java/org/apache/commons/csv/CSVPrinter.java

@@ -91,23 +91,19 @@ public final class CSVPrinter implements Flushable, Closeable {
     /**
      * Creates a printer that will print values to the given stream following the CSVFormat.
      * <p>
-     * 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.
+     * 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.
      * </p>
      *
-     * @param appendable
-     *            stream to which to print. Must not be null.
-     * @param format
-     *            the CSV format. Must not be null.
-     * @throws IOException
-     *             thrown if the optional header cannot be printed.
-     * @throws IllegalArgumentException
-     *             thrown if the parameters of the format are inconsistent or if either out or format are null.
+     * @param appendable stream to which to print. Must not be null.
+     * @param format     the CSV format. Must not be null.
+     * @throws IOException              thrown if the optional header cannot be printed.
+     * @throws IllegalArgumentException thrown if the parameters of the format are inconsistent.
+     * @throws NullPointerException     thrown if either parameters are null.
      */
     public CSVPrinter(final Appendable appendable, final CSVFormat format) throws IOException {
         Objects.requireNonNull(appendable, "appendable");
         Objects.requireNonNull(format, "format");
-
         this.appendable = appendable;
         this.format = format.copy();
         // TODO: Is it a good idea to do this here instead of on the first call to a print method?
@@ -130,10 +126,12 @@ public void close() throws IOException {
 
     /**
      * Closes the underlying stream with an optional flush first.
+     *
      * @param flush whether to flush before the actual close.
      * @throws IOException
      *             If an I/O error occurs
      * @since 1.6
+     * @see CSVFormat#getAutoFlush()
      */
     public void close(final boolean flush) throws IOException {
         if (flush || format.getAutoFlush()) {
@@ -145,7 +143,7 @@ public void close(final boolean flush) throws IOException {
     }
 
     /**
-     * Outputs the record separator and increments the record count.
+     * Prints the record separator and increments the record count.
      *
      * @throws IOException
      *             If an I/O error occurs
@@ -174,7 +172,7 @@ public void flush() throws IOException {
      * @return the target Appendable.
      */
     public Appendable getOut() {
-        return this.appendable;
+        return appendable;
     }
 
     /**
@@ -267,7 +265,7 @@ public synchronized void printHeaders(final ResultSet resultSet) throws IOExcept
     }
 
     /**
-     * Outputs the record separator.
+     * Prints the record separator.
      *
      * @throws IOException
      *             If an I/O error occurs