JavaTM Platform
Standard Ed. 6

javax.swing
クラス ProgressMonitorInputStream

java.lang.Object
  上位を拡張 java.io.InputStream
      上位を拡張 java.io.FilterInputStream
          上位を拡張 javax.swing.ProgressMonitorInputStream
すべての実装されたインタフェース:
Closeable

public class ProgressMonitorInputStream
extends FilterInputStream

InputStream からの読み込みの進捗を監視します。この ProgressMonitor は通常、次のような形式で呼び出されます。  

 InputStream in = new BufferedInputStream(
                          new ProgressMonitorInputStream(
                                  parentComponent,
                                  "Reading " + fileName,
                                  new FileInputStream(fileName)));
 

これにより、入力ストリームの読み込みの進捗を監視する進捗モニターが作成されます。しばらく時間がかかる場合には、ProgressDialog が表示され、ユーザーに通知します。ユーザーが「取消し (Cancel)」ボタンを押すと、次の読み込みで InterruptedIOException がスローされます。ストリームが閉じると、適切なクリーンアップがすべて実行されます。

例および詳細は、「The Java Tutorial」の「How to Monitor Progress」を参照してください。

関連項目:
ProgressMonitor, JOptionPane

フィールドの概要
 
クラス java.io.FilterInputStream から継承されたフィールド
in
 
コンストラクタの概要
ProgressMonitorInputStream(Component parentComponent, Object message, InputStream in)
          入力ストリームの進捗を監視するオブジェクトを構築します。
 
メソッドの概要
 void close()
          FilterInputStream.close をオーバーライドして、ストリームと進捗モニターの両方を閉じることができるようにします。
 ProgressMonitor getProgressMonitor()
          このストリームによって使用されている ProgressMonitor オブジェクトを取得します。
 int read()
          FilterInputStream.read をオーバーライドして、読み込みのあとに進捗モニターを更新できるようにします。
 int read(byte[] b)
          FilterInputStream.read をオーバーライドして、読み込みのあとに進捗モニターを更新できるようにします。
 int read(byte[] b, int off, int len)
          FilterInputStream.read をオーバーライドして、読み込みのあとに進捗モニターを更新できるようにします。
 void reset()
          FilterInputStream.reset をオーバーライドして、ストリームと進捗モニターの両方をリセットできるようにします。
 long skip(long n)
          FilterInputStream.skip をオーバーライドして、スキップのあとに進捗モニターを更新できるようにします。
 
クラス java.io.FilterInputStream から継承されたメソッド
available, mark, markSupported
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

ProgressMonitorInputStream

public ProgressMonitorInputStream(Component parentComponent,
                                  Object message,
                                  InputStream in)
入力ストリームの進捗を監視するオブジェクトを構築します。

パラメータ:
message - ダイアログボックスが表示される場合は、 そのダイアログボックスに表示される説明テキスト
parentComponent - 監視している処理をトリガーする コンポーネント
in - 監視する入力ストリーム
メソッドの詳細

getProgressMonitor

public ProgressMonitor getProgressMonitor()
このストリームによって使用されている ProgressMonitor オブジェクトを取得します。ファイルの読み込み途中で説明テキストを変更したりする必要がないかぎり、通常このメソッドは必要ありません。

戻り値:
このオブジェクトによって使用される ProgressMonitor オブジェクト

read

public int read()
         throws IOException
FilterInputStream.read をオーバーライドして、読み込みのあとに進捗モニターを更新できるようにします。

オーバーライド:
クラス FilterInputStream 内の read
戻り値:
データの次のバイト。ストリームの終わりに達した場合は -1
例外:
IOException - 入出力エラーが発生した場合
関連項目:
FilterInputStream.in

read

public int read(byte[] b)
         throws IOException
FilterInputStream.read をオーバーライドして、読み込みのあとに進捗モニターを更新できるようにします。

オーバーライド:
クラス FilterInputStream 内の read
パラメータ:
b - データの読み込み先のバッファ
戻り値:
バッファに読み込まれたバイトの合計数。ストリームの終わりに達してデータがない場合は -1
例外:
IOException - 入出力エラーが発生した場合
関連項目:
FilterInputStream.read(byte[], int, int)

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException
FilterInputStream.read をオーバーライドして、読み込みのあとに進捗モニターを更新できるようにします。

オーバーライド:
クラス FilterInputStream 内の read
パラメータ:
b - データの読み込み先のバッファ
off - 転送先の配列 b 内での開始オフセット
len - 読み込まれる最大バイト数
戻り値:
バッファに読み込まれたバイトの合計数。ストリームの終わりに達してデータがない場合は -1
例外:
IOException - 入出力エラーが発生した場合
関連項目:
FilterInputStream.in

skip

public long skip(long n)
          throws IOException
FilterInputStream.skip をオーバーライドして、スキップのあとに進捗モニターを更新できるようにします。

オーバーライド:
クラス FilterInputStream 内の skip
パラメータ:
n - スキップするバイト数
戻り値:
実際にスキップされたバイト数
例外:
IOException - ストリームがシークをサポートしない場合、またはその他の入出力エラーが発生した場合

close

public void close()
           throws IOException
FilterInputStream.close をオーバーライドして、ストリームと進捗モニターの両方を閉じることができるようにします。

定義:
インタフェース Closeable 内の close
オーバーライド:
クラス FilterInputStream 内の close
例外:
IOException - 入出力エラーが発生した場合
関連項目:
FilterInputStream.in

reset

public void reset()
           throws IOException
FilterInputStream.reset をオーバーライドして、ストリームと進捗モニターの両方をリセットできるようにします。

オーバーライド:
クラス FilterInputStream 内の reset
例外:
IOException - ストリームにマークが設定されていなかった場合、またはマークが無効になっていた場合
関連項目:
FilterInputStream.in, FilterInputStream.mark(int)

JavaTM Platform
Standard Ed. 6

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2009 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。