com.ibm.cloud.objectstorage.internal

Class SdkBufferedInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

java.io.BufferedInputStream

com.ibm.cloud.objectstorage.internal.SdkBufferedInputStream

All Implemented Interfaces:

MetricAware, Closeable, AutoCloseable

public class SdkBufferedInputStream
extends BufferedInputStream
implements MetricAware

A buffered input stream that is both SDK metric aware, and can be aborted via thread interrupt.

Field Summary

Fields inherited from class java.io.BufferedInputStream

buf, count, marklimit, markpos, pos

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
SdkBufferedInputStream(InputStream in)
SdkBufferedInputStream(InputStream in, int size)

Method Summary

Modifier and Type	Method and Description
protected void	abort() Can be used to provide abortion logic prior to throwing the AbortedException.
protected void	abortIfNeeded() Aborts with subclass specific abortion logic executed if needed.
int	available()
void	close()
boolean	isMetricActivated() Returns true if this object or one of it's inner wrapped objects has metrics gathering activity turned on; false otherwise.
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)

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

SdkBufferedInputStream

public SdkBufferedInputStream(InputStream in)

SdkBufferedInputStream

public SdkBufferedInputStream(InputStream in,
                              int size)

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

abortIfNeeded

protected final void abortIfNeeded()

Aborts with subclass specific abortion logic executed if needed. Note the interrupted status of the thread is cleared by this method.

Throws:

AbortedException - if found necessary.

abort

protected void abort()

Can be used to provide abortion logic prior to throwing the AbortedException. No-op by default.

read

public int read()
         throws IOException

Overrides:

read in class BufferedInputStream

Throws:

IOException

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

Overrides:

read in class BufferedInputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class BufferedInputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class BufferedInputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class BufferedInputStream

Throws:

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class BufferedInputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class BufferedInputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class BufferedInputStream