Package com.storedobject.common

Class IO

java.lang.Object

com.storedobject.common.IO

public class IO
extends Object

Generic Input/Output routines. All 'get' methods return 'buffered' streams/readers/writers. 'Double buffering' is avoided. Conversion between streams and reader/writer are with UTF-8 encoding.

Author:

Syam

Constructor Summary

Constructors

Constructor	Description
IO()

Method Summary

Modifier and Type	Method	Description
static ByteBuffer	byteBuffer(InputStream in)	Create a read/write byte buffer from the content of the input stream.
static void	close(AutoCloseable... closeables)	Close some Closeable instances without throwing any Exception.
static BufferedInputStream	concat(InputStream in1, InputStream in2)	Create a concatenated stream from the 2 streams.
static BufferedReader	concat(Reader reader1, Reader reader2)	Create a concatenated reader from the 2 readers.
static InputStream	connect(InputStream in, OutputStream out)	Connect an input stream to an output stream so that the output stream is closed when the input stream is closed.
static OutputStream	connect(OutputStream out, InputStream in)	Connect an output stream to an input stream so that the input stream is closed when the output stream is closed.
static void	copy(InputStream input, OutputStream output)	Copy one stream to another.
static void	copy(InputStream input, OutputStream output, boolean close)	Copy one stream to another
static void	copy(InputStream input, OutputStream output, int bufferSize)	Copy one stream to another.
static void	copy(InputStream input, OutputStream output, int bufferSize, boolean close)	Copy one stream to another
static void	copy(Reader reader, Writer writer)	Copy from reader to writer.
static void	copy(Reader reader, Writer writer, boolean close)	Copy from reader to writer.
static BufferedInputStream	get(InputStream in)	Convert a stream to a buffered stream
static BufferedOutputStream	get(OutputStream out)	Convert a stream to a buffered stream
static BufferedReader	get(Reader in)	Convert a reader to a buffered reader
static BufferedWriter	get(Writer out)	Convert a writer to a buffered writer
static DataInputStream	getData(InputStream in)	Convert a stream to a buffered data stream
static DataOutputStream	getData(OutputStream out)	Convert a stream to a buffered data stream
static DataInputStream	getDataInput(File file)	Create a buffered data stream from the file
static DataInputStream	getDataInput(String fileName)	Create a buffered data stream from the file
static DataInputStream	getDataInput(Path path)	Create a buffered data stream from the file
static DataOutputStream	getDataOutput(File file)	Create a buffered data stream to write for the file
static DataOutputStream	getDataOutput(String fileName)	Create a buffered data stream to write for the file
static DataOutputStream	getDataOutput(Path path)	Create a buffered data stream to write for the path
static BufferedInputStream	getInput(File file)	Create a buffered stream from the file
static BufferedInputStream	getInput(String fileName)	Create a buffered stream from the file
static BufferedInputStream	getInput(Path path)	Create a buffered stream from the path
static BufferedOutputStream	getOutput(File file)	Create a buffered stream to write for the file
static BufferedOutputStream	getOutput(String fileName)	Create a buffered stream to write for the file
static BufferedOutputStream	getOutput(Path path)	Create a buffered stream to write for the file
static Path	getPath(String fileName)	Get the path class for the file name passed.
static BufferedReader	getReader(File file)	Create a buffered reader from the file
static BufferedReader	getReader(InputStream in)	Convert a stream to a buffered UTF-8 reader
static BufferedReader	getReader(String fileName)	Create a buffered reader from the file
static BufferedReader	getReader(Path path)	Create a buffered reader from the path
static BufferedWriter	getWriter(File file)	Create a buffered writer to write for the file
static BufferedWriter	getWriter(OutputStream out)	Convert a stream to a buffered UTF-8 writer
static BufferedWriter	getWriter(String fileName)	Create a buffered writer to write for the file
static BufferedWriter	getWriter(Path path)	Create a buffered writer to write for the path
static InputStream	nullInput()	Create a null input stream.
static OutputStream	nullOutput()	Create a null output stream.
static ByteBuffer	readOnlyByteBuffer(InputStream in)	Create a read only byte buffer from the content of the input stream.
static OutputStream	tee(OutputStream first, OutputStream second)	Create a Tee output stream that simultaneously writes content to 2 different output streams.

Methods inherited from class java.lang.Object

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

Constructor Details

IO

public IO()

Method Details

copy

public static void copy(InputStream input,
 OutputStream output)
                 throws IOException

Copy one stream to another. Both the streams will be closed.

Parameters:

input - Source stream

output - Destination stream

Throws:

IOException - I/O exception

copy

