de.alpharogroup.io

Class StreamExtensions

java.lang.Object

de.alpharogroup.io.StreamExtensions

All Implemented Interfaces:

Serializable

public final class StreamExtensions
extends Object
implements Serializable

Utility class for input/output operations.

Version:

1.0

Author:

Asterios Raptis

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static void	close(InputStream in) Closes the given InputStream.
static void	close(OutputStream out) Closes the given OutputStream.
static void	close(Reader reader) Closes the given Reader.
static void	close(Writer writer) Closes the given Writer.
static boolean	closeInputStream(InputStream in) Closes the given InputStream.
static boolean	closeOutputStream(OutputStream out) Closes the given OutputStream.
static boolean	closeReader(Reader reader) Closes the given Reader.
static boolean	closeWriter(Writer writer) Closes the given Writer.
static byte[]	getByteArray(InputStream in) Returns the given InputStream as a byte array.
static byte[]	getByteArray(InputStream in, ByteArrayOutputStream os) Gets the byte array.
static InputStream	getInputStream(File file) Gets the input stream from a File object.
static InputStream	getInputStream(File file, boolean createFile) Gets the input stream from a File object.
static OutputStream	getOutputStream(File file) Gets the output stream from a File object.
static OutputStream	getOutputStream(File file, boolean createFile) Gets the output stream from a File object.
static Reader	getReader(File inputFile) Gets a Reader from the given file object.
static Reader	getReader(File inputFile, String encoding, boolean createFile) Gets a Reader from the given file object.
static long	getSerialVersionUID(Class<? extends Serializable> clazz) Gets the SerialVersionUID from the given Class.
static Writer	getWriter(File file) Gets a Writer from the given file object.
static Writer	getWriter(File file, String encoding, boolean createFile) Gets a Writer from the given file object.
static void	writeInputStreamToOutputStream(InputStream inputStream, OutputStream outputStream, boolean closeStream) The Method writeInputStreamToOutputStream(InputStream, OutputStream, boolean) writes to the given OutputStream from an opened InputStream.

Methods inherited from class java.lang.Object

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

Method Detail

close

public static void close(InputStream in)
                  throws IOException

Closes the given InputStream.

Parameters:

in - The InputStream to close.

Throws:

IOException - Signals that an I/O exception has occurred.

close

public static void close(OutputStream out)
                  throws IOException

Closes the given OutputStream.

Parameters:

out - The OutputStream to close.

Throws:

IOException - Signals that an I/O exception has occurred.

close

public static void close(Reader reader)
                  throws IOException

Closes the given Reader.

Parameters:

reader - The Reader to close.

Throws:

IOException - Signals that an I/O exception has occurred.

close

public static void close(Writer writer)
                  throws IOException

Closes the given Writer.

Parameters:

writer - The Writer to close.

Throws:

IOException - Signals that an I/O exception has occurred.

closeInputStream

public static boolean closeInputStream(InputStream in)

Closes the given InputStream.

Parameters:

in - The InputStream to close.

Returns:

Returns true if the OutputStream is closed otherwise false.

closeOutputStream

public static boolean closeOutputStream(OutputStream out)

Closes the given OutputStream.

Parameters:

out - The OutputStream to close.

Returns:

Returns true if the OutputStream is closed otherwise false.

closeReader

public static boolean closeReader(Reader reader)

Closes the given Reader.

Parameters:

reader - The Reader to close.

Returns:

Returns true if the Reader is closed otherwise false.

closeWriter

public static boolean closeWriter(Writer writer)

Closes the given Writer.

Parameters:

writer - The Writer to close.

Returns:

Returns true if the Writer is closed otherwise false.

getByteArray

public static byte[] getByteArray(InputStream in)
                           throws IOException

Returns the given InputStream as a byte array.

Parameters:

in - The InputStream.

Returns:

Returns the given InputStream as a byte array.

Throws:

IOException - Signals that an I/O exception has occurred.

getByteArray

public static byte[] getByteArray(InputStream in,
                                  ByteArrayOutputStream os)
                           throws IOException

Gets the byte array.

Parameters:

in - The InputStream.

os - The ByteArrayOutputStream.

Returns:

the byte array

Throws:

IOException - Signals that an I/O exception has occurred.

getInputStream

public static InputStream getInputStream(File file)
                                  throws IOException

Gets the input stream from a File object.

Parameters:

file - the file.

Returns:

the input stream.

Throws:

IOException - Signals that an I/O exception has occurred.

getInputStream

public static InputStream getInputStream(File file,
                                         boolean createFile)
                                  throws IOException

Gets the input stream from a File object.

Parameters:

file - the file

createFile - If true and the file does not exist it will be create a new file.

Returns:

the input stream

Throws:

IOException - Signals that an I/O exception has occurred.

getOutputStream

public static OutputStream getOutputStream(File file)
                                    throws IOException

Gets the output stream from a File object.

Parameters:

file - the file.

Returns:

the output stream.

Throws:

IOException - Signals that an I/O exception has occurred.

getOutputStream

public static OutputStream getOutputStream(File file,
                                           boolean createFile)
                                    throws IOException

Gets the output stream from a File object.

Parameters:

file - the file

createFile - If true and the file does not exist it will be create a new file.

Returns:

the output stream

Throws:

IOException - Signals that an I/O exception has occurred.

getReader

public static Reader getReader(File inputFile)
                        throws IOException

Gets a Reader from the given file object.

Parameters:

inputFile - the input file.

Returns:

the reader.

Throws:

IOException - Signals that an I/O exception has occurred.

getReader

public static Reader getReader(File inputFile,
                               String encoding,
                               boolean createFile)
                        throws IOException

Gets a Reader from the given file object.

Parameters:

inputFile - the input file

encoding - The encoding from the file.

createFile - If true and the file does not exist it will be create a new file.

Returns:

the reader

Throws:

IOException - Signals that an I/O exception has occurred.

getSerialVersionUID

public static long getSerialVersionUID(Class<? extends Serializable> clazz)

Gets the SerialVersionUID from the given Class.

Parameters:

clazz - The class

Returns:

the serial version uid

getWriter

public static Writer getWriter(File file)
                        throws IOException

Gets a Writer from the given file object.

Parameters:

file - the file.

Returns:

the Writer.

Throws:

IOException - Signals that an I/O exception has occurred.

getWriter

public static Writer getWriter(File file,
                               String encoding,
                               boolean createFile)
                        throws IOException

Gets a Writer from the given file object.

Parameters:

file - the file

encoding - The encoding from the file.

createFile - the create file

Returns:

the Writer.

Throws:

IOException - Signals that an I/O exception has occurred.

writeInputStreamToOutputStream

public static void writeInputStreamToOutputStream(InputStream inputStream,
                                                  OutputStream outputStream,
                                                  boolean closeStream)
                                           throws IOException

The Method writeInputStreamToOutputStream(InputStream, OutputStream, boolean) writes to the given OutputStream from an opened InputStream.

Parameters:

inputStream - The opened InputStream.

outputStream - The opened OutputStream.

closeStream - If true then close the outputStream otherwise keep open.

Throws:

IOException - Signals that an I/O exception has occurred.