StreamHelper (ph-commons 9.3.3 API)

java.lang.Object
- com.helger.commons.io.stream.StreamHelper

```
@Immutable
public final class StreamHelper
extends Object
```
Some very basic IO stream utility stuff. All input stream (=reading) related stuff is quite null aware, where on writing an output stream may never be null.

Author:

Philip Helger

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_BUFSIZE
buffer size for copy operations

static int END_OF_STRING_MARKER

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_BUFSIZE` buffer size for copy operations
`static int`	`END_OF_STRING_MARKER`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static InputStream`	`checkForInvalidFilterInputStream(InputStream aIS)`
`static ESuccess`	`close(AutoCloseable aCloseable)` Close the passed stream by encapsulating the declared `IOException`.
`static ESuccess`	`closeWithoutFlush(AutoCloseable aCloseable)` Close the passed object, without trying to call flush on it.
`static ESuccess`	`copyInputStreamToOutputStream(InputStream aIS, OutputStream aOS)` Pass the content of the given input stream to the given output stream.
`static ESuccess`	`copyInputStreamToOutputStream(InputStream aIS, OutputStream aOS, byte[] aBuffer)` Pass the content of the given input stream to the given output stream.
`static ESuccess`	`copyInputStreamToOutputStream(InputStream aIS, OutputStream aOS, byte[] aBuffer, MutableLong aCopyByteCount)` Pass the content of the given input stream to the given output stream.
`static ESuccess`	`copyInputStreamToOutputStream(InputStream aIS, OutputStream aOS, byte[] aBuffer, MutableLong aCopyByteCount, Long aLimit)` Pass the content of the given input stream to the given output stream.
`static ESuccess`	`copyInputStreamToOutputStream(InputStream aIS, OutputStream aOS, MutableLong aCopyByteCount)` Pass the content of the given input stream to the given output stream.
`static ESuccess`	`copyInputStreamToOutputStreamAndCloseOS(InputStream aIS, OutputStream aOS)` Pass the content of the given input stream to the given output stream.
`static ESuccess`	`copyInputStreamToOutputStreamWithLimit(InputStream aIS, OutputStream aOS, long nLimit)` Pass the content of the given input stream to the given output stream.
`static ESuccess`	`copyInputStreamToOutputStreamWithLimitAndCloseOS(InputStream aIS, OutputStream aOS, long nLimit)` Pass the content of the given input stream to the given output stream.
`static ESuccess`	`copyReaderToWriter(Reader aReader, Writer aWriter)` Pass the content of the given reader to the given writer.
`static ESuccess`	`copyReaderToWriter(Reader aReader, Writer aWriter, char[] aBuffer)` Pass the content of the given reader to the given writer.
`static ESuccess`	`copyReaderToWriter(Reader aReader, Writer aWriter, char[] aBuffer, MutableLong aCopyCharCount)` Pass the content of the given reader to the given writer.
`static ESuccess`	`copyReaderToWriter(Reader aReader, Writer aWriter, char[] aBuffer, MutableLong aCopyCharCount, Long aLimit)` Pass the content of the given reader to the given writer.
`static ESuccess`	`copyReaderToWriter(Reader aReader, Writer aWriter, MutableLong aCopyCharCount)` Pass the content of the given reader to the given writer.
`static ESuccess`	`copyReaderToWriterAndCloseWriter(Reader aReader, Writer aWriter)` Pass the content of the given reader to the given writer.
`static ESuccess`	`copyReaderToWriterWithLimit(Reader aReader, Writer aWriter, long nLimit)` Pass the content of the given reader to the given writer.
`static ESuccess`	`copyReaderToWriterWithLimitAndCloseWriter(Reader aReader, Writer aWriter, long nLimit)` Pass the content of the given reader to the given writer.
`static NonBlockingStringReader`	`createReader(char[] aChars)`
`static InputStreamReader`	`createReader(InputStream aIS, Charset aCharset)`
`static NonBlockingStringReader`	`createReader(String sText)`
`static OutputStreamWriter`	`createWriter(OutputStream aOS, Charset aCharset)`
`static ESuccess`	`flush(Flushable aFlushable)` Flush the passed object encapsulating the declared `IOException`.
`static byte[]`	`getAllBytes(IHasInputStream aISP)` Read all bytes from the passed input stream into a byte array.
`static byte[]`	`getAllBytes(InputStream aIS)` Read all bytes from the passed input stream into a byte array.
`static String`	`getAllBytesAsString(IHasInputStream aISP, Charset aCharset)` Read all bytes from the passed input stream into a string.
`static String`	`getAllBytesAsString(InputStream aIS, Charset aCharset)` Read all bytes from the passed input stream into a string.
`static char[]`	`getAllCharacters(Reader aReader)` Read all characters from the passed reader into a char array.
`static String`	`getAllCharactersAsString(Reader aReader)` Read all characters from the passed reader into a String.
`static int`	`getAvailable(InputStream aIS)` Get the number of available bytes in the passed input stream.
`static InputStream`	`getBuffered(InputStream aIS)`
`static OutputStream`	`getBuffered(OutputStream aOS)`
`static Reader`	`getBuffered(Reader aReader)`
`static Writer`	`getBuffered(Writer aWriter)`
`static NonBlockingByteArrayOutputStream`	`getCopy(InputStream aIS)` Get a byte buffer with all the available content of the passed input stream.
`static NonBlockingStringWriter`	`getCopy(Reader aReader)`
`static NonBlockingByteArrayOutputStream`	`getCopyWithLimit(InputStream aIS, long nLimit)` Get a byte buffer with all the available content of the passed input stream.
`static NonBlockingStringWriter`	`getCopyWithLimit(Reader aReader, long nLimit)`
`static boolean`	`isBuffered(InputStream aIS)`
`static boolean`	`isBuffered(OutputStream aOS)`
`static boolean`	`isBuffered(Reader aReader)`
`static boolean`	`isBuffered(Writer aWriter)`
`static boolean`	`isKnownEOFException(Class<?> aClass)` Check if the passed class is a known EOF exception class.
`static boolean`	`isKnownEOFException(Throwable t)` Check if the passed exception is a known EOF exception.
`static int`	`readFully(InputStream aIS, byte[] aBuffer)` Read the whole buffer from the input stream.
`static int`	`readFully(InputStream aIS, byte[] aBuffer, int nOfs, int nLen)` Read the whole buffer from the input stream.
`static String`	`readSafeUTF(DataInput aDI)` Because `DataOutputStream.writeUTF(String)` has a limit of 64KB this methods provides a similar solution for reading like `DataInputStream.readUTF()` but what was written in `writeSafeUTF(DataOutput, String)`.
`static ICommonsList<String>`	`readStreamLines(IHasInputStream aISP, Charset aCharset)` Get the content of the passed Spring resource as one big string in the passed character set.
`static ICommonsList<String>`	`readStreamLines(IHasInputStream aISP, Charset aCharset, int nLinesToSkip, int nLinesToRead)` Get the content of the passed Spring resource as one big string in the passed character set.
`static ICommonsList<String>`	`readStreamLines(InputStream aIS, Charset aCharset)` Get the content of the passed stream as a list of lines in the passed character set.
`static void`	`readStreamLines(InputStream aIS, Charset aCharset, Consumer<? super String> aLineCallback)` Read the complete content of the passed stream and pass each line separately to the passed callback.
`static ICommonsList<String>`	`readStreamLines(InputStream aIS, Charset aCharset, int nLinesToSkip, int nLinesToRead)` Get the content of the passed stream as a list of lines in the passed character set.
`static void`	`readStreamLines(InputStream aIS, Charset aCharset, int nLinesToSkip, int nLinesToRead, Consumer<? super String> aLineCallback)` Read the content of the passed stream line by line and invoking a callback on all matching lines.
`static void`	`readStreamLines(InputStream aIS, Charset aCharset, List<String> aTargetList)` Get the content of the passed stream as a list of lines in the passed character set.
`static void`	`readUntilEOF(InputStream aIS, byte[] aBuffer, ObjIntConsumer<? super byte[]> aConsumer)`
`static void`	`readUntilEOF(InputStream aIS, ObjIntConsumer<? super byte[]> aConsumer)`
`static void`	`readUntilEOF(Reader aReader, char[] aBuffer, ObjIntConsumer<? super char[]> aConsumer)`
`static void`	`readUntilEOF(Reader aReader, ObjIntConsumer<? super char[]> aConsumer)`
`static void`	`skipFully(InputStream aIS, long nBytesToSkip)` Fully skip the passed amounts in the input stream.
`static void`	`writeSafeUTF(DataOutput aDO, String sStr)` Because `DataOutputStream.writeUTF(String)` has a limit of 64KB this methods provides a similar solution but simply writing the bytes.
`static ESuccess`	`writeStream(OutputStream aOS, byte[] aBuf)` Write bytes to an `OutputStream`.
`static ESuccess`	`writeStream(OutputStream aOS, byte[] aBuf, int nOfs, int nLen)` Write bytes to an `OutputStream`.
`static ESuccess`	`writeStream(OutputStream aOS, String sContent, Charset aCharset)` Write bytes to an `OutputStream`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- DEFAULT_BUFSIZE
```
public static final int DEFAULT_BUFSIZE
```
  buffer size for copy operations
  
  See Also:
  
  Constant Field Values
