com.ibm.cloud.objectstorage.internal

Class SdkFilterOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

com.ibm.cloud.objectstorage.internal.SdkFilterOutputStream

All Implemented Interfaces:

MetricAware, Releasable, Closeable, Flushable, AutoCloseable

public class SdkFilterOutputStream
extends FilterOutputStream
implements MetricAware, Releasable

Base class for AWS Java SDK specific FilterOutputStream.

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
SdkFilterOutputStream(OutputStream out)

Method Summary

Modifier and Type	Method and Description
boolean	isMetricActivated() Returns true if this object or one of it's inner wrapped objects has metrics gathering activity turned on; false otherwise.
void	release() Releases the allocated resource.

Methods inherited from class java.io.FilterOutputStream

close, flush, write, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

SdkFilterOutputStream

public SdkFilterOutputStream(OutputStream out)

Method Detail

isMetricActivated

public boolean isMetricActivated()

Description copied from interface: MetricAware

Returns true if this object or one of it's inner wrapped objects has metrics gathering activity turned on; false otherwise.

Specified by:

isMetricActivated in interface MetricAware

release

public final void release()

Description copied from interface: Releasable

Releases the allocated resource. This method should not be called except by the caller who allocated the resource at the very top of the call stack. This allows, typically, a Closeable resource to be not unintentionally released owing to the calling of the Closeable.close() methods by implementation deep down in the call stack.

For example, the creation of a ResettableInputStream would entail physically opening a file. If the opened file is meant to be closed only (in a finally block) by the very same code block that created it, then it is necessary that the release method must not be called while the execution is made in other stack frames. In such case, as other stack frames may inadvertently or indirectly call the close method of the stream, the creator of the stream would need to explicitly disable the accidental closing via ResettableInputStream#disableClose(), so that the release method becomes the only way to truly close the opened file.

Specified by:

release in interface Releasable