com.helger.commons.io.resource.inmemory

Class ReadableResourceInputStream

java.lang.Object

com.helger.commons.io.resource.inmemory.AbstractMemoryReadableResource

com.helger.commons.io.resource.inmemory.ReadableResourceInputStream

All Implemented Interfaces:

IHasInputStream, IHasInputStreamAndReader, IMemoryReadableResource, IReadableResource, IResourceBase

public class ReadableResourceInputStream
extends AbstractMemoryReadableResource

An in-memory IReadableResource based on an InputStream.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
ReadableResourceInputStream(InputStream aIS) Deprecated. Use ReadableResourceInputStream(String, InputStream) instead
ReadableResourceInputStream(String sResourceID, InputStream aIS) Constructor to use.

Method Summary

Modifier and Type	Method and Description
InputStream	getInputStream() Get the input stream to read from the object.
boolean	isReadMultiple() Check if the InputStream from IHasInputStream.getInputStream() and IHasInputStream.getBufferedInputStream() can be acquired more than once.
String	toString()

Methods inherited from class com.helger.commons.io.resource.inmemory.AbstractMemoryReadableResource

exists, getAsFile, getAsURL, getPath, getReadableCloneForPath, getResourceID

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.IHasInputStreamAndReader

getBufferedReader, getReader

Methods inherited from interface com.helger.commons.io.IHasInputStream

getBufferedInputStream

Constructor Detail

ReadableResourceInputStream

@Deprecated
public ReadableResourceInputStream(@Nonnull @WillNotClose
                                                InputStream aIS)

Deprecated. Use ReadableResourceInputStream(String, InputStream) instead

Please Don't use this one. Use the constructor with the resource ID.

Parameters:

aIS - InputStream to use. May not be null. This Stream is NOT closed by this class.

ReadableResourceInputStream

public ReadableResourceInputStream(@Nullable
                                   String sResourceID,
                                   @Nonnull @WillNotClose
                                   InputStream aIS)

Constructor to use.

Parameters:

sResourceID - The unique resource ID, used as the caching key.

aIS - The InputStream to read from. May not be null. This Stream is NOT closed by this class.

Method Detail

getInputStream

@Nonnull
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.

Returns:

null if resolving failed.

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.

Returns:

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

toString

public String toString()

Overrides:

toString in class AbstractMemoryReadableResource