You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by Niall Pemberton <ni...@gmail.com> on 2008/02/10 02:37:54 UTC
Re: svn commit: r620174 - /commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java
Its painful to have to look through 30 pages of a commit message thats
mostly re-formatting to find the real changes - which from what I can
see is four method signature changes and a bit of minor refactoring.
Could you please do reformatting type changes as a separate commit so
it makes it easier to follow along. Also in this case I don't think
most of the reformatting improved anything and things like splitting
@param statements over two lines is actually worse tor read.
Niall
P.S. for anyone who gave up trying to see what changed, from what I
could see it was the following four methods:
public static List<String> readLines(InputStream input)
public static List<String> readLines(InputStream input, String encoding)
public static void writeLines(Collection<?> values, String lineEnding,
OutputStream output)
public static void writeLines(Collection<?> values, String lineEnding,
OutputStream output, String encoding)
On Feb 9, 2008 6:52 PM, <gg...@apache.org> wrote:
> Author: ggregory
> Date: Sat Feb 9 10:52:19 2008
> New Revision: 620174
>
> URL: http://svn.apache.org/viewvc?rev=620174&view=rev
> Log:
> Use generics.
>
> Modified:
> commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java
>
> Modified: commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java
> URL: http://svn.apache.org/viewvc/commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java?rev=620174&r1=620173&r2=620174&view=diff
> ==============================================================================
> --- commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java (original)
> +++ commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java Sat Feb 9 10:52:19 2008
> @@ -14,6 +14,7 @@
> * See the License for the specific language governing permissions and
> * limitations under the License.
> */
> +
> package org.apache.commons.io;
>
> import java.io.BufferedInputStream;
> @@ -30,6 +31,7 @@
> import java.io.Reader;
> import java.io.Writer;
> import java.nio.channels.Channel;
> +import java.nio.charset.Charset;
> import java.util.ArrayList;
> import java.util.Collection;
> import java.util.Iterator;
> @@ -50,25 +52,21 @@
> * <li>contentEquals - these methods compare the content of two streams
> * </ul>
> * <p>
> - * The byte-to-char methods and char-to-byte methods involve a conversion step.
> - * Two methods are provided in each case, one that uses the platform default
> - * encoding and the other which allows you to specify an encoding. You are
> - * encouraged to always specify an encoding because relying on the platform
> - * default can lead to unexpected results, for example when moving from
> - * development to production.
> + * The byte-to-char methods and char-to-byte methods involve a conversion step. Two methods are provided in each case,
> + * one that uses the platform default encoding and the other which allows you to specify an encoding. You are encouraged
> + * to always specify an encoding because relying on the platform default can lead to unexpected results, for example
> + * when moving from development to production.
> * <p>
> - * All the methods in this class that read a stream are buffered internally.
> - * This means that there is no cause to use a <code>BufferedInputStream</code>
> - * or <code>BufferedReader</code>. The default buffer size of 4K has been shown
> - * to be efficient in tests.
> + * All the methods in this class that read a stream are buffered internally. This means that there is no cause to use a
> + * <code>BufferedInputStream</code> or <code>BufferedReader</code>. The default buffer size of 4K has been shown to
> + * be efficient in tests.
> * <p>
> - * Wherever possible, the methods in this class do <em>not</em> flush or close
> - * the stream. This is to avoid making non-portable assumptions about the
> - * streams' origin and further use. Thus the caller is still responsible for
> - * closing streams after use.
> + * Wherever possible, the methods in this class do <em>not</em> flush or close the stream. This is to avoid making
> + * non-portable assumptions about the streams' origin and further use. Thus the caller is still responsible for closing
> + * streams after use.
> * <p>
> * Origin of code: Excalibur.
> - *
> + *
> * @author Peter Donald
> * @author Jeff Turner
> * @author Matthew Hawthorne
> @@ -80,7 +78,7 @@
> * @version $Id$
> */
> public class IOUtils {
> - // NOTE: This class is focussed on InputStream, OutputStream, Reader and
> + // NOTE: This class is focused on InputStream, OutputStream, Reader and
> // Writer. Each method should take at least one of these as a parameter,
> // or return one of them.
>
> @@ -88,22 +86,27 @@
> * The Unix directory separator character.
> */
> public static final char DIR_SEPARATOR_UNIX = '/';
> +
> /**
> * The Windows directory separator character.
> */
> public static final char DIR_SEPARATOR_WINDOWS = '\\';
> +
> /**
> * The system directory separator character.
> */
> public static final char DIR_SEPARATOR = File.separatorChar;
> +
> /**
> * The Unix line separator string.
> */
> public static final String LINE_SEPARATOR_UNIX = "\n";
> +
> /**
> * The Windows line separator string.
> */
> public static final String LINE_SEPARATOR_WINDOWS = "\r\n";
> +
> /**
> * The system line separator string.
> */
> @@ -128,14 +131,15 @@
> super();
> }
>
> - //-----------------------------------------------------------------------
> + // -----------------------------------------------------------------------
> /**
> * Unconditionally close an <code>Reader</code>.
> * <p>
> - * Equivalent to {@link Reader#close()}, except any exceptions will be ignored.
> - * This is typically used in finally blocks.
> - *
> - * @param input the Reader to close, may be null or already closed
> + * Equivalent to {@link Reader#close()}, except any exceptions will be ignored. This is typically used in finally
> + * blocks.
> + *
> + * @param input
> + * the Reader to close, may be null or already closed
> */
> public static void closeQuietly(Reader input) {
> try {
> @@ -150,10 +154,11 @@
> /**
> * Unconditionally close a <code>Channel</code>.
> * <p>
> - * Equivalent to {@link Channel#close()}, except any exceptions will be ignored.
> - * This is typically used in finally blocks.
> - *
> - * @param channel the Channel to close, may be null or already closed
> + * Equivalent to {@link Channel#close()}, except any exceptions will be ignored. This is typically used in finally
> + * blocks.
> + *
> + * @param channel
> + * the Channel to close, may be null or already closed
> */
> public static void closeQuietly(Channel channel) {
> try {
> @@ -168,10 +173,11 @@
> /**
> * Unconditionally close a <code>Writer</code>.
> * <p>
> - * Equivalent to {@link Writer#close()}, except any exceptions will be ignored.
> - * This is typically used in finally blocks.
> - *
> - * @param output the Writer to close, may be null or already closed
> + * Equivalent to {@link Writer#close()}, except any exceptions will be ignored. This is typically used in finally
> + * blocks.
> + *
> + * @param output
> + * the Writer to close, may be null or already closed
> */
> public static void closeQuietly(Writer output) {
> try {
> @@ -186,10 +192,11 @@
> /**
> * Unconditionally close an <code>InputStream</code>.
> * <p>
> - * Equivalent to {@link InputStream#close()}, except any exceptions will be ignored.
> - * This is typically used in finally blocks.
> - *
> - * @param input the InputStream to close, may be null or already closed
> + * Equivalent to {@link InputStream#close()}, except any exceptions will be ignored. This is typically used in
> + * finally blocks.
> + *
> + * @param input
> + * the InputStream to close, may be null or already closed
> */
> public static void closeQuietly(InputStream input) {
> try {
> @@ -204,10 +211,11 @@
> /**
> * Unconditionally close an <code>OutputStream</code>.
> * <p>
> - * Equivalent to {@link OutputStream#close()}, except any exceptions will be ignored.
> - * This is typically used in finally blocks.
> - *
> - * @param output the OutputStream to close, may be null or already closed
> + * Equivalent to {@link OutputStream#close()}, except any exceptions will be ignored. This is typically used in
> + * finally blocks.
> + *
> + * @param output
> + * the OutputStream to close, may be null or already closed
> */
> public static void closeQuietly(OutputStream output) {
> try {
> @@ -220,17 +228,19 @@
> }
>
> // read toByteArray
> - //-----------------------------------------------------------------------
> + // -----------------------------------------------------------------------
> /**
> * Get the contents of an <code>InputStream</code> as a <code>byte[]</code>.
> * <p>
> - * This method buffers the input internally, so there is no need to use a
> - * <code>BufferedInputStream</code>.
> + * This method buffers the input internally, so there is no need to use a <code>BufferedInputStream</code>.
> *
> - * @param input the <code>InputStream</code> to read from
> + * @param input
> + * the <code>InputStream</code> to read from
> * @return the requested byte array
> - * @throws NullPointerException if the input is null
> - * @throws IOException if an I/O error occurs
> + * @throws NullPointerException
> + * if the input is null
> + * @throws IOException
> + * if an I/O error occurs
> */
> public static byte[] toByteArray(InputStream input) throws IOException {
> ByteArrayOutputStream output = new ByteArrayOutputStream();
> @@ -239,16 +249,18 @@
> }
>
> /**
> - * Get the contents of a <code>Reader</code> as a <code>byte[]</code>
> - * using the default character encoding of the platform.
> + * Get the contents of a <code>Reader</code> as a <code>byte[]</code> using the default character encoding of
> + * the platform.
> * <p>
> - * This method buffers the input internally, so there is no need to use a
> - * <code>BufferedReader</code>.
> + * This method buffers the input internally, so there is no need to use a <code>BufferedReader</code>.
> *
> - * @param input the <code>Reader</code> to read from
> + * @param input
> + * the <code>Reader</code> to read from
> * @return the requested byte array
> - * @throws NullPointerException if the input is null
> - * @throws IOException if an I/O error occurs
> + * @throws NullPointerException
> + * if the input is null
> + * @throws IOException
> + * if an I/O error occurs
> */
> public static byte[] toByteArray(Reader input) throws IOException {
> ByteArrayOutputStream output = new ByteArrayOutputStream();
> @@ -257,39 +269,42 @@
> }
>
> /**
> - * Get the contents of a <code>Reader</code> as a <code>byte[]</code>
> - * using the specified character encoding.
> + * Get the contents of a <code>Reader</code> as a <code>byte[]</code> using the specified character encoding.
> * <p>
> - * Character encoding names can be found at
> - * <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> + * Character encoding names can be found at <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> * <p>
> - * This method buffers the input internally, so there is no need to use a
> - * <code>BufferedReader</code>.
> + * This method buffers the input internally, so there is no need to use a <code>BufferedReader</code>.
> *
> - * @param input the <code>Reader</code> to read from
> - * @param encoding the encoding to use, null means platform default
> + * @param input
> + * the <code>Reader</code> to read from
> + * @param encoding
> + * the encoding to use, null means platform default
> * @return the requested byte array
> - * @throws NullPointerException if the input is null
> - * @throws IOException if an I/O error occurs
> + * @throws NullPointerException
> + * if the input is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> */
> - public static byte[] toByteArray(Reader input, String encoding)
> - throws IOException {
> + public static byte[] toByteArray(Reader input, String encoding) throws IOException {
> ByteArrayOutputStream output = new ByteArrayOutputStream();
> copy(input, output, encoding);
> return output.toByteArray();
> }
>
> /**
> - * Get the contents of a <code>String</code> as a <code>byte[]</code>
> - * using the default character encoding of the platform.
> + * Get the contents of a <code>String</code> as a <code>byte[]</code> using the default character encoding of
> + * the platform.
> * <p>
> * This is the same as {@link String#getBytes()}.
> *
> - * @param input the <code>String</code> to convert
> + * @param input
> + * the <code>String</code> to convert
> * @return the requested byte array
> - * @throws NullPointerException if the input is null
> - * @throws IOException if an I/O error occurs (never occurs)
> + * @throws NullPointerException
> + * if the input is null
> + * @throws IOException
> + * if an I/O error occurs (never occurs)
> * @deprecated Use {@link String#getBytes()}
> */
> public static byte[] toByteArray(String input) throws IOException {
> @@ -297,18 +312,20 @@
> }
>
> // read char[]
> - //-----------------------------------------------------------------------
> + // -----------------------------------------------------------------------
> /**
> - * Get the contents of an <code>InputStream</code> as a character array
> - * using the default character encoding of the platform.
> + * Get the contents of an <code>InputStream</code> as a character array using the default character encoding of
> + * the platform.
> * <p>
> - * This method buffers the input internally, so there is no need to use a
> - * <code>BufferedInputStream</code>.
> + * This method buffers the input internally, so there is no need to use a <code>BufferedInputStream</code>.
> *
> - * @param is the <code>InputStream</code> to read from
> + * @param is
> + * the <code>InputStream</code> to read from
> * @return the requested character array
> - * @throws NullPointerException if the input is null
> - * @throws IOException if an I/O error occurs
> + * @throws NullPointerException
> + * if the input is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> */
> public static char[] toCharArray(InputStream is) throws IOException {
> @@ -318,24 +335,24 @@
> }
>
> /**
> - * Get the contents of an <code>InputStream</code> as a character array
> - * using the specified character encoding.
> + * Get the contents of an <code>InputStream</code> as a character array using the specified character encoding.
> * <p>
> - * Character encoding names can be found at
> - * <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> + * Character encoding names can be found at <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> * <p>
> - * This method buffers the input internally, so there is no need to use a
> - * <code>BufferedInputStream</code>.
> + * This method buffers the input internally, so there is no need to use a <code>BufferedInputStream</code>.
> *
> - * @param is the <code>InputStream</code> to read from
> - * @param encoding the encoding to use, null means platform default
> + * @param is
> + * the <code>InputStream</code> to read from
> + * @param encoding
> + * the encoding to use, null means platform default
> * @return the requested character array
> - * @throws NullPointerException if the input is null
> - * @throws IOException if an I/O error occurs
> + * @throws NullPointerException
> + * if the input is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> */
> - public static char[] toCharArray(InputStream is, String encoding)
> - throws IOException {
> + public static char[] toCharArray(InputStream is, String encoding) throws IOException {
> CharArrayWriter output = new CharArrayWriter();
> copy(is, output, encoding);
> return output.toCharArray();
> @@ -344,13 +361,15 @@
> /**
> * Get the contents of a <code>Reader</code> as a character array.
> * <p>
> - * This method buffers the input internally, so there is no need to use a
> - * <code>BufferedReader</code>.
> + * This method buffers the input internally, so there is no need to use a <code>BufferedReader</code>.
> *
> - * @param input the <code>Reader</code> to read from
> + * @param input
> + * the <code>Reader</code> to read from
> * @return the requested character array
> - * @throws NullPointerException if the input is null
> - * @throws IOException if an I/O error occurs
> + * @throws NullPointerException
> + * if the input is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> */
> public static char[] toCharArray(Reader input) throws IOException {
> @@ -360,18 +379,20 @@
> }
>
> // read toString
> - //-----------------------------------------------------------------------
> + // -----------------------------------------------------------------------
> /**
> - * Get the contents of an <code>InputStream</code> as a String
> - * using the default character encoding of the platform.
> + * Get the contents of an <code>InputStream</code> as a String using the default character encoding of the
> + * platform.
> * <p>
> - * This method buffers the input internally, so there is no need to use a
> - * <code>BufferedInputStream</code>.
> + * This method buffers the input internally, so there is no need to use a <code>BufferedInputStream</code>.
> *
> - * @param input the <code>InputStream</code> to read from
> + * @param input
> + * the <code>InputStream</code> to read from
> * @return the requested String
> - * @throws NullPointerException if the input is null
> - * @throws IOException if an I/O error occurs
> + * @throws NullPointerException
> + * if the input is null
> + * @throws IOException
> + * if an I/O error occurs
> */
> public static String toString(InputStream input) throws IOException {
> StringBuilderWriter sw = new StringBuilderWriter();
> @@ -380,23 +401,23 @@
> }
>
> /**
> - * Get the contents of an <code>InputStream</code> as a String
> - * using the specified character encoding.
> + * Get the contents of an <code>InputStream</code> as a String using the specified character encoding.
> * <p>
> - * Character encoding names can be found at
> - * <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> + * Character encoding names can be found at <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> * <p>
> - * This method buffers the input internally, so there is no need to use a
> - * <code>BufferedInputStream</code>.
> + * This method buffers the input internally, so there is no need to use a <code>BufferedInputStream</code>.
> *
> - * @param input the <code>InputStream</code> to read from
> - * @param encoding the encoding to use, null means platform default
> + * @param input
> + * the <code>InputStream</code> to read from
> + * @param encoding
> + * the encoding to use, null means platform default
> * @return the requested String
> - * @throws NullPointerException if the input is null
> - * @throws IOException if an I/O error occurs
> + * @throws NullPointerException
> + * if the input is null
> + * @throws IOException
> + * if an I/O error occurs
> */
> - public static String toString(InputStream input, String encoding)
> - throws IOException {
> + public static String toString(InputStream input, String encoding) throws IOException {
> StringBuilderWriter sw = new StringBuilderWriter();
> copy(input, sw, encoding);
> return sw.toString();
> @@ -405,13 +426,15 @@
> /**
> * Get the contents of a <code>Reader</code> as a String.
> * <p>
> - * This method buffers the input internally, so there is no need to use a
> - * <code>BufferedReader</code>.
> + * This method buffers the input internally, so there is no need to use a <code>BufferedReader</code>.
> *
> - * @param input the <code>Reader</code> to read from
> + * @param input
> + * the <code>Reader</code> to read from
> * @return the requested String
> - * @throws NullPointerException if the input is null
> - * @throws IOException if an I/O error occurs
> + * @throws NullPointerException
> + * if the input is null
> + * @throws IOException
> + * if an I/O error occurs
> */
> public static String toString(Reader input) throws IOException {
> StringBuilderWriter sw = new StringBuilderWriter();
> @@ -420,13 +443,15 @@
> }
>
> /**
> - * Get the contents of a <code>byte[]</code> as a String
> - * using the default character encoding of the platform.
> + * Get the contents of a <code>byte[]</code> as a String using the default character encoding of the platform.
> *
> - * @param input the byte array to read from
> + * @param input
> + * the byte array to read from
> * @return the requested String
> - * @throws NullPointerException if the input is null
> - * @throws IOException if an I/O error occurs (never occurs)
> + * @throws NullPointerException
> + * if the input is null
> + * @throws IOException
> + * if an I/O error occurs (never occurs)
> * @deprecated Use {@link String#String(byte[])}
> */
> public static String toString(byte[] input) throws IOException {
> @@ -434,85 +459,87 @@
> }
>
> /**
> - * Get the contents of a <code>byte[]</code> as a String
> - * using the specified character encoding.
> + * Get the contents of a <code>byte[]</code> as a String using the specified character encoding.
> * <p>
> - * Character encoding names can be found at
> - * <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> + * Character encoding names can be found at <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> *
> - * @param input the byte array to read from
> - * @param encoding the encoding to use, null means platform default
> + * @param input
> + * the byte array to read from
> + * @param encoding
> + * the encoding to use, null means platform default
> * @return the requested String
> - * @throws NullPointerException if the input is null
> - * @throws IOException if an I/O error occurs (never occurs)
> + * @throws NullPointerException
> + * if the input is null
> + * @throws IOException
> + * if an I/O error occurs (never occurs)
> * @deprecated Use {@link String#String(byte[],String)}
> */
> - public static String toString(byte[] input, String encoding)
> - throws IOException {
> + public static String toString(byte[] input, String encoding) throws IOException {
> if (encoding == null) {
> return new String(input);
> - } else {
> - return new String(input, encoding);
> }
> + return new String(input, encoding);
> }
>
> // readLines
> - //-----------------------------------------------------------------------
> + // -----------------------------------------------------------------------
> /**
> - * Get the contents of an <code>InputStream</code> as a list of Strings,
> - * one entry per line, using the default character encoding of the platform.
> + * Get the contents of an <code>InputStream</code> as a list of Strings, one entry per line, using the default
> + * character encoding of the platform.
> * <p>
> - * This method buffers the input internally, so there is no need to use a
> - * <code>BufferedInputStream</code>.
> - *
> - * @param input the <code>InputStream</code> to read from, not null
> + * This method buffers the input internally, so there is no need to use a <code>BufferedInputStream</code>.
> + *
> + * @param input
> + * the <code>InputStream</code> to read from, not null
> * @return the list of Strings, never null
> - * @throws NullPointerException if the input is null
> - * @throws IOException if an I/O error occurs
> + * @throws NullPointerException
> + * if the input is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> */
> - public static List readLines(InputStream input) throws IOException {
> - InputStreamReader reader = new InputStreamReader(input);
> - return readLines(reader);
> + public static List<String> readLines(InputStream input) throws IOException {
> + return readLines(new InputStreamReader(input));
> }
>
> /**
> - * Get the contents of an <code>InputStream</code> as a list of Strings,
> - * one entry per line, using the specified character encoding.
> + * Get the contents of an <code>InputStream</code> as a list of Strings, one entry per line, using the specified
> + * character encoding.
> * <p>
> - * Character encoding names can be found at
> - * <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> + * Character encoding names can be found at <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> * <p>
> - * This method buffers the input internally, so there is no need to use a
> - * <code>BufferedInputStream</code>.
> - *
> - * @param input the <code>InputStream</code> to read from, not null
> - * @param encoding the encoding to use, null means platform default
> + * This method buffers the input internally, so there is no need to use a <code>BufferedInputStream</code>.
> + *
> + * @param input
> + * the <code>InputStream</code> to read from, not null
> + * @param encoding
> + * the encoding to use, null means platform default
> * @return the list of Strings, never null
> - * @throws NullPointerException if the input is null
> - * @throws IOException if an I/O error occurs
> + * @throws NullPointerException
> + * if the input is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> */
> - public static List readLines(InputStream input, String encoding) throws IOException {
> + public static List<String> readLines(InputStream input, String encoding) throws IOException {
> if (encoding == null) {
> return readLines(input);
> - } else {
> - InputStreamReader reader = new InputStreamReader(input, encoding);
> - return readLines(reader);
> }
> + return readLines(new InputStreamReader(input, encoding));
> }
>
> /**
> - * Get the contents of a <code>Reader</code> as a list of Strings,
> - * one entry per line.
> + * Get the contents of a <code>Reader</code> as a list of Strings, one entry per line.
> * <p>
> - * This method buffers the input internally, so there is no need to use a
> - * <code>BufferedReader</code>.
> - *
> - * @param input the <code>Reader</code> to read from, not null
> + * This method buffers the input internally, so there is no need to use a <code>BufferedReader</code>.
> + *
> + * @param input
> + * the <code>Reader</code> to read from, not null
> * @return the list of Strings, never null
> - * @throws NullPointerException if the input is null
> - * @throws IOException if an I/O error occurs
> + * @throws NullPointerException
> + * if the input is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> */
> public static List<String> readLines(Reader input) throws IOException {
> @@ -527,17 +554,17 @@
> }
>
> // lineIterator
> - //-----------------------------------------------------------------------
> + // -----------------------------------------------------------------------
> /**
> * Return an Iterator for the lines in a <code>Reader</code>.
> * <p>
> - * <code>LineIterator</code> holds a reference to the open
> - * <code>Reader</code> specified here. When you have finished with the
> - * iterator you should close the reader to free internal resources.
> - * This can be done by closing the reader directly, or by calling
> - * {@link LineIterator#close()} or {@link LineIterator#closeQuietly(LineIterator)}.
> + * <code>LineIterator</code> holds a reference to the open <code>Reader</code> specified here. When you have
> + * finished with the iterator you should close the reader to free internal resources. This can be done by closing
> + * the reader directly, or by calling {@link LineIterator#close()} or
> + * {@link LineIterator#closeQuietly(LineIterator)}.
> * <p>
> * The recommended usage pattern is:
> + *
> * <pre>
> * try {
> * LineIterator it = IOUtils.lineIterator(reader);
> @@ -549,10 +576,12 @@
> * IOUtils.closeQuietly(reader);
> * }
> * </pre>
> - *
> - * @param reader the <code>Reader</code> to read from, not null
> + *
> + * @param reader
> + * the <code>Reader</code> to read from, not null
> * @return an Iterator of the lines in the reader, never null
> - * @throws IllegalArgumentException if the reader is null
> + * @throws IllegalArgumentException
> + * if the reader is null
> * @since Commons IO 1.2
> */
> public static LineIterator lineIterator(Reader reader) {
> @@ -560,16 +589,16 @@
> }
>
> /**
> - * Return an Iterator for the lines in an <code>InputStream</code>, using
> - * the character encoding specified (or default encoding if null).
> + * Return an Iterator for the lines in an <code>InputStream</code>, using the character encoding specified (or
> + * default encoding if null).
> * <p>
> - * <code>LineIterator</code> holds a reference to the open
> - * <code>InputStream</code> specified here. When you have finished with
> - * the iterator you should close the stream to free internal resources.
> - * This can be done by closing the stream directly, or by calling
> - * {@link LineIterator#close()} or {@link LineIterator#closeQuietly(LineIterator)}.
> + * <code>LineIterator</code> holds a reference to the open <code>InputStream</code> specified here. When you
> + * have finished with the iterator you should close the stream to free internal resources. This can be done by
> + * closing the stream directly, or by calling {@link LineIterator#close()} or
> + * {@link LineIterator#closeQuietly(LineIterator)}.
> * <p>
> * The recommended usage pattern is:
> + *
> * <pre>
> * try {
> * LineIterator it = IOUtils.lineIterator(stream, "UTF-8");
> @@ -581,16 +610,19 @@
> * IOUtils.closeQuietly(stream);
> * }
> * </pre>
> - *
> - * @param input the <code>InputStream</code> to read from, not null
> - * @param encoding the encoding to use, null means platform default
> + *
> + * @param input
> + * the <code>InputStream</code> to read from, not null
> + * @param encoding
> + * the encoding to use, null means platform default
> * @return an Iterator of the lines in the reader, never null
> - * @throws IllegalArgumentException if the input is null
> - * @throws IOException if an I/O error occurs, such as if the encoding is invalid
> + * @throws IllegalArgumentException
> + * if the input is null
> + * @throws IOException
> + * if an I/O error occurs, such as if the encoding is invalid
> * @since Commons IO 1.2
> */
> - public static LineIterator lineIterator(InputStream input, String encoding)
> - throws IOException {
> + public static LineIterator lineIterator(InputStream input, String encoding) throws IOException {
> Reader reader = null;
> if (encoding == null) {
> reader = new InputStreamReader(input);
> @@ -600,12 +632,13 @@
> return new LineIterator(reader);
> }
>
> - //-----------------------------------------------------------------------
> + // -----------------------------------------------------------------------
> /**
> - * Convert the specified CharSequence to an input stream, encoded as bytes
> - * using the default character encoding of the platform.
> - *
> - * @param input the CharSequence to convert
> + * Convert the specified CharSequence to an input stream, encoded as bytes using the default character encoding of
> + * the platform.
> + *
> + * @param input
> + * the CharSequence to convert
> * @return an input stream
> * @since IO 2.0
> */
> @@ -614,15 +647,16 @@
> }
>
> /**
> - * Convert the specified CharSequence to an input stream, encoded as bytes
> - * using the specified character encoding.
> + * Convert the specified CharSequence to an input stream, encoded as bytes using the specified character encoding.
> * <p>
> - * Character encoding names can be found at
> - * <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> - *
> - * @param input the CharSequence to convert
> - * @param encoding the encoding to use, null means platform default
> - * @throws IOException if the encoding is invalid
> + * Character encoding names can be found at <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> + *
> + * @param input
> + * the CharSequence to convert
> + * @param encoding
> + * the encoding to use, null means platform default
> + * @throws IOException
> + * if the encoding is invalid
> * @return an input stream
> * @since IO 2.0
> */
> @@ -630,12 +664,13 @@
> return toInputStream(input.toString(), encoding);
> }
>
> - //-----------------------------------------------------------------------
> + // -----------------------------------------------------------------------
> /**
> - * Convert the specified string to an input stream, encoded as bytes
> - * using the default character encoding of the platform.
> - *
> - * @param input the string to convert
> + * Convert the specified string to an input stream, encoded as bytes using the default character encoding of the
> + * platform.
> + *
> + * @param input
> + * the string to convert
> * @return an input stream
> * @since Commons IO 1.1
> */
> @@ -645,15 +680,16 @@
> }
>
> /**
> - * Convert the specified string to an input stream, encoded as bytes
> - * using the specified character encoding.
> + * Convert the specified string to an input stream, encoded as bytes using the specified character encoding.
> * <p>
> - * Character encoding names can be found at
> - * <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> - *
> - * @param input the string to convert
> - * @param encoding the encoding to use, null means platform default
> - * @throws IOException if the encoding is invalid
> + * Character encoding names can be found at <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> + *
> + * @param input
> + * the string to convert
> + * @param encoding
> + * the encoding to use, null means platform default
> + * @throws IOException
> + * if the encoding is invalid
> * @return an input stream
> * @since Commons IO 1.1
> */
> @@ -663,35 +699,40 @@
> }
>
> // write byte[]
> - //-----------------------------------------------------------------------
> + // -----------------------------------------------------------------------
> /**
> * Writes bytes from a <code>byte[]</code> to an <code>OutputStream</code>.
> *
> - * @param data the byte array to write, do not modify during output,
> - * null ignored
> - * @param output the <code>OutputStream</code> to write to
> - * @throws NullPointerException if output is null
> - * @throws IOException if an I/O error occurs
> + * @param data
> + * the byte array to write, do not modify during output, null ignored
> + * @param output
> + * the <code>OutputStream</code> to write to
> + * @throws NullPointerException
> + * if output is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> */
> - public static void write(byte[] data, OutputStream output)
> - throws IOException {
> + public static void write(byte[] data, OutputStream output) throws IOException {
> if (data != null) {
> output.write(data);
> }
> }
>
> /**
> - * Writes bytes from a <code>byte[]</code> to chars on a <code>Writer</code>
> - * using the default character encoding of the platform.
> + * Writes bytes from a <code>byte[]</code> to chars on a <code>Writer</code> using the default character
> + * encoding of the platform.
> * <p>
> * This method uses {@link String#String(byte[])}.
> *
> - * @param data the byte array to write, do not modify during output,
> - * null ignored
> - * @param output the <code>Writer</code> to write to
> - * @throws NullPointerException if output is null
> - * @throws IOException if an I/O error occurs
> + * @param data
> + * the byte array to write, do not modify during output, null ignored
> + * @param output
> + * the <code>Writer</code> to write to
> + * @throws NullPointerException
> + * if output is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> */
> public static void write(byte[] data, Writer output) throws IOException {
> @@ -701,24 +742,26 @@
> }
>
> /**
> - * Writes bytes from a <code>byte[]</code> to chars on a <code>Writer</code>
> - * using the specified character encoding.
> + * Writes bytes from a <code>byte[]</code> to chars on a <code>Writer</code> using the specified character
> + * encoding.
> * <p>
> - * Character encoding names can be found at
> - * <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> + * Character encoding names can be found at <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> * <p>
> * This method uses {@link String#String(byte[], String)}.
> *
> - * @param data the byte array to write, do not modify during output,
> - * null ignored
> - * @param output the <code>Writer</code> to write to
> - * @param encoding the encoding to use, null means platform default
> - * @throws NullPointerException if output is null
> - * @throws IOException if an I/O error occurs
> + * @param data
> + * the byte array to write, do not modify during output, null ignored
> + * @param output
> + * the <code>Writer</code> to write to
> + * @param encoding
> + * the encoding to use, null means platform default
> + * @throws NullPointerException
> + * if output is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> */
> - public static void write(byte[] data, Writer output, String encoding)
> - throws IOException {
> + public static void write(byte[] data, Writer output, String encoding) throws IOException {
> if (data != null) {
> if (encoding == null) {
> write(data, output);
> @@ -729,16 +772,19 @@
> }
>
> // write char[]
> - //-----------------------------------------------------------------------
> + // -----------------------------------------------------------------------
> /**
> - * Writes chars from a <code>char[]</code> to a <code>Writer</code>
> - * using the default character encoding of the platform.
> + * Writes chars from a <code>char[]</code> to a <code>Writer</code> using the default character encoding of the
> + * platform.
> *
> - * @param data the char array to write, do not modify during output,
> - * null ignored
> - * @param output the <code>Writer</code> to write to
> - * @throws NullPointerException if output is null
> - * @throws IOException if an I/O error occurs
> + * @param data
> + * the char array to write, do not modify during output, null ignored
> + * @param output
> + * the <code>Writer</code> to write to
> + * @throws NullPointerException
> + * if output is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> */
> public static void write(char[] data, Writer output) throws IOException {
> @@ -748,46 +794,47 @@
> }
>
> /**
> - * Writes chars from a <code>char[]</code> to bytes on an
> - * <code>OutputStream</code>.
> + * Writes chars from a <code>char[]</code> to bytes on an <code>OutputStream</code>.
> * <p>
> - * This method uses {@link String#String(char[])} and
> - * {@link String#getBytes()}.
> + * This method uses {@link String#String(char[])} and {@link String#getBytes()}.
> *
> - * @param data the char array to write, do not modify during output,
> - * null ignored
> - * @param output the <code>OutputStream</code> to write to
> - * @throws NullPointerException if output is null
> - * @throws IOException if an I/O error occurs
> + * @param data
> + * the char array to write, do not modify during output, null ignored
> + * @param output
> + * the <code>OutputStream</code> to write to
> + * @throws NullPointerException
> + * if output is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> */
> - public static void write(char[] data, OutputStream output)
> - throws IOException {
> + public static void write(char[] data, OutputStream output) throws IOException {
> if (data != null) {
> output.write(new String(data).getBytes());
> }
> }
>
> /**
> - * Writes chars from a <code>char[]</code> to bytes on an
> - * <code>OutputStream</code> using the specified character encoding.
> + * Writes chars from a <code>char[]</code> to bytes on an <code>OutputStream</code> using the specified
> + * character encoding.
> * <p>
> - * Character encoding names can be found at
> - * <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> + * Character encoding names can be found at <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> * <p>
> - * This method uses {@link String#String(char[])} and
> - * {@link String#getBytes(String)}.
> + * This method uses {@link String#String(char[])} and {@link String#getBytes(String)}.
> *
> - * @param data the char array to write, do not modify during output,
> - * null ignored
> - * @param output the <code>OutputStream</code> to write to
> - * @param encoding the encoding to use, null means platform default
> - * @throws NullPointerException if output is null
> - * @throws IOException if an I/O error occurs
> + * @param data
> + * the char array to write, do not modify during output, null ignored
> + * @param output
> + * the <code>OutputStream</code> to write to
> + * @param encoding
> + * the encoding to use, null means platform default
> + * @throws NullPointerException
> + * if output is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> */
> - public static void write(char[] data, OutputStream output, String encoding)
> - throws IOException {
> + public static void write(char[] data, OutputStream output, String encoding) throws IOException {
> if (data != null) {
> if (encoding == null) {
> write(data, output);
> @@ -798,14 +845,18 @@
> }
>
> // write CharSequence
> - //-----------------------------------------------------------------------
> + // -----------------------------------------------------------------------
> /**
> * Writes chars from a <code>CharSequence</code> to a <code>Writer</code>.
> *
> - * @param data the <code>CharSequence</code> to write, null ignored
> - * @param output the <code>Writer</code> to write to
> - * @throws NullPointerException if output is null
> - * @throws IOException if an I/O error occurs
> + * @param data
> + * the <code>CharSequence</code> to write, null ignored
> + * @param output
> + * the <code>Writer</code> to write to
> + * @throws NullPointerException
> + * if output is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 2.0
> */
> public static void write(CharSequence data, Writer output) throws IOException {
> @@ -815,57 +866,66 @@
> }
>
> /**
> - * Writes chars from a <code>CharSequence</code> to bytes on an
> - * <code>OutputStream</code> using the default character encoding of the
> - * platform.
> + * Writes chars from a <code>CharSequence</code> to bytes on an <code>OutputStream</code> using the default
> + * character encoding of the platform.
> * <p>
> * This method uses {@link String#getBytes()}.
> *
> - * @param data the <code>CharSequence</code> to write, null ignored
> - * @param output the <code>OutputStream</code> to write to
> - * @throws NullPointerException if output is null
> - * @throws IOException if an I/O error occurs
> + * @param data
> + * the <code>CharSequence</code> to write, null ignored
> + * @param output
> + * the <code>OutputStream</code> to write to
> + * @throws NullPointerException
> + * if output is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 2.0
> */
> - public static void write(CharSequence data, OutputStream output)
> - throws IOException {
> + public static void write(CharSequence data, OutputStream output) throws IOException {
> if (data != null) {
> write(data.toString(), output);
> }
> }
>
> /**
> - * Writes chars from a <code>CharSequence</code> to bytes on an
> - * <code>OutputStream</code> using the specified character encoding.
> + * Writes chars from a <code>CharSequence</code> to bytes on an <code>OutputStream</code> using the specified
> + * character encoding.
> * <p>
> - * Character encoding names can be found at
> - * <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> + * Character encoding names can be found at <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> * <p>
> * This method uses {@link String#getBytes(String)}.
> *
> - * @param data the <code>CharSequence</code> to write, null ignored
> - * @param output the <code>OutputStream</code> to write to
> - * @param encoding the encoding to use, null means platform default
> - * @throws NullPointerException if output is null
> - * @throws IOException if an I/O error occurs
> + * @param data
> + * the <code>CharSequence</code> to write, null ignored
> + * @param output
> + * the <code>OutputStream</code> to write to
> + * @param encoding
> + * the encoding to use, null means platform default
> + * @throws NullPointerException
> + * if output is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 2.0
> */
> - public static void write(CharSequence data, OutputStream output, String encoding)
> - throws IOException {
> + public static void write(CharSequence data, OutputStream output, String encoding) throws IOException {
> if (data != null) {
> write(data.toString(), output, encoding);
> }
> }
>
> // write String
> - //-----------------------------------------------------------------------
> + // -----------------------------------------------------------------------
> /**
> * Writes chars from a <code>String</code> to a <code>Writer</code>.
> *
> - * @param data the <code>String</code> to write, null ignored
> - * @param output the <code>Writer</code> to write to
> - * @throws NullPointerException if output is null
> - * @throws IOException if an I/O error occurs
> + * @param data
> + * the <code>String</code> to write, null ignored
> + * @param output
> + * the <code>Writer</code> to write to
> + * @throws NullPointerException
> + * if output is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> */
> public static void write(String data, Writer output) throws IOException {
> @@ -875,43 +935,48 @@
> }
>
> /**
> - * Writes chars from a <code>String</code> to bytes on an
> - * <code>OutputStream</code> using the default character encoding of the
> - * platform.
> + * Writes chars from a <code>String</code> to bytes on an <code>OutputStream</code> using the default character
> + * encoding of the platform.
> * <p>
> * This method uses {@link String#getBytes()}.
> *
> - * @param data the <code>String</code> to write, null ignored
> - * @param output the <code>OutputStream</code> to write to
> - * @throws NullPointerException if output is null
> - * @throws IOException if an I/O error occurs
> + * @param data
> + * the <code>String</code> to write, null ignored
> + * @param output
> + * the <code>OutputStream</code> to write to
> + * @throws NullPointerException
> + * if output is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> */
> - public static void write(String data, OutputStream output)
> - throws IOException {
> + public static void write(String data, OutputStream output) throws IOException {
> if (data != null) {
> output.write(data.getBytes());
> }
> }
>
> /**
> - * Writes chars from a <code>String</code> to bytes on an
> - * <code>OutputStream</code> using the specified character encoding.
> + * Writes chars from a <code>String</code> to bytes on an <code>OutputStream</code> using the specified
> + * character encoding.
> * <p>
> - * Character encoding names can be found at
> - * <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> + * Character encoding names can be found at <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> * <p>
> * This method uses {@link String#getBytes(String)}.
> *
> - * @param data the <code>String</code> to write, null ignored
> - * @param output the <code>OutputStream</code> to write to
> - * @param encoding the encoding to use, null means platform default
> - * @throws NullPointerException if output is null
> - * @throws IOException if an I/O error occurs
> + * @param data
> + * the <code>String</code> to write, null ignored
> + * @param output
> + * the <code>OutputStream</code> to write to
> + * @param encoding
> + * the encoding to use, null means platform default
> + * @throws NullPointerException
> + * if output is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> */
> - public static void write(String data, OutputStream output, String encoding)
> - throws IOException {
> + public static void write(String data, OutputStream output, String encoding) throws IOException {
> if (data != null) {
> if (encoding == null) {
> write(data, output);
> @@ -922,64 +987,72 @@
> }
>
> // write StringBuffer
> - //-----------------------------------------------------------------------
> + // -----------------------------------------------------------------------
> /**
> * Writes chars from a <code>StringBuffer</code> to a <code>Writer</code>.
> *
> - * @param data the <code>StringBuffer</code> to write, null ignored
> - * @param output the <code>Writer</code> to write to
> - * @throws NullPointerException if output is null
> - * @throws IOException if an I/O error occurs
> + * @param data
> + * the <code>StringBuffer</code> to write, null ignored
> + * @param output
> + * the <code>Writer</code> to write to
> + * @throws NullPointerException
> + * if output is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> * @deprecated replaced by write(CharSequence, Writer)
> */
> - public static void write(StringBuffer data, Writer output)
> - throws IOException {
> + public static void write(StringBuffer data, Writer output) throws IOException {
> if (data != null) {
> output.write(data.toString());
> }
> }
>
> /**
> - * Writes chars from a <code>StringBuffer</code> to bytes on an
> - * <code>OutputStream</code> using the default character encoding of the
> - * platform.
> + * Writes chars from a <code>StringBuffer</code> to bytes on an <code>OutputStream</code> using the default
> + * character encoding of the platform.
> * <p>
> * This method uses {@link String#getBytes()}.
> *
> - * @param data the <code>StringBuffer</code> to write, null ignored
> - * @param output the <code>OutputStream</code> to write to
> - * @throws NullPointerException if output is null
> - * @throws IOException if an I/O error occurs
> + * @param data
> + * the <code>StringBuffer</code> to write, null ignored
> + * @param output
> + * the <code>OutputStream</code> to write to
> + * @throws NullPointerException
> + * if output is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> * @deprecated replaced by write(CharSequence, OutputStream)
> */
> - public static void write(StringBuffer data, OutputStream output)
> - throws IOException {
> + public static void write(StringBuffer data, OutputStream output) throws IOException {
> if (data != null) {
> output.write(data.toString().getBytes());
> }
> }
>
> /**
> - * Writes chars from a <code>StringBuffer</code> to bytes on an
> - * <code>OutputStream</code> using the specified character encoding.
> + * Writes chars from a <code>StringBuffer</code> to bytes on an <code>OutputStream</code> using the specified
> + * character encoding.
> * <p>
> - * Character encoding names can be found at
> - * <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> + * Character encoding names can be found at <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> * <p>
> * This method uses {@link String#getBytes(String)}.
> *
> - * @param data the <code>StringBuffer</code> to write, null ignored
> - * @param output the <code>OutputStream</code> to write to
> - * @param encoding the encoding to use, null means platform default
> - * @throws NullPointerException if output is null
> - * @throws IOException if an I/O error occurs
> + * @param data
> + * the <code>StringBuffer</code> to write, null ignored
> + * @param output
> + * the <code>OutputStream</code> to write to
> + * @param encoding
> + * the encoding to use, null means platform default
> + * @throws NullPointerException
> + * if output is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> * @deprecated replaced by write(CharSequence, OutputStream, String)
> */
> - public static void write(StringBuffer data, OutputStream output,
> - String encoding) throws IOException {
> + public static void write(StringBuffer data, OutputStream output, String encoding) throws IOException {
> if (data != null) {
> if (encoding == null) {
> write(data, output);
> @@ -990,93 +1063,91 @@
> }
>
> // writeLines
> - //-----------------------------------------------------------------------
> + // -----------------------------------------------------------------------
> /**
> - * Writes the <code>toString()</code> value of each item in a collection to
> - * an <code>OutputStream</code> line by line, using the default character
> - * encoding of the platform and the specified line ending.
> - *
> - * @param lines the lines to write, null entries produce blank lines
> - * @param lineEnding the line separator to use, null is system default
> - * @param output the <code>OutputStream</code> to write to, not null, not closed
> - * @throws NullPointerException if the output is null
> - * @throws IOException if an I/O error occurs
> - * @since Commons IO 1.1
> - */
> - public static void writeLines(Collection lines, String lineEnding,
> - OutputStream output) throws IOException {
> - if (lines == null) {
> - return;
> - }
> - if (lineEnding == null) {
> - lineEnding = LINE_SEPARATOR;
> - }
> - for (Iterator it = lines.iterator(); it.hasNext(); ) {
> - Object line = it.next();
> - if (line != null) {
> - output.write(line.toString().getBytes());
> - }
> - output.write(lineEnding.getBytes());
> - }
> + * Writes the <code>toString()</code> value of each item in a collection to an <code>OutputStream</code> line by
> + * line, using the default character encoding of the platform and the specified line ending.
> + *
> + * @param values
> + * the lines to write, null entries produce blank lines
> + * @param lineEnding
> + * the line separator to use, null is system default
> + * @param output
> + * the <code>OutputStream</code> to write to, not null, not closed
> + * @throws NullPointerException
> + * if the output is null
> + * @throws IOException
> + * if an I/O error occurs
> + * @since Commons IO 1.1
> + */
> + public static void writeLines(Collection<?> values, String lineEnding, OutputStream output) throws IOException {
> + writeLines(values, lineEnding, output, defaultCharsetName());
> }
>
> /**
> - * Writes the <code>toString()</code> value of each item in a collection to
> - * an <code>OutputStream</code> line by line, using the specified character
> - * encoding and the specified line ending.
> + * Writes the <code>toString()</code> value of each item in a collection to an <code>OutputStream</code> line by
> + * line, using the specified character encoding and the specified line ending.
> * <p>
> - * Character encoding names can be found at
> - * <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> - *
> - * @param lines the lines to write, null entries produce blank lines
> - * @param lineEnding the line separator to use, null is system default
> - * @param output the <code>OutputStream</code> to write to, not null, not closed
> - * @param encoding the encoding to use, null means platform default
> - * @throws NullPointerException if the output is null
> - * @throws IOException if an I/O error occurs
> + * Character encoding names can be found at <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> + *
> + * @param values
> + * the lines to write, null entries produce blank lines
> + * @param lineEnding
> + * the line separator to use, null is system default
> + * @param output
> + * the <code>OutputStream</code> to write to, not null, not closed
> + * @param encoding
> + * the encoding to use, null means platform default
> + * @throws NullPointerException
> + * if the output is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> */
> - public static void writeLines(Collection lines, String lineEnding,
> - OutputStream output, String encoding) throws IOException {
> + public static void writeLines(Collection<?> values, String lineEnding, OutputStream output, String encoding)
> + throws IOException {
> if (encoding == null) {
> - writeLines(lines, lineEnding, output);
> - } else {
> - if (lines == null) {
> - return;
> - }
> - if (lineEnding == null) {
> - lineEnding = LINE_SEPARATOR;
> - }
> - for (Iterator it = lines.iterator(); it.hasNext(); ) {
> - Object line = it.next();
> - if (line != null) {
> - output.write(line.toString().getBytes(encoding));
> - }
> - output.write(lineEnding.getBytes(encoding));
> + encoding = defaultCharsetName();
> + }
> + if (values == null) {
> + return;
> + }
> + if (lineEnding == null) {
> + lineEnding = LINE_SEPARATOR;
> + }
> + for (Iterator<?> it = values.iterator(); it.hasNext();) {
> + Object line = it.next();
> + if (line != null) {
> + output.write(line.toString().getBytes(encoding));
> }
> + output.write(lineEnding.getBytes(encoding));
> }
> }
>
> /**
> - * Writes the <code>toString()</code> value of each item in a collection to
> - * a <code>Writer</code> line by line, using the specified line ending.
> - *
> - * @param lines the lines to write, null entries produce blank lines
> - * @param lineEnding the line separator to use, null is system default
> - * @param writer the <code>Writer</code> to write to, not null, not closed
> - * @throws NullPointerException if the input is null
> - * @throws IOException if an I/O error occurs
> + * Writes the <code>toString()</code> value of each item in a collection to a <code>Writer</code> line by line,
> + * using the specified line ending.
> + *
> + * @param values
> + * the lines to write, null entries produce blank lines
> + * @param lineEnding
> + * the line separator to use, null is system default
> + * @param writer
> + * the <code>Writer</code> to write to, not null, not closed
> + * @throws NullPointerException
> + * if the input is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> */
> - public static void writeLines(Collection lines, String lineEnding,
> - Writer writer) throws IOException {
> - if (lines == null) {
> + public static void writeLines(Collection<?> values, String lineEnding, Writer writer) throws IOException {
> + if (values == null) {
> return;
> }
> if (lineEnding == null) {
> lineEnding = LINE_SEPARATOR;
> }
> - for (Iterator it = lines.iterator(); it.hasNext(); ) {
> + for (Iterator<?> it = values.iterator(); it.hasNext();) {
> Object line = it.next();
> if (line != null) {
> writer.write(line.toString());
> @@ -1086,25 +1157,27 @@
> }
>
> // copy from InputStream
> - //-----------------------------------------------------------------------
> + // -----------------------------------------------------------------------
> /**
> - * Copy bytes from an <code>InputStream</code> to an
> - * <code>OutputStream</code>.
> + * Copy bytes from an <code>InputStream</code> to an <code>OutputStream</code>.
> * <p>
> - * This method buffers the input internally, so there is no need to use a
> - * <code>BufferedInputStream</code>.
> + * This method buffers the input internally, so there is no need to use a <code>BufferedInputStream</code>.
> * <p>
> - * Large streams (over 2GB) will return a bytes copied value of
> - * <code>-1</code> after the copy has completed since the correct
> - * number of bytes cannot be returned as an int. For large streams
> - * use the <code>copyLarge(InputStream, OutputStream)</code> method.
> + * Large streams (over 2GB) will return a bytes copied value of <code>-1</code> after the copy has completed since
> + * the correct number of bytes cannot be returned as an int. For large streams use the
> + * <code>copyLarge(InputStream, OutputStream)</code> method.
> *
> - * @param input the <code>InputStream</code> to read from
> - * @param output the <code>OutputStream</code> to write to
> + * @param input
> + * the <code>InputStream</code> to read from
> + * @param output
> + * the <code>OutputStream</code> to write to
> * @return the number of bytes copied
> - * @throws NullPointerException if the input or output is null
> - * @throws IOException if an I/O error occurs
> - * @throws ArithmeticException if the byte count is too large
> + * @throws NullPointerException
> + * if the input or output is null
> + * @throws IOException
> + * if an I/O error occurs
> + * @throws ArithmeticException
> + * if the byte count is too large
> * @since Commons IO 1.1
> */
> public static int copy(InputStream input, OutputStream output) throws IOException {
> @@ -1116,21 +1189,22 @@
> }
>
> /**
> - * Copy bytes from a large (over 2GB) <code>InputStream</code> to an
> - * <code>OutputStream</code>.
> + * Copy bytes from a large (over 2GB) <code>InputStream</code> to an <code>OutputStream</code>.
> * <p>
> - * This method buffers the input internally, so there is no need to use a
> - * <code>BufferedInputStream</code>.
> + * This method buffers the input internally, so there is no need to use a <code>BufferedInputStream</code>.
> *
> - * @param input the <code>InputStream</code> to read from
> - * @param output the <code>OutputStream</code> to write to
> + * @param input
> + * the <code>InputStream</code> to read from
> + * @param output
> + * the <code>OutputStream</code> to write to
> * @return the number of bytes copied
> - * @throws NullPointerException if the input or output is null
> - * @throws IOException if an I/O error occurs
> + * @throws NullPointerException
> + * if the input or output is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.3
> */
> - public static long copyLarge(InputStream input, OutputStream output)
> - throws IOException {
> + public static long copyLarge(InputStream input, OutputStream output) throws IOException {
> byte[] buffer = new byte[DEFAULT_BUFFER_SIZE];
> long count = 0;
> int n = 0;
> @@ -1142,47 +1216,51 @@
> }
>
> /**
> - * Copy bytes from an <code>InputStream</code> to chars on a
> - * <code>Writer</code> using the default character encoding of the platform.
> + * Copy bytes from an <code>InputStream</code> to chars on a <code>Writer</code> using the default character
> + * encoding of the platform.
> * <p>
> - * This method buffers the input internally, so there is no need to use a
> - * <code>BufferedInputStream</code>.
> + * This method buffers the input internally, so there is no need to use a <code>BufferedInputStream</code>.
> * <p>
> * This method uses {@link InputStreamReader}.
> - *
> - * @param input the <code>InputStream</code> to read from
> - * @param output the <code>Writer</code> to write to
> - * @throws NullPointerException if the input or output is null
> - * @throws IOException if an I/O error occurs
> + *
> + * @param input
> + * the <code>InputStream</code> to read from
> + * @param output
> + * the <code>Writer</code> to write to
> + * @throws NullPointerException
> + * if the input or output is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> */
> - public static void copy(InputStream input, Writer output)
> - throws IOException {
> + public static void copy(InputStream input, Writer output) throws IOException {
> InputStreamReader in = new InputStreamReader(input);
> copy(in, output);
> }
>
> /**
> - * Copy bytes from an <code>InputStream</code> to chars on a
> - * <code>Writer</code> using the specified character encoding.
> + * Copy bytes from an <code>InputStream</code> to chars on a <code>Writer</code> using the specified character
> + * encoding.
> * <p>
> - * This method buffers the input internally, so there is no need to use a
> - * <code>BufferedInputStream</code>.
> + * This method buffers the input internally, so there is no need to use a <code>BufferedInputStream</code>.
> * <p>
> - * Character encoding names can be found at
> - * <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> + * Character encoding names can be found at <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> * <p>
> * This method uses {@link InputStreamReader}.
> - *
> - * @param input the <code>InputStream</code> to read from
> - * @param output the <code>Writer</code> to write to
> - * @param encoding the encoding to use, null means platform default
> - * @throws NullPointerException if the input or output is null
> - * @throws IOException if an I/O error occurs
> + *
> + * @param input
> + * the <code>InputStream</code> to read from
> + * @param output
> + * the <code>Writer</code> to write to
> + * @param encoding
> + * the encoding to use, null means platform default
> + * @throws NullPointerException
> + * if the input or output is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> */
> - public static void copy(InputStream input, Writer output, String encoding)
> - throws IOException {
> + public static void copy(InputStream input, Writer output, String encoding) throws IOException {
> if (encoding == null) {
> copy(input, output);
> } else {
> @@ -1192,24 +1270,27 @@
> }
>
> // copy from Reader
> - //-----------------------------------------------------------------------
> + // -----------------------------------------------------------------------
> /**
> * Copy chars from a <code>Reader</code> to a <code>Writer</code>.
> * <p>
> - * This method buffers the input internally, so there is no need to use a
> - * <code>BufferedReader</code>.
> + * This method buffers the input internally, so there is no need to use a <code>BufferedReader</code>.
> * <p>
> - * Large streams (over 2GB) will return a chars copied value of
> - * <code>-1</code> after the copy has completed since the correct
> - * number of chars cannot be returned as an int. For large streams
> - * use the <code>copyLarge(Reader, Writer)</code> method.
> - *
> - * @param input the <code>Reader</code> to read from
> - * @param output the <code>Writer</code> to write to
> + * Large streams (over 2GB) will return a chars copied value of <code>-1</code> after the copy has completed since
> + * the correct number of chars cannot be returned as an int. For large streams use the
> + * <code>copyLarge(Reader, Writer)</code> method.
> + *
> + * @param input
> + * the <code>Reader</code> to read from
> + * @param output
> + * the <code>Writer</code> to write to
> * @return the number of characters copied
> - * @throws NullPointerException if the input or output is null
> - * @throws IOException if an I/O error occurs
> - * @throws ArithmeticException if the character count is too large
> + * @throws NullPointerException
> + * if the input or output is null
> + * @throws IOException
> + * if an I/O error occurs
> + * @throws ArithmeticException
> + * if the character count is too large
> * @since Commons IO 1.1
> */
> public static int copy(Reader input, Writer output) throws IOException {
> @@ -1223,14 +1304,17 @@
> /**
> * Copy chars from a large (over 2GB) <code>Reader</code> to a <code>Writer</code>.
> * <p>
> - * This method buffers the input internally, so there is no need to use a
> - * <code>BufferedReader</code>.
> - *
> - * @param input the <code>Reader</code> to read from
> - * @param output the <code>Writer</code> to write to
> + * This method buffers the input internally, so there is no need to use a <code>BufferedReader</code>.
> + *
> + * @param input
> + * the <code>Reader</code> to read from
> + * @param output
> + * the <code>Writer</code> to write to
> * @return the number of characters copied
> - * @throws NullPointerException if the input or output is null
> - * @throws IOException if an I/O error occurs
> + * @throws NullPointerException
> + * if the input or output is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.3
> */
> public static long copyLarge(Reader input, Writer output) throws IOException {
> @@ -1245,26 +1329,26 @@
> }
>
> /**
> - * Copy chars from a <code>Reader</code> to bytes on an
> - * <code>OutputStream</code> using the default character encoding of the
> - * platform, and calling flush.
> + * Copy chars from a <code>Reader</code> to bytes on an <code>OutputStream</code> using the default character
> + * encoding of the platform, and calling flush.
> * <p>
> - * This method buffers the input internally, so there is no need to use a
> - * <code>BufferedReader</code>.
> + * This method buffers the input internally, so there is no need to use a <code>BufferedReader</code>.
> * <p>
> - * Due to the implementation of OutputStreamWriter, this method performs a
> - * flush.
> + * Due to the implementation of OutputStreamWriter, this method performs a flush.
> * <p>
> * This method uses {@link OutputStreamWriter}.
> - *
> - * @param input the <code>Reader</code> to read from
> - * @param output the <code>OutputStream</code> to write to
> - * @throws NullPointerException if the input or output is null
> - * @throws IOException if an I/O error occurs
> + *
> + * @param input
> + * the <code>Reader</code> to read from
> + * @param output
> + * the <code>OutputStream</code> to write to
> + * @throws NullPointerException
> + * if the input or output is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> */
> - public static void copy(Reader input, OutputStream output)
> - throws IOException {
> + public static void copy(Reader input, OutputStream output) throws IOException {
> OutputStreamWriter out = new OutputStreamWriter(output);
> copy(input, out);
> // XXX Unless anyone is planning on rewriting OutputStreamWriter, we
> @@ -1273,30 +1357,30 @@
> }
>
> /**
> - * Copy chars from a <code>Reader</code> to bytes on an
> - * <code>OutputStream</code> using the specified character encoding, and
> - * calling flush.
> + * Copy chars from a <code>Reader</code> to bytes on an <code>OutputStream</code> using the specified character
> + * encoding, and calling flush.
> * <p>
> - * This method buffers the input internally, so there is no need to use a
> - * <code>BufferedReader</code>.
> + * This method buffers the input internally, so there is no need to use a <code>BufferedReader</code>.
> * <p>
> - * Character encoding names can be found at
> - * <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> + * Character encoding names can be found at <a href="http://www.iana.org/assignments/character-sets">IANA</a>.
> * <p>
> - * Due to the implementation of OutputStreamWriter, this method performs a
> - * flush.
> + * Due to the implementation of OutputStreamWriter, this method performs a flush.
> * <p>
> * This method uses {@link OutputStreamWriter}.
> - *
> - * @param input the <code>Reader</code> to read from
> - * @param output the <code>OutputStream</code> to write to
> - * @param encoding the encoding to use, null means platform default
> - * @throws NullPointerException if the input or output is null
> - * @throws IOException if an I/O error occurs
> + *
> + * @param input
> + * the <code>Reader</code> to read from
> + * @param output
> + * the <code>OutputStream</code> to write to
> + * @param encoding
> + * the encoding to use, null means platform default
> + * @throws NullPointerException
> + * if the input or output is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> */
> - public static void copy(Reader input, OutputStream output, String encoding)
> - throws IOException {
> + public static void copy(Reader input, OutputStream output, String encoding) throws IOException {
> if (encoding == null) {
> copy(input, output);
> } else {
> @@ -1309,23 +1393,24 @@
> }
>
> // content equals
> - //-----------------------------------------------------------------------
> + // -----------------------------------------------------------------------
> /**
> - * Compare the contents of two Streams to determine if they are equal or
> - * not.
> + * Compare the contents of two Streams to determine if they are equal or not.
> * <p>
> - * This method buffers the input internally using
> - * <code>BufferedInputStream</code> if they are not already buffered.
> - *
> - * @param input1 the first stream
> - * @param input2 the second stream
> - * @return true if the content of the streams are equal or they both don't
> - * exist, false otherwise
> - * @throws NullPointerException if either input is null
> - * @throws IOException if an I/O error occurs
> + * This method buffers the input internally using <code>BufferedInputStream</code> if they are not already
> + * buffered.
> + *
> + * @param input1
> + * the first stream
> + * @param input2
> + * the second stream
> + * @return true if the content of the streams are equal or they both don't exist, false otherwise
> + * @throws NullPointerException
> + * if either input is null
> + * @throws IOException
> + * if an I/O error occurs
> */
> - public static boolean contentEquals(InputStream input1, InputStream input2)
> - throws IOException {
> + public static boolean contentEquals(InputStream input1, InputStream input2) throws IOException {
> if (!(input1 instanceof BufferedInputStream)) {
> input1 = new BufferedInputStream(input1);
> }
> @@ -1347,22 +1432,22 @@
> }
>
> /**
> - * Compare the contents of two Readers to determine if they are equal or
> - * not.
> + * Compare the contents of two Readers to determine if they are equal or not.
> * <p>
> - * This method buffers the input internally using
> - * <code>BufferedReader</code> if they are not already buffered.
> - *
> - * @param input1 the first reader
> - * @param input2 the second reader
> - * @return true if the content of the readers are equal or they both don't
> - * exist, false otherwise
> - * @throws NullPointerException if either input is null
> - * @throws IOException if an I/O error occurs
> + * This method buffers the input internally using <code>BufferedReader</code> if they are not already buffered.
> + *
> + * @param input1
> + * the first reader
> + * @param input2
> + * the second reader
> + * @return true if the content of the readers are equal or they both don't exist, false otherwise
> + * @throws NullPointerException
> + * if either input is null
> + * @throws IOException
> + * if an I/O error occurs
> * @since Commons IO 1.1
> */
> - public static boolean contentEquals(Reader input1, Reader input2)
> - throws IOException {
> + public static boolean contentEquals(Reader input1, Reader input2) throws IOException {
> if (!(input1 instanceof BufferedReader)) {
> input1 = new BufferedReader(input1);
> }
> @@ -1381,6 +1466,10 @@
>
> int ch2 = input2.read();
> return (ch2 == -1);
> + }
> +
> + private static String defaultCharsetName() {
> + return Charset.defaultCharset().name();
> }
>
> }
>
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org
Re: svn commit: r620174 - /commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java
Posted by Niall Pemberton <ni...@gmail.com>.
On Sun, Feb 10, 2008 at 9:41 PM, Gary Gregory
<GG...@seagullsoftware.com> wrote:
> Hi All:
>
> In short: Feel free to revert.
OK I've reverted:
http://svn.apache.org/viewvc?view=rev&revision=634470
Niall
> In detail:
>
> Ah, sorry about the formatting, it was not my intention to commit the generics changes /plus/ the different format. It's just a habit from work: we all share the same Eclipse format template for a given project, so I format all the time without thinking about it. If format changes show up in our CVS/SVN emails, then the code that was there before did not follow the Eclipse template.
>
> The great thing is that I never manually format any code anymore. Thanks to Eclipse and all of our code looks the same. What a waste of time this used to be: Spaces, brackets, parentheses, tabs, Cr/Cr-Lf, etc. All of that manual formatting nonsense is gone from my daily practice. At work, we've not even had a discussion about formatting in years.
>
> Unfortunately, formatting is pretty random across all of the code I've seen in [commons] projects, it can change from file to file within the same project and from method to method in the same file. It would be great if we could share an Eclipse template or at least the rules that go in the template as I know not everyone likes Eclipse and some folks feel that their IDE is better, or their Notepad is better.
>
> Gary
>
>
>
> > -----Original Message-----
> > From: Stephen Colebourne [mailto:scolebourne@btopenworld.com]
> > Sent: Sunday, February 10, 2008 9:52 AM
> > To: Jakarta Commons Developers List
> > Subject: Re: svn commit: r620174 -
> > /commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java
> >
> > Niall Pemberton wrote:
> > > Its painful to have to look through 30 pages of a commit message thats
> > > mostly re-formatting to find the real changes - which from what I can
> > > see is four method signature changes and a bit of minor refactoring.
> > > Could you please do reformatting type changes as a separate commit so
> > > it makes it easier to follow along. Also in this case I don't think
> > > most of the reformatting improved anything and things like splitting
> > > @param statements over two lines is actually worse tor read.
> >
> > I think this commit should be reverted, and reapplied with just the
> > relevant changes. The [io] codebase does not need extensive formatting,
> > as it is already in a good style (and these changes make it worse).
> >
> > Stephen
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> > For additional commands, e-mail: dev-help@commons.apache.org
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org
RE: svn commit: r620174 -
/commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java
Posted by Gary Gregory <GG...@seagullsoftware.com>.
Hi All:
In short: Feel free to revert.
In detail:
Ah, sorry about the formatting, it was not my intention to commit the generics changes /plus/ the different format. It's just a habit from work: we all share the same Eclipse format template for a given project, so I format all the time without thinking about it. If format changes show up in our CVS/SVN emails, then the code that was there before did not follow the Eclipse template.
The great thing is that I never manually format any code anymore. Thanks to Eclipse and all of our code looks the same. What a waste of time this used to be: Spaces, brackets, parentheses, tabs, Cr/Cr-Lf, etc. All of that manual formatting nonsense is gone from my daily practice. At work, we've not even had a discussion about formatting in years.
Unfortunately, formatting is pretty random across all of the code I've seen in [commons] projects, it can change from file to file within the same project and from method to method in the same file. It would be great if we could share an Eclipse template or at least the rules that go in the template as I know not everyone likes Eclipse and some folks feel that their IDE is better, or their Notepad is better.
Gary
> -----Original Message-----
> From: Stephen Colebourne [mailto:scolebourne@btopenworld.com]
> Sent: Sunday, February 10, 2008 9:52 AM
> To: Jakarta Commons Developers List
> Subject: Re: svn commit: r620174 -
> /commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java
>
> Niall Pemberton wrote:
> > Its painful to have to look through 30 pages of a commit message thats
> > mostly re-formatting to find the real changes - which from what I can
> > see is four method signature changes and a bit of minor refactoring.
> > Could you please do reformatting type changes as a separate commit so
> > it makes it easier to follow along. Also in this case I don't think
> > most of the reformatting improved anything and things like splitting
> > @param statements over two lines is actually worse tor read.
>
> I think this commit should be reverted, and reapplied with just the
> relevant changes. The [io] codebase does not need extensive formatting,
> as it is already in a good style (and these changes make it worse).
>
> Stephen
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org
Re: svn commit: r620174 - /commons/proper/io/trunk/src/java/org/apache/commons/io/IOUtils.java
Posted by Stephen Colebourne <sc...@btopenworld.com>.
Niall Pemberton wrote:
> Its painful to have to look through 30 pages of a commit message thats
> mostly re-formatting to find the real changes - which from what I can
> see is four method signature changes and a bit of minor refactoring.
> Could you please do reformatting type changes as a separate commit so
> it makes it easier to follow along. Also in this case I don't think
> most of the reformatting improved anything and things like splitting
> @param statements over two lines is actually worse tor read.
I think this commit should be reverted, and reapplied with just the
relevant changes. The [io] codebase does not need extensive formatting,
as it is already in a good style (and these changes make it worse).
Stephen
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org