com.orangesignal.jlha.LimitedInputStream Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of orangesignal-csv Show documentation
OrangeSignal CSV is a very flexible csv (comma-separated values) read and write library for Java.
The newest version!
/**
 * Copyright (C) 2001-2002  Michel Ishizuka  All rights reserved.
 * 
 * 以下の条件に同意するならばソースとバイナリ形式の再配布と使用を
 * 変更の有無にかかわらず許可する。
 * 
 * １．ソースコードの再配布において著作権表示と この条件のリスト
 *     および下記の声明文を保持しなくてはならない。
 * 
 * ２．バイナリ形式の再配布において著作権表示と この条件のリスト
 *     および下記の声明文を使用説明書もしくは その他の配布物内に
 *     含む資料に記述しなければならない。
 * 
 * このソフトウェアは石塚美珠瑠によって無保証で提供され、特定の目
 * 的を達成できるという保証、商品価値が有るという保証にとどまらず、
 * いかなる明示的および暗示的な保証もしない。
 * 石塚美珠瑠は このソフトウェアの使用による直接的、間接的、偶発
 * 的、特殊な、典型的な、あるいは必然的な損害(使用によるデータの
 * 損失、業務の中断や見込まれていた利益の遺失、代替製品もしくは
 * サービスの導入費等が考えられるが、決してそれだけに限定されない
 * 損害)に対して、いかなる事態の原因となったとしても、契約上の責
 * 任や無過失責任を含む いかなる責任があろうとも、たとえそれが不
 * 正行為のためであったとしても、またはそのような損害の可能性が報
 * 告されていたとしても一切の責任を負わないものとする。
 */

package com.orangesignal.jlha;

import java.io.IOException;
import java.io.InputStream;

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

 * 
 * @author $Author: dangan $
 * @version $Revision: 1.1.2.1 $
 */
public class LimitedInputStream extends InputStream {

	/**
	 * 接続された入力ストリーム
	 */
	private InputStream in;

	/**
	 * 現在読み込み位置
	 */
	private long position;

	/**
	 * 読み込み限界
	 */
	private final long limit;

	/**
	 * マーク位置
	 */
	private long markPosition;

	// ------------------------------------------------------------------
	// Constructor

	/**
	 * in からの読み込み可能なデータ量を制限した 入力ストリームを構築する。

	 * 
	 * @param in 入力ストリーム
	 * @param limit 読み込み可能バイト数
	 * 
	 * @exception IllegalArgumentException limit が負数である場合
	 */
	public LimitedInputStream(final InputStream in, final long limit) {
		if (in != null && 0 <= limit) {
			this.in = in;
			position = 0;
			this.limit = limit;
			markPosition = -1;
		} else if (in == null) {
			throw new NullPointerException("in");
		} else {
			throw new IllegalArgumentException("limit must be 0 or more.");
		}
	}

	// ------------------------------------------------------------------
	// Override method

	/**
	 * 接続された入力ストリームから 1バイトのデータを読み込む。
	 * 
	 * @return 読み込まれた 1バイトのデータ
既にEndOfStream に達していたか、 制限に達した場合は -1 を返す。

	 * @exception IOException 入出力エラーが発生した場合
	 */
	@Override
	public int read() throws IOException {
		if (position < limit) {
			final int ret = in.read();                                           // throws IOException
			if (0 <= ret) {
				position++;
			}
			return ret;
		}
		return -1;
	}

	/**
	 * 接続された入力ストリームから buffer を満たすように データを読み込む。

	 * データは必ずしも buffer を満たすとは限らないことに注意。

	 * 
	 * @param buffer 読み込んだデータを格納するためのバイト配列

	 * @return buffer に読み込んだデータ量をバイト数で返す。
既にEndOfStream に達していたか、 制限に達した場合は -1 を返す。

	 * @exception IOException 入出力エラーが発生した場合
	 */
	@Override
	public int read(final byte[] buffer) throws IOException {
		if (0 < buffer.length) {
			int ret;
			if (buffer.length < limit - position) {
				ret = in.read(buffer);                                   // throws IOException
			} else if (position < limit) {
				ret = in.read(buffer, 0, (int) (limit - position));// throws IOException
			} else {
				return -1;
			}
			if (0 < ret) {
				position += ret;
			}
			return ret;
		}
		return 0;
	}

