org.macroing.cit.java.io

Class InputStreams

java.lang.Object

org.macroing.cit.java.io.InputStreams

public final class InputStreams
extends java.lang.Object

A class that consists exclusively of static methods that operates on or returns InputStreams.

Since:

1.0.0

Author:

Jörgen Lundgren

Method Summary

Modifier and Type	Method and Description
static byte[]	readFully(java.io.InputStream inputStream) Returns a byte array with the data read from inputStream.
static java.io.BufferedInputStream	toBufferedInputStream(java.io.InputStream inputStream) Returns a BufferedInputStream with inputStream as the source stream.

Methods inherited from class java.lang.Object

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

Method Detail

toBufferedInputStream

public static java.io.BufferedInputStream toBufferedInputStream(java.io.InputStream inputStream)

Returns a BufferedInputStream with inputStream as the source stream.

If inputStream is an instance of BufferedInputStream, it is cast to it and returned. Otherwise a new BufferedInputStream is created with inputStream as its underlying stream.

If inputStream is null, a NullPointerException will be thrown.

Parameters:

inputStream - the source stream

Returns:

a BufferedInputStream with inputStream as the source stream

Throws:

java.lang.NullPointerException - thrown if, and only if, inputStream is null

readFully

public static byte[] readFully(java.io.InputStream inputStream)
                        throws java.io.IOException

Returns a byte array with the data read from inputStream.

If inputStream is null, a NullPointerException will be thrown.

If an I/O error occurs while reading, an IOException will be thrown.

Parameters:

inputStream - the InputStream to read from

Returns:

a byte array with the data read from inputStream

Throws:

java.io.IOException - thrown if, and only if, an I/O error occurs while reading

java.lang.NullPointerException - thrown if, and only if, inputStream is null