Package com.helger.commons.io.stream

Class HasInputStream

java.lang.Object

com.helger.commons.io.stream.HasInputStream

All Implemented Interfaces:

IHasInputStream

@Immutable
public class HasInputStream
extends Object
implements IHasInputStream

Special implementation of IHasInputStream with that has an InputStream supplier that can be read more than once!

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
HasInputStream(Supplier<? extends InputStream> aISP, boolean bReadMultiple)	Constructor

Method Summary

Modifier and Type	Method	Description
static IHasInputStream	create(byte[] aBytes)	Get a special implementation of IHasInputStream for byte array.
static IHasInputStream	create(NonBlockingByteArrayOutputStream aBAOS)	Get a special implementation of IHasInputStream for NonBlockingByteArrayOutputStream.
final InputStream	getInputStream()	Get the input stream to read from the object.
final boolean	isReadMultiple()	Check if the InputStream from IHasInputStream.getInputStream() and IHasInputStream.getBufferedInputStream() can be acquired more than once.
static HasInputStream	multiple(Supplier<? extends InputStream> aISP)	Create a new object with a supplier that can read multiple times.
static HasInputStream	once(Supplier<? extends InputStream> aISP)	Create a new object with a supplier that can be read only once.
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.commons.io.IHasInputStream

getBufferedInputStream, withBufferedInputStreamDo, withInputStreamDo

Constructor Details

HasInputStream

public HasInputStream(@Nonnull
 Supplier<? extends InputStream> aISP,
 boolean bReadMultiple)

Constructor

Parameters:

aISP - InputStream supplier. May not be null.

bReadMultiple - true if the supplier can be invoked more than once (e.g. from a byte[]) or false if it can be invoked only once (e.g. from an open socket).

Method Details

isReadMultiple

public final boolean isReadMultiple()

Description copied from interface: IHasInputStream

Check if the InputStream from IHasInputStream.getInputStream() and IHasInputStream.getBufferedInputStream() can be acquired more than once.

Specified by:

isReadMultiple in interface IHasInputStream

Returns:

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

getInputStream

public final InputStream getInputStream()

Description copied from interface: IHasInputStream

Get the input stream to read from the object. Each time this method is called, a new InputStream needs to be created.

Specified by:

getInputStream in interface IHasInputStream

Returns:

null if resolving failed.

toString

public String toString()

Overrides:

toString in class Object

multiple

@Nonnull
@ReturnsMutableCopy
public static HasInputStream multiple(@Nonnull
 Supplier<? extends InputStream> aISP)

Create a new object with a supplier that can read multiple times.

Parameters:

aISP - InputStream provider. May not be null.

Returns:

Never null.

once

@Nonnull
@ReturnsMutableCopy
public static HasInputStream once(@Nonnull
 Supplier<? extends InputStream> aISP)

Create a new object with a supplier that can be read only once.

Parameters:

aISP - InputStream provider. May not be null.

Returns:

Never null.

create

@Nonnull
@ReturnsMutableCopy
public static IHasInputStream create(@Nonnull
 NonBlockingByteArrayOutputStream aBAOS)

Get a special implementation of IHasInputStream for NonBlockingByteArrayOutputStream. This input stream can be read multiple times.

Parameters:

aBAOS - Source stream. May not be null.

Returns:

Never null.

Since:

9.2.1

create

@Nonnull
@ReturnsMutableCopy
public static IHasInputStream create(@Nonnull
 byte[] aBytes)

Get a special implementation of IHasInputStream for byte array. This input stream can be read multiple times.
Note: don't alter the byte array after passing it in. It is not copied for performance reasons.

Parameters:

aBytes - Source byte array. May not be null.

Returns:

Never null.

Since:

11.2.0