Package com.helger.commons.io

Interface IHasOutputStream

All Known Subinterfaces:

IHasOutputStreamAndWriter, IReadWriteResource, IWrappedWritableResource, IWritableResource

All Known Implementing Classes:

AbstractWrappedWritableResource, ByteArrayOutputStreamProvider, FileSystemResource, GZIPWritableResource

public interface IHasOutputStream

A callback interface to retrieve OutputStream objects.

Author:

Philip Helger

Method Summary

Modifier and Type	Method	Description
default OutputStream	getBufferedOutputStream(EAppend eAppend)	Get the output stream to read from the object.
OutputStream	getOutputStream(EAppend eAppend)	Get the output stream to read from the object.
boolean	isWriteMultiple()	Check if the OutputStream from getOutputStream(EAppend) or getBufferedOutputStream(EAppend) can be acquired more than once or not.

Method Detail

getOutputStream

@Nullable
OutputStream 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!

Parameters:

eAppend - appending mode. May not be null.

Returns:

null if resolving failed.

getBufferedOutputStream

@Nullable
default OutputStream getBufferedOutputStream(@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. Internally invokes getOutputStream(EAppend).

Parameters:

eAppend - appending mode. May not be null.

Returns:

null if resolving failed.

Since:

9.1.8

isWriteMultiple

boolean isWriteMultiple()

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

Returns:

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