Package com.helger.base.io.streamprovider

Class ByteArrayOutputStreamProvider

java.lang.Object

com.helger.base.io.streamprovider.ByteArrayOutputStreamProvider

All Implemented Interfaces:

IHasOutputStream, IHasOutputStreamAndWriter

public class ByteArrayOutputStreamProvider
extends Object
implements IHasOutputStreamAndWriter

An OutputStream provider based on a byte array.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
ByteArrayOutputStreamProvider()	Create a new empty instance.

Method Summary

Modifier and Type	Method	Description
final @NonNull String	getAsString(@NonNull Charset aCharset)
final byte @NonNull []	getBytes()
final @NonNull NonBlockingByteArrayOutputStream	getOutputStream(@NonNull EAppend eAppend)	Get the output stream to read from the object.
final boolean	isWriteMultiple()	Check if the OutputStream from IHasOutputStream.getOutputStream(EAppend) or IHasOutputStream.getBufferedOutputStream(EAppend) can be acquired more than once or not.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.base.io.iface.IHasOutputStream

getBufferedOutputStream

Methods inherited from interface com.helger.base.io.iface.IHasOutputStreamAndWriter

getBufferedWriter, getWriter

Constructor Details

ByteArrayOutputStreamProvider

public ByteArrayOutputStreamProvider()

Create a new empty instance.

Method Details

getOutputStream

public final @NonNull NonBlockingByteArrayOutputStream getOutputStream(@NonNull EAppend eAppend)

Get the output stream to read from the object. Each time this method is call, a new OutputStream needs to be created!

Specified by:

getOutputStream in interface IHasOutputStream

Parameters:

eAppend - appending mode. May not be null.

Returns:

null if resolving failed.

isWriteMultiple

public final boolean isWriteMultiple()

Check if the OutputStream from IHasOutputStream.getOutputStream(EAppend) or IHasOutputStream.getBufferedOutputStream(EAppend) can be acquired more than once or not.

Specified by:

isWriteMultiple in interface IHasOutputStream

Returns:

true if the output stream can be acquired more than once, false if not.

getBytes

@ReturnsMutableCopy
public final byte @NonNull [] getBytes()

Returns:

All bytes already written

getAsString

public final @NonNull String getAsString(@NonNull Charset aCharset)

Parameters:

aCharset - The charset to use for converting the bytes to a String. May not be null.

Returns:

All bytes already written as a String. Never null.

toString

public String toString()

Overrides:

toString in class Object