- END_OF_STRING_MARKER
```
public static final int END_OF_STRING_MARKER
```
  See Also:
  
  Constant Field Values

Method Detail

isKnownEOFException
```
public static boolean isKnownEOFException(@Nullable
                                          Throwable t)
```
Check if the passed exception is a known EOF exception.

Parameters:

t - The throwable/exception to be checked. May be null.

Returns:

true if it is a user-created EOF exception

isKnownEOFException
```
public static boolean isKnownEOFException(@Nullable
                                          Class<?> aClass)
```
Check if the passed class is a known EOF exception class.

Parameters:

aClass - The class to be checked. May be null.

Returns:

true if it is a known EOF exception class.

closeWithoutFlush

@Nonnull
public static ESuccess closeWithoutFlush(@Nullable @WillClose
                                                   AutoCloseable aCloseable)

Close the passed object, without trying to call flush on it.

Parameters:: aCloseable - The object to be closed. May be null.
Returns:: ESuccess.SUCCESS if the object was successfully closed.

close
```
@Nonnull
public static ESuccess close(@Nullable @WillClose
                                       AutoCloseable aCloseable)
```
Close the passed stream by encapsulating the declared IOException. If the passed object also implements the Flushable interface, it is tried to be flushed before it is closed.

Parameters:

aCloseable - The object to be closed. May be null.