public static void copy(InputStream input,
 OutputStream output,
 int bufferSize)
                 throws IOException

Copy one stream to another. Both the streams will be closed.

Parameters:

input - Source stream

output - Destination stream

bufferSize - Buffer size to use

Throws:

IOException - I/O exception

copy

public static void copy(InputStream input,
 OutputStream output,
 boolean close)
                 throws IOException

Copy one stream to another

Parameters:

input - Source stream

output - Destination stream

close - Whether to close the streams or not

Throws:

IOException - I/O exception

copy

public static void copy(InputStream input,
 OutputStream output,
 int bufferSize,
 boolean close)
                 throws IOException

Copy one stream to another

Parameters:

input - Source stream

output - Destination stream

close - Whether to close the streams or not

Throws:

IOException - I/O exception

copy

public static void copy(Reader reader,
 Writer writer)
                 throws IOException

Copy from reader to writer. Both reader and writer will be closed.

Parameters:

reader - Reader

writer - Writer

Throws:

IOException - I/O exception

copy

public static void copy(Reader reader,
 Writer writer,
 boolean close)
                 throws IOException

Copy from reader to writer. Both reader and writer will be closed.

Parameters:

reader - Reader

writer - Writer

close - Whether to close the reader/writer or not

Throws:

IOException - I/O exception

get

public static BufferedInputStream get(InputStream in)

Convert a stream to a buffered stream

Parameters:

in - Stream to convert

Returns:

Buffered stream

get

public static BufferedOutputStream get(OutputStream out)

Convert a stream to a buffered stream

Parameters:

out - Stream to convert

Returns:

Buffered stream

getReader

public static BufferedReader getReader(InputStream in)

Convert a stream to a buffered UTF-8 reader

Parameters:

in - Stream to convert

Returns:

Buffered reader

getWriter

public static BufferedWriter getWriter(OutputStream out)

Convert a stream to a buffered UTF-8 writer

Parameters:

out - Stream to convert

Returns:

Buffered writer

get

public static BufferedReader get(Reader in)

Convert a reader to a buffered reader

Parameters:

in - Reader to convert

Returns:

Buffered reader

get

public static BufferedWriter get(Writer out)

Convert a writer to a buffered writer

Parameters:

out - Writer to convert

Returns:

Buffered writer

getData

public static DataInputStream getData(InputStream in)

Convert a stream to a buffered data stream

Parameters:

in - Stream to convert

Returns:

Buffered data stream

getData

public static DataOutputStream getData(OutputStream out)

Convert a stream to a buffered data stream

Parameters:

out - Stream to convert

Returns:

Buffered data stream

getInput

public static BufferedInputStream getInput(String fileName)
                                    throws IOException

Create a buffered stream from the file

Parameters:

fileName - Name of the file

Returns:

Buffered stream

Throws:

IOException - if I/O error occurs.

getPath

public static Path getPath(String fileName)

Get the path class for the file name passed.

Parameters:

fileName - Name of the file (with directory separators if any)

Returns:

Path

getInput

public static BufferedInputStream getInput(File file)
                                    throws IOException

Create a buffered stream from the file

Parameters:

file - File

Returns:

Buffered stream

Throws:

IOException - if I/O error occurs.

getInput

public static BufferedInputStream getInput(Path path)
                                    throws IOException

Create a buffered stream from the path

Parameters:

path - Path

Returns:

Buffered stream

Throws:

IOException - if I/O error occurs.

getOutput

public static BufferedOutputStream getOutput(String fileName)
                                      throws IOException

Create a buffered stream to write for the file

Parameters:

fileName - Name of the file

Returns:

Buffered stream

Throws:

IOException - if I/O error occurs.

getOutput

public static BufferedOutputStream getOutput(File file)
                                      throws IOException

Create a buffered stream to write for the file

Parameters:

file - File

Returns:

Buffered stream

Throws:

IOException - if I/O error occurs.

getOutput

public static BufferedOutputStream getOutput(Path path)
                                      throws IOException

Create a buffered stream to write for the file

Parameters:

path - Path

Returns:

Buffered stream

Throws:

IOException - if I/O error occurs.

getDataInput

public static DataInputStream getDataInput(String fileName)
                                    throws IOException

Create a buffered data stream from the file

Parameters:

fileName - Name of the file

Returns:

Buffered stream

Throws:

IOException - if I/O error occurs.

getDataInput

public static DataInputStream getDataInput(File file)
                                    throws IOException

Create a buffered data stream from the file

Parameters:

file - File

Returns:

Buffered stream

Throws:

IOException - if I/O error occurs.

getDataInput

public static DataInputStream getDataInput(Path path)
                                    throws IOException

