com.iijgio.dag.event

Class ProgressReportingInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.iijgio.dag.event.ProgressReportingInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class ProgressReportingInputStream
extends FilterInputStream

折にふれて転送されたバイト数を進捗状況リスナーに通知するシンプルなInputStreamのラッパーです。

このクラスはIIJ GIOストレージ＆アナリシスサービスのクライアントで使用されてきました。 このクラスの登場によりProgressReportingInputStreamは 廃止予定となりました。

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
ProgressReportingInputStream(InputStream in, ProgressListenerCallbackExecutor listenerCallbackExecutor) 新しい進捗状況報告用の入力ストリームを生成します。 それは指定された入力ストリームを単純にラップし、 転送したバイト数を非同期にリスナーに通知するために 指定したリスナーのコールバック実行を使用します。

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	getFireCompletedEvent() この入力ストリームのデータが尽きた時に この入力ストリームがProgressEvent.COMPLETED_EVENT_CODEコードを持つ イベントを点火するかどうかを取得します。 デフォルトでは、このストリームによって完了イベントは点火されません。
int	read()
int	read(byte[] b, int off, int len)
void	reset()
void	setFireCompletedEvent(boolean fireCompletedEvent) このInputStreamのデータが尽きた時に このInputStreamがProgressEvent.COMPLETED_EVENT_CODEコードを持つ イベントを点火するかどうかを設定します。 デフォルトでは、このストリームによって完了イベントは点火されません。

Methods inherited from class java.io.FilterInputStream

available, mark, markSupported, read, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressReportingInputStream

public ProgressReportingInputStream(InputStream in,
                                    ProgressListenerCallbackExecutor listenerCallbackExecutor)

新しい進捗状況報告用の入力ストリームを生成します。 それは指定された入力ストリームを単純にラップし、 転送したバイト数を非同期にリスナーに通知するために 指定したリスナーのコールバック実行を使用します。

Parameters:

in - ラップする入力ストリーム

listenerCallbackExecutor - 進捗状況について通知するリスナーをラップするリスナーのコールバック実行

Method Detail

getFireCompletedEvent

public boolean getFireCompletedEvent()

この入力ストリームのデータが尽きた時に この入力ストリームがProgressEvent.COMPLETED_EVENT_CODEコードを持つ イベントを点火するかどうかを取得します。 デフォルトでは、このストリームによって完了イベントは点火されません。

Returns:

この入力ストリームが完全に読み取られたことを示すために イベントを点火するかどうか

setFireCompletedEvent

public void setFireCompletedEvent(boolean fireCompletedEvent)

このInputStreamのデータが尽きた時に このInputStreamがProgressEvent.COMPLETED_EVENT_CODEコードを持つ イベントを点火するかどうかを設定します。 デフォルトでは、このストリームによって完了イベントは点火されません。

Parameters:

fireCompletedEvent - このInputStreamがストリームが完全に読み取られたことを示すために イベントを点火するかどうか

read

public int read()
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class FilterInputStream

Throws:

IOException

read

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

Overrides:

read in class FilterInputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FilterInputStream

Throws:

IOException