commonsio

Class IOUtils

java.lang.Object

commonsio.IOUtils

public class IOUtils
extends Object

see: org.apache.commons.io.IOUtils and org.apache.commons.io.Charsets

Constructor Summary

Constructors

Constructor and Description
IOUtils()

Method Summary

Modifier and Type	Method and Description
static List<String>	readLines(InputStream input) Deprecated. 2.5 use readLines(InputStream, Charset) instead
static List<String>	readLines(InputStream input, Charset encoding) Gets the contents of an InputStream as a list of Strings, one entry per line, using the specified character encoding.
static List<String>	readLines(InputStream input, String encoding) Gets the contents of an InputStream as a list of Strings, one entry per line, using the specified character encoding.
static List<String>	readLines(Reader input) Gets the contents of a Reader as a list of Strings, one entry per line.
static BufferedReader	toBufferedReader(Reader reader) Returns the given reader if it is a BufferedReader, otherwise creates a BufferedReader from the given reader.
static Charset	toCharset(Charset charset) Returns the given Charset or the default Charset if the given Charset is null.
static Charset	toCharset(String charset) Returns a Charset for the named charset.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IOUtils

public IOUtils()

Method Detail

readLines

@Deprecated
public static List<String> readLines(InputStream input)
                                          throws IOException

Deprecated. 2.5 use readLines(InputStream, Charset) instead

Gets the contents of an InputStream as a list of Strings, one entry per line, using the default character encoding of the platform.

This method buffers the input internally, so there is no need to use a BufferedInputStream.

Parameters:

input - the InputStream to read from, not null

Returns:

the list of Strings, never null

Throws:

NullPointerException - if the input is null

IOException - if an I/O error occurs

Since:

1.1

readLines

public static List<String> readLines(InputStream input,
                                     Charset encoding)
                              throws IOException

Gets the contents of an InputStream as a list of Strings, one entry per line, using the specified character encoding.

This method buffers the input internally, so there is no need to use a BufferedInputStream.

Parameters:

input - the InputStream to read from, not null

encoding - the encoding to use, null means platform default

Returns:

the list of Strings, never null

Throws:

NullPointerException - if the input is null

IOException - if an I/O error occurs

Since:

2.3

readLines

public static List<String> readLines(InputStream input,
                                     String encoding)
                              throws IOException

Gets the contents of an InputStream as a list of Strings, one entry per line, using the specified character encoding.

Character encoding names can be found at IANA.

This method buffers the input internally, so there is no need to use a BufferedInputStream.

Parameters:

input - the InputStream to read from, not null

encoding - the encoding to use, null means platform default

Returns:

the list of Strings, never null

Throws:

NullPointerException - if the input is null

IOException - if an I/O error occurs

UnsupportedCharsetException - thrown instead of .UnsupportedEncodingException in version 2.2 if the encoding is not supported.

Since:

1.1

readLines

public static List<String> readLines(Reader input)
                              throws IOException

Gets the contents of a Reader as a list of Strings, one entry per line.

This method buffers the input internally, so there is no need to use a BufferedReader.

Parameters:

input - the Reader to read from, not null

Returns:

the list of Strings, never null

Throws:

NullPointerException - if the input is null

IOException - if an I/O error occurs

Since:

1.1

toBufferedReader

public static BufferedReader toBufferedReader(Reader reader)

Returns the given reader if it is a BufferedReader, otherwise creates a BufferedReader from the given reader.

Parameters:

reader - the reader to wrap or return (not null)

Returns:

the given reader or a new BufferedReader for the given reader

Throws:

NullPointerException - if the input parameter is null

Since:

2.2

toCharset

public static Charset toCharset(Charset charset)

Returns the given Charset or the default Charset if the given Charset is null.

Parameters:

charset - A charset or null.

Returns:

the given Charset or the default Charset if the given Charset is null

toCharset

public static Charset toCharset(String charset)

Returns a Charset for the named charset. If the name is null, return the default Charset.

Parameters:

charset - The name of the requested charset, may be null.

Returns:

a Charset for the named charset

Throws:

UnsupportedCharsetException - If the named charset is unavailable