com.amazonaws.services.s3.internal

## クラス ProgressReportingInputStream

- java.lang.Object
- - java.io.InputStream
  - - java.io.FilterInputStream
    - - com.amazonaws.services.s3.internal.ProgressReportingInputStream

- すべての実装されたインタフェース:
    java.io.Closeable, java.lang.AutoCloseable

      public class ProgressReportingInputStream
      extends java.io.FilterInputStream

  Simple InputStream wrapper that occasionally notifies a progress listener about the number of bytes transferred.

- - ### フィールドの概要

    - ### クラスから継承されたフィールド java.io.FilterInputStream

      `in`

  - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `ProgressReportingInputStream(java.io.InputStream in, ProgressListener listener)` Creates a new progress reporting input stream that simply wraps the specified input stream and notifies the specified listener occasionally about the number of bytes transferred.

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `void` | `close()`
    `boolean` | `getFireCompletedEvent()` Returns whether this input stream should fire an event with code `ProgressEvent.COMPLETED_EVENT_CODE` when this stream runs out of data.
    `int` | `read()`
    `int` | `read(byte[] b, int off, int len)`
    `void` | `setFireCompletedEvent(boolean fireCompletedEvent)` Sets whether this input stream should fire an event with code `ProgressEvent.COMPLETED_EVENT_CODE` when this stream runs out of data.

    - ### クラスから継承されたメソッド java.io.FilterInputStream

      `available, mark, markSupported, read, reset, skip`

    - ### クラスから継承されたメソッド java.lang.Object

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

- - ### コンストラクタの詳細

    - #### ProgressReportingInputStream

          public ProgressReportingInputStream(java.io.InputStream in,
                                      ProgressListener listener)

      Creates a new progress reporting input stream that simply wraps the specified input stream and notifies the specified listener occasionally about the number of bytes transferred.
      パラメータ:
        `in` - The input stream to wrap.
        `listener` - The listener to notify about progress.

  - ### メソッドの詳細

    - #### setFireCompletedEvent

          public void setFireCompletedEvent(boolean fireCompletedEvent)

      Sets whether this input stream should fire an event with code `ProgressEvent.COMPLETED_EVENT_CODE` when this stream runs out of data. By default, completed events are not fired by this stream.
      パラメータ:
        `fireCompletedEvent` - Whether this input stream should fire an event to indicate that the stream has been fully read.

    - #### getFireCompletedEvent

          public boolean getFireCompletedEvent()

      Returns whether this input stream should fire an event with code `ProgressEvent.COMPLETED_EVENT_CODE` when this stream runs out of data. By default, completed events are not fired by this stream.
      戻り値:
        Whether this input stream should fire an event to indicate that the stream has been fully read.

    - #### read

          public int read()
                   throws java.io.IOException

      オーバーライド:
        `read` クラス内 `java.io.FilterInputStream`
      例外:
        `java.io.IOException`

    - #### read

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

      オーバーライド:
        `read` クラス内 `java.io.FilterInputStream`
      例外:
        `java.io.IOException`

    - #### close

          public void close()
                     throws java.io.IOException

      定義:
        `close` インタフェース内 `java.io.Closeable`
      定義:
        `close` インタフェース内 `java.lang.AutoCloseable`
      オーバーライド:
        `close` クラス内 `java.io.FilterInputStream`
      例外:
        `java.io.IOException`