Returns:

ESuccess if the object was successfully closed.

flush
```
@Nonnull
public static ESuccess flush(@Nullable
                                       Flushable aFlushable)
```
Flush the passed object encapsulating the declared IOException.

Parameters:

aFlushable - The flushable to be flushed. May be null.

Returns:

ESuccess.SUCCESS if the object was successfully flushed.

copyInputStreamToOutputStreamAndCloseOS

@Nonnull
public static ESuccess copyInputStreamToOutputStreamAndCloseOS(@WillClose @Nullable
                                                                         InputStream aIS,
                                                                         @WillClose @Nullable
                                                                         OutputStream aOS)

Pass the content of the given input stream to the given output stream. Both the input stream and the output stream are automatically closed.

Parameters:: aIS - The input stream to read from. May be null. Automatically closed!; aOS - The output stream to write to. May be null. Automatically closed!
Returns:: ESuccess.SUCCESS if copying took place, ESuccess.FAILURE otherwise

copyInputStreamToOutputStreamWithLimitAndCloseOS

@Nonnull
public static ESuccess copyInputStreamToOutputStreamWithLimitAndCloseOS(@WillClose @Nullable
                                                                                  InputStream aIS,
                                                                                  @WillClose @Nullable
                                                                                  OutputStream aOS,
                                                                                  @Nonnegative
                                                                                  long nLimit)

Pass the content of the given input stream to the given output stream. Both the input stream and the output stream are automatically closed.

Parameters:: aIS - The input stream to read from. May be null. Automatically closed!; aOS - The output stream to write to. May be null. Automatically closed!; nLimit - The maximum number of bytes to be copied to the output stream. Must be ≥ 0.
Returns:: ESuccess.SUCCESS if copying took place, ESuccess.FAILURE otherwise