Create a buffered data stream from the file

Parameters:

path - Path

Returns:

Buffered stream

Throws:

IOException - if I/O error occurs.

getDataOutput

public static DataOutputStream getDataOutput(String fileName)
                                      throws IOException

Create a buffered data stream to write for the file

Parameters:

fileName - Name of the file

Returns:

Buffered stream

Throws:

IOException - if I/O error occurs.

getDataOutput

public static DataOutputStream getDataOutput(File file)
                                      throws IOException

Create a buffered data stream to write for the file

Parameters:

file - File

Returns:

Buffered stream

Throws:

IOException - if I/O error occurs.

getDataOutput

public static DataOutputStream getDataOutput(Path path)
                                      throws IOException

Create a buffered data stream to write for the path

Parameters:

path - Path

Returns:

Buffered stream

Throws:

IOException - if I/O error occurs.

getReader

public static BufferedReader getReader(String fileName)
                                throws IOException

Create a buffered reader from the file

Parameters:

fileName - Name of the file

Returns:

Buffered reader

Throws:

IOException - if I/O error occurs.

getReader

public static BufferedReader getReader(File file)
                                throws IOException

Create a buffered reader from the file

Parameters:

file - File

Returns:

Buffered reader

Throws:

IOException - if I/O error occurs.

getReader

public static BufferedReader getReader(Path path)
                                throws IOException

Create a buffered reader from the path

Parameters:

path - Path

Returns:

Buffered reader

Throws:

IOException - if I/O error occurs.

getWriter

public static BufferedWriter getWriter(String fileName)
                                throws IOException

Create a buffered writer to write for the file

Parameters:

fileName - Name of the file

Returns:

Buffered writer

Throws:

IOException - if I/O error occurs.

getWriter

public static BufferedWriter getWriter(File file)
                                throws IOException

Create a buffered writer to write for the file

Parameters:

file - File

Returns:

Buffered writer

Throws:

IOException - if I/O error occurs.

getWriter

public static BufferedWriter getWriter(Path path)
                                throws IOException

Create a buffered writer to write for the path

Parameters:

path - Path

Returns:

Buffered writer

Throws:

IOException - if I/O error occurs.

nullInput

public static InputStream nullInput()

Create a null input stream. A read from this stream always returns EOF (-1).

Returns:

Null input stream

nullOutput

public static OutputStream nullOutput()

Create a null output stream. Anything written to this stream just disappears.

Returns:

Null output stream

concat

public static BufferedInputStream concat(InputStream in1,
 InputStream in2)

Create a concatenated stream from the 2 streams. Data read from the resulting stream will be from the first stream and then, from the second stream when EOF is reached. One of the streams may be null.

Parameters:

in1 - First stream.

in2 - Second stream.

Returns:

Concatenated stream.

concat

public static BufferedReader concat(Reader reader1,
 Reader reader2)

Create a concatenated reader from the 2 readers. Data read from the resulting reader will be from the first one and then, from the second one when EOF is reached. One of the readers may be null.

Parameters:

reader1 - First reader.

reader2 - Second reader.

Returns:

Concatenated reader.

connect

public static OutputStream connect(OutputStream out,
 InputStream in)

Connect an output stream to an input stream so that the input stream is closed when the output stream is closed.

Parameters:

out - Output stream

in - Input stream to connect to

Returns:

Modified output stream

connect

public static InputStream connect(InputStream in,
 OutputStream out)

Connect an input stream to an output stream so that the output stream is closed when the input stream is closed.

Parameters:

in - Input stream

out - Output stream to connect to

Returns:

Modified input stream

tee

public static OutputStream tee(OutputStream first,
 OutputStream second)

Create a Tee output stream that simultaneously writes content to 2 different output streams.

Parameters:

first - First output stream

second - Second output stream

Returns:

An output stream that will write to 2 simultaneous streams.

readOnlyByteBuffer

public static ByteBuffer readOnlyByteBuffer(InputStream in)
                                     throws IOException

Create a read only byte buffer from the content of the input stream.

Parameters:

in - Input stream

Returns:

A read only byte buffer containing the content of the input stream.

Throws:

IOException - if IO can not be happen.

byteBuffer

public static ByteBuffer byteBuffer(InputStream in)
                             throws IOException

Create a read/write byte buffer from the content of the input stream.

Parameters:

in - Input stream

Returns:

A read/write byte buffer containing the content of the input stream.

Throws:

IOException - if buffer can not be created.

close

public static void close(AutoCloseable... closeables)

Close some Closeable instances without throwing any Exception.

Parameters:

closeables - Closable instances to close.