LimitedInputStream (LHA Library for Java)

java.lang.Object
- java.io.InputStream
- - jp.gr.java_conf.dangan.io.LimitedInputStream

All Implemented Interfaces:: java.io.Closeable, java.lang.AutoCloseable

public class LimitedInputStream
extends java.io.InputStream

読み込み可能なデータ量が制限された入力ストリーム。

 -- revision history --
 $Log: LimitedInputStream.java,v $
 Revision 1.1.2.1  2003/07/20 17:03:37  dangan
 [maintenance]
     最新の LimitedInputStream からソースを取り込む。

 Revision 1.1  2002/12/05 00:00:00  dangan
 [maintenance]
     ソース整備

 Revision 1.0  2002/07/24 00:00:00  dangan
 add to version control
 [change]
     EndOfStream に達した後の read( new byte[0] ) や 
     read( byte[] buf, int off, 0 ) の戻り値を
     InputStream と同じく 0 になるようにした
 [maintenance]
     タブ廃止
     ライセンス文の修正

Version:: $Revision: 1.1.2.1 $
Author:: $Author: dangan $

Constructor Summary

Constructors
Constructor and Description
`LimitedInputStream(java.io.InputStream in, long limit)` in からの読み込み可能なデータ量を制限した入力ストリームを構築する。

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`available()` 接続された入力ストリームからブロックしないで読み込むことのできるバイト数を得る。
`void`	`close()` この入力ストリームを閉じ、使用していた全てのリソースを開放する。
`void`	`mark(int readLimit)` 接続された入力ストリームの現在位置にマークを設定し、 reset() メソッドでマークした時点の読み込み位置に戻れるようにする。
`boolean`	`markSupported()` 接続された入力ストリームが mark() と reset() をサポートするかを得る。
`int`	`read()` 接続された入力ストリームから 1バイトのデータを読み込む。
`int`	`read(byte[] buffer)` 接続された入力ストリームから buffer を満たすようにデータを読み込む。データは必ずしも buffer を満たすとは限らないことに注意。
`int`	`read(byte[] buffer, int index, int length)` 接続された入力ストリームからバイト配列 buffer の index で指定された位置から length バイトのデータを読み込む。データは必ずしも length バイト読み込まれるとは限らないことに注意。
`void`	`reset()` 接続された入力ストリームの読み込み位置を最後に mark() メソッドが呼び出されたときの位置に設定する。
`long`	`skip(long length)` 接続された入力ストリームのデータを length バイト読み飛ばす。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LimitedInputStream
```
public LimitedInputStream(java.io.InputStream in,
                          long limit)
```
    in からの読み込み可能なデータ量を制限した入力ストリームを構築する。
    
    Parameters:
    
    in - 入力ストリーム
    
    limit - 読み込み可能バイト数
    
    Throws:
    
    java.lang.IllegalArgumentException - limit が負数である場合
- Method Detail
  - read
```
public int read()
         throws java.io.IOException
```
    接続された入力ストリームから 1バイトのデータを読み込む。
    
    Specified by:
    
    read in class java.io.InputStream
    
    Returns:
    
    読み込まれた 1バイトのデータ
    既にEndOfStream に達していたか、制限に達した場合は -1 を返す。
    
    Throws:
    
    java.io.IOException - 入出力エラーが発生した場合
  - read
```
public int read(byte[] buffer)
         throws java.io.IOException
```
    接続された入力ストリームから buffer を満たすようにデータを読み込む。
    データは必ずしも buffer を満たすとは限らないことに注意。
    
    Overrides:
    
    read in class java.io.InputStream
    
    Parameters:
    
    buffer - 読み込んだデータを格納するためのバイト配列
    
    Returns:
    
    buffer に読み込んだデータ量をバイト数で返す。
    既にEndOfStream に達していたか、制限に達した場合は -1 を返す。
    
    Throws:
    
    java.io.IOException - 入出力エラーが発生した場合
  - read
```
public int read(byte[] buffer,
                int index,
                int length)
         throws java.io.IOException
```
    接続された入力ストリームからバイト配列 buffer の index で指定された位置から length バイトのデータを読み込む。
    データは必ずしも length バイト読み込まれるとは限らないことに注意。
    
    Overrides:
    
    read in class java.io.InputStream
    
    Parameters:
    
    buffer - 読み込まれたデータを格納するためのバイト配列
    
    index - buffer内のデータ読み込み開始位置
    
    length - bufferに読み込むデータ量
    
    Returns:
    
    buffer に読み込んだデータ量をバイト数で返す。
    既にEndOfStream に達していたか、制限に達した場合は -1 を返す。
    
    Throws:
    
    java.io.IOException - 入出力エラーが発生した場合
  - skip
```
public long skip(long length)
          throws java.io.IOException
```
    接続された入力ストリームのデータを length バイト読み飛ばす。
    
    Overrides:
    
    skip in class java.io.InputStream
    
    Parameters:
    
    length - 読み飛ばすバイト数。
    
    Returns:
    
    実際に読み飛ばされたバイト数。
    
    Throws:
    
    java.io.IOException - 入出力エラーが発生した場合
  - mark
```
public void mark(int readLimit)
```
    接続された入力ストリームの現在位置にマークを設定し、 reset() メソッドでマークした時点の読み込み位置に戻れるようにする。
    
    Overrides:
    
    mark in class java.io.InputStream
    
    Parameters:
    
    readLimit - マーク位置に戻れる限界のバイト数。このバイト数を超えてデータを読み込んだ場合 reset()できなくなる可能性がある。
  - reset
```
public void reset()
           throws java.io.IOException
```
    接続された入力ストリームの読み込み位置を最後に mark() メソッドが呼び出されたときの位置に設定する。
    Overrides:
    
    reset in class java.io.InputStream
    
    Throws:
    java.io.IOException -
    
    LimitedInputStream に mark がなされていない場合。
    
    接続された入力ストリームが markSupported()で false を返す場合。
    
    接続された入力ストリームで入出力エラーが発生した場合。
    
    の何れか。
  - markSupported
```
public boolean markSupported()
```
    接続された入力ストリームが mark() と reset() をサポートするかを得る。
    
    Overrides:
    
    markSupported in class java.io.InputStream
    
    Returns:
    
    ストリームが mark() と reset() をサポートする場合は true。
    サポートしない場合は false。
  - available
```
public int available()
              throws java.io.IOException
```
    接続された入力ストリームからブロックしないで読み込むことのできるバイト数を得る。
    
    Overrides:
    
    available in class java.io.InputStream
    
    Returns:
    
    ブロックしないで読み出せるバイト数。
    
    Throws:
    
    java.io.IOException - 入出力エラーが発生した場合
  - close
```
public void close()
           throws java.io.IOException
```
    この入力ストリームを閉じ、使用していた全てのリソースを開放する。
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Overrides:
    
    close in class java.io.InputStream
    
    Throws:
    
    java.io.IOException - 入出力エラーが発生した場合

When you found typographical errors or omissions, Please mail to cqw10305@nifty.com
The company name and product name which are used in this document, it is the trademark or registered trademark of each company generally.
Copyright © 2001-2002 Michel Ishizuka. All Rights Reserved.

Class LimitedInputStream

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LimitedInputStream

Method Detail

read

read

read

skip

mark

reset

markSupported

available

close