com.qcloud.cos.event

类 ProgressInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.qcloud.cos.internal.SdkFilterInputStream

com.qcloud.cos.event.ProgressInputStream

所有已实现的接口:

Releasable, Closeable, AutoCloseable

public class ProgressInputStream
extends SdkFilterInputStream

字段概要

从类继承的字段 java.io.FilterInputStream

in

构造器概要

构造器

构造器和说明
ProgressInputStream(InputStream is, ProgressListener listener)
ProgressInputStream(InputStream is, ProgressListener listener, int notifyThresHold)

方法概要

限定符和类型	方法和说明
void	close()
ProgressListener	getListener()
protected long	getNotifiedByteCount()
protected int	getUnnotifiedByteCount()
InputStream	getWrappedInputStream()
static InputStream	inputStreamForRequest(InputStream is, ProgressListener progressListener)
static InputStream	inputStreamForResponse(InputStream is, CosServiceRequest req) Returns an input stream for response progress tracking purposes.
static InputStream	inputStreamForResponse(InputStream is, ProgressListener progressListener) Returns an input stream for response progress tracking purposes.
protected void	onClose() Defaults to behave the same as onEOF().
protected void	onEOF() An end-of-file event is to be notified.
protected void	onFirstRead() The read method is called for the very first time.
protected void	onNotifyBytesRead() Upon notification of the number of bytes transferred since last notification.
protected void	onReset() A reset event is to be notified.
int	read()
int	read(byte[] b, int off, int len)
void	reset()

从类继承的方法 com.qcloud.cos.internal.SdkFilterInputStream

abort, abortIfNeeded, available, isAborted, mark, markSupported, release, skip

从类继承的方法 java.io.FilterInputStream

read

从类继承的方法 java.lang.Object

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

构造器详细资料

ProgressInputStream

public ProgressInputStream(InputStream is,
                           ProgressListener listener)

ProgressInputStream

public ProgressInputStream(InputStream is,
                           ProgressListener listener,
                           int notifyThresHold)

方法详细资料

inputStreamForRequest

public static InputStream inputStreamForRequest(InputStream is,
                                                ProgressListener progressListener)

参数:

is - the request content input stream

progressListener - Optional progress listener

返回:

If the progress listener is non null returns a new input stream decorated with progress reporting functionality. If progress listener is null it returns the same input stream.

inputStreamForResponse

public static InputStream inputStreamForResponse(InputStream is,
                                                 CosServiceRequest req)

Returns an input stream for response progress tracking purposes. If request/response progress tracking is not enabled, this method simply return the given input stream as is.

参数:

is - the response content input stream

inputStreamForResponse

public static InputStream inputStreamForResponse(InputStream is,
                                                 ProgressListener progressListener)

Returns an input stream for response progress tracking purposes. If request/response progress tracking is not enabled, this method simply return the given input stream as is.

参数:

is - the response content input stream

progressListener - Optional progress listener

返回:

If the progress listener is non null returns a new input stream decorated with progress reporting functionality. If progress listener is null it returns the same input stream.

onFirstRead

protected void onFirstRead()

The read method is called for the very first time. Defaults to do nothing.

onEOF

protected void onEOF()

An end-of-file event is to be notified. Defaults to do nothing.

onClose

protected void onClose()

Defaults to behave the same as onEOF().

onReset

protected void onReset()

A reset event is to be notified. Default to do nothing.

onNotifyBytesRead

protected void onNotifyBytesRead()

Upon notification of the number of bytes transferred since last notification. Default to do nothing.

read

public int read()
         throws IOException

覆盖:

read 在类中 SdkFilterInputStream

抛出:

IOException

reset

public void reset()
           throws IOException

覆盖:

reset 在类中 SdkFilterInputStream

抛出:

IOException

read

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

覆盖:

read 在类中 SdkFilterInputStream

抛出:

IOException

getWrappedInputStream

public final InputStream getWrappedInputStream()

getUnnotifiedByteCount

protected final int getUnnotifiedByteCount()

getNotifiedByteCount

protected final long getNotifiedByteCount()

close

public void close()
           throws IOException

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

覆盖:

close 在类中 SdkFilterInputStream

抛出:

IOException

getListener

public final ProgressListener getListener()