com.screenscraper.util.internal.services.util

Class StreamUtils

java.lang.Object

com.screenscraper.util.internal.services.util.StreamUtils

public final class StreamUtils
extends java.lang.Object

Utility class containing methods for working with streams

Version:

1.0

Method Summary

Modifier and Type	Method and Description
static java.io.InputStream	convertBytesToStream(byte[] data) Converts the byte array to an input stream.
static java.io.InputStream	convertBytesToStream(byte[] data, java.util.concurrent.ThreadPoolExecutor pool) Converts the byte array to an input stream.
static byte[]	read(java.io.InputStream inputStream, int length) Reads exactly length bytes from the stream.
static byte[]	readFully(java.io.InputStream stream) Reads the stream to the end and returns the bytes read.

Methods inherited from class java.lang.Object

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

Method Detail

convertBytesToStream

@Nullable
public static java.io.InputStream convertBytesToStream(@NotNull
                                                                  byte[] data)

Converts the byte array to an input stream.

Parameters:

data - The data to convert to a stream

Returns:

The input stream of data from the array

convertBytesToStream

@Nullable
public static java.io.InputStream convertBytesToStream(@NotNull
                                                                  byte[] data,
                                                                  @Nullable
                                                                  java.util.concurrent.ThreadPoolExecutor pool)

Converts the byte array to an input stream. Uses a background thread so this method will return immediately, but data will be available as if is written to the stream by the background thread.

Parameters:

data - The data to convert to a stream

pool - The thread pool to use for the background thread

Returns:

The input stream of data from the array

read

@NotNull
public static byte[] read(@NotNull
                                    java.io.InputStream inputStream,
                                    int length)
                             throws java.io.IOException

Reads exactly length bytes from the stream. If the stream ends before the given number of bytes are read, the returned value will be everything left in the stream

Parameters:

inputStream - The stream to read from

length - The number of bytes to read

Returns:

The bytes read

Throws:

java.io.IOException - If an error occurs while reading the stream

readFully

public static byte[] readFully(@NotNull
                               java.io.InputStream stream)
                        throws java.io.IOException

Reads the stream to the end and returns the bytes read. This method will read (and block) until the stream is closed. This method will always close the stream when it is done, even if an error occurs while reading from the stream.

Parameters:

stream - The stream to read

Returns:

The bytes read from the stream

Throws:

java.io.IOException - On error reading from the stream.