com.ibm.cloud.objectstorage.internal

Class ReleasableInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.ibm.cloud.objectstorage.internal.SdkFilterInputStream

com.ibm.cloud.objectstorage.internal.ReleasableInputStream

All Implemented Interfaces:

MetricAware, Releasable, Closeable, AutoCloseable

Direct Known Subclasses:

ResettableInputStream

@NotThreadSafe
public class ReleasableInputStream
extends SdkFilterInputStream
implements Releasable

An input stream that can have the close operation disabled (to avoid accidentally being closed). This is necessary, for example, when an input stream needs to be marked-and-reset multiple times but only as long as the input stream has not been closed. To survive not being accidentally closed, the close method can be disabled via ReleasableInputStream.disableClose().

The creator of this input stream should therefore always call ReleasableInputStream.release() in a finally block to truly release the underlying resources.

See Also:

Releasable, ResettableInputStream

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ReleasableInputStream(InputStream is) This constructor is not meant to be used directly.

Method Summary

Modifier and Type	Method and Description
void	close() If ReleasableInputStream.closeDisabled is false, closes this input stream and releases any system resources associated with the stream.
<T extends ReleasableInputStream> T	disableClose() Used to disable the close method.
boolean	isCloseDisabled() Returns true if the close method has been disabled; false otherwise.
void	release() Closes the underlying stream file and releases any system resources associated.
static ReleasableInputStream	wrap(InputStream is) Wraps the given input stream into a ReleasableInputStream if necessary.

Methods inherited from class com.ibm.cloud.objectstorage.internal.SdkFilterInputStream

abort, abortIfNeeded, available, getDelegateStream, isAborted, isMetricActivated, mark, markSupported, read, read, reset, skip

Methods inherited from class java.io.FilterInputStream

read

Methods inherited from class java.lang.Object

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

Constructor Detail

ReleasableInputStream

protected ReleasableInputStream(InputStream is)

This constructor is not meant to be used directly. Use ReleasableInputStream.wrap(InputStream) instead.

Method Detail

close

public final void close()

If ReleasableInputStream.closeDisabled is false, closes this input stream and releases any system resources associated with the stream. Otherwise, this method does nothing.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class SdkFilterInputStream

release

public final void release()

Closes the underlying stream file and releases any system resources associated.

Specified by:

release in interface Releasable

Overrides:

release in class SdkFilterInputStream

isCloseDisabled

public final boolean isCloseDisabled()

Returns true if the close method has been disabled; false otherwise. Once the close method is disabled, caller would be responsible to release resources via ReleasableInputStream.release().

disableClose

public final <T extends ReleasableInputStream> T disableClose()

Used to disable the close method. Once the close method is disabled, caller would be responsible to release resources via ReleasableInputStream.release().

wrap

public static ReleasableInputStream wrap(InputStream is)

Wraps the given input stream into a ReleasableInputStream if necessary. Note if the given input stream is a FileInputStream, a ResettableInputStream which is a specific subclass of ReleasableInputStream will be returned.