	/**
	 * 接続された入力ストリームから バイト配列 buffer の index で指定された位置から length バイトのデータを 読み込む。

	 * データは必ずしも length バイト読み込まれるとは限ら ないことに注意。

	 * 
	 * @param buffer 読み込まれたデータを格納するためのバイト配列
	 * @param index buffer内のデータ読み込み開始位置
	 * @param length bufferに読み込むデータ量
	 * @return buffer に読み込んだデータ量をバイト数で返す。
既にEndOfStream に達していたか、 制限に達した場合は -1 を返す。

	 * @exception IOException 入出力エラーが発生した場合
	 */
	@Override
	public int read(final byte[] buffer, final int index, int length) throws IOException {
		if (0 < length) {
			if (limit <= position) {
				return -1;
			} else if (limit - position < length) {
				length = (int) (limit - position);
			}
			final int ret = in.read(buffer, index, length);                    // throws IOException
			if (0 < ret) {
				position += ret;
			}
			return ret;
		}
		return 0;
	}

	/**
	 * 接続された入力ストリームのデータを length バイト読み飛ばす。

	 * 
	 * @param length 読み飛ばすバイト数。

	 * @return 実際に読み飛ばされたバイト数。

	 * @exception IOException 入出力エラーが発生した場合
	 */
	@Override
	public long skip(long length) throws IOException {
		if (0 < length) {
			if (limit <= position) {
				return 0;
			} else if (limit - position < length) {
				length = limit - position;
			}
			length = in.skip(length);                                    // throws IOException
			if (0 < length) {
				position += length;
			}
			return length;
		}
		return 0;
	}

	/**
	 * 接続された入力ストリームの現在位置にマークを設定し、 reset() メソッドでマークした時点の 読み込み位置に 戻れるようにする。

	 * 
	 * @param readLimit マーク位置に戻れる限界のバイト数。 このバイト数を超えてデータを読み 込んだ場合 reset()できなくなる可 能性がある。

	 */
	@Override
	public void mark(final int readLimit) {
		in.mark(readLimit);
		markPosition = position;
	}

	/**
	 * 接続された入力ストリームの読み込み位置を最後に mark() メソッドが呼び出されたときの位置に設定する。

	 * 
	 * @exception IOException 

	 * 
	 * LimitedInputStream に mark がなされていない場合。

	 * 
接続された入力ストリームが markSupported()で false を返す場合。

	 * 
接続された入力ストリームで 入出力エラーが発生した場合。

	 * 
	 * の何れか。
	 */
	@Override
	public void reset() throws IOException {
		if (!in.markSupported()) {
			throw new IOException("not support mark()/reset().");
		} else if (markPosition < 0) { // コンストラクタで MarkPosition が -1 に設定されるのを利用する。
			throw new IOException("not marked.");
		} else {
			in.reset();                                                    // throws IOException
			position = markPosition;
		}
	}

	/**
	 * 接続された入力ストリームが mark() と reset() を サポートするかを得る。

	 * 
	 * @return ストリームが mark() と reset() を サポートする場合は true。

	 * サポートしない場合は false。

	 */
	@Override
	public boolean markSupported() {
		return in.markSupported();
	}

	/**
	 * 接続された入力ストリームからブロックしないで 読み込むことのできるバイト数を得る。

	 * 
	 * @return ブロックしないで読み出せるバイト数。

	 * @exception IOException 入出力エラーが発生した場合
	 */
	@Override
	public int available() throws IOException {
		return (int) Math.min(in.available(), limit - position);
	}

	/**
	 * この入力ストリームを閉じ、使用していた 全てのリソースを開放する。

	 * 
	 * @exception IOException 入出力エラーが発生した場合
	 */
	@Override
	public void close() throws IOException {
		in.close();                                                        // throws IOException
		in = null;
	}

}