/*
 * Copyright (c) 2003, Morpho Project.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 3. Neither the name of the Morpho Project nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package jp.morpho.io;

import java.io.BufferedInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

/**
 * <P>
 * 入力ストリームに機能、特に入力をバッファに格納する機能と mark メソッドと reset メソッドをサポートする機能を追加します。
 * ExpandedInputStream が作成されると、内部バッファ配列が作成されます。
 * ストリームのバイトが読み込まれるかスキップされると、格納されている入力ストリームから必要に応じて一度に多数のバイトが内部バッファに補充されます。
 * mark オペレーションは入力ストリームの特定位置を記憶します。
 * reset オペレーションは、格納されている入力ストリームから新しいバイトが取得される前に、最後に実行された mark オペレーション以降に読み込まれたすべてのバイトを再読み込みします。
 * </P>
 * @author Kumiko Hiroi
 */
public class ExpandedInputStream
	extends BufferedInputStream
{

	/**
	 * <P>
	 * ExpandedInputStream を作成し、その引数である入力ストリーム in をあとで使用できるように保存します。
	 * 内部バッファ配列が作成され、buf に格納されます。
	 * </P>
	 * @param in 基本となる入力ストリーム
	 */
	public ExpandedInputStream(InputStream in)
	{
		super(in);
	}

	/**
	 * <P>
	 * 指定されたバッファサイズを持つ ExpandedInputStream を作成し、その引数である入力ストリーム in をあとで使用できるように保存します。
	 * 長さ size の内部バッファ配列が作成され、buf に格納されます。
	 * </P>
	 * @param in 基本となる入力ストリーム
	 * @param size バッファサイズ
	 * @exception IllegalArgumentException size が 0 以下の場合
	 */
	public ExpandedInputStream(InputStream in, int size)
	{
		super(in, size);
	}

	/**
	 * <P>
	 * 入力ストリームからすべての内容を読み込みます。
	 * </P>
	 * @exception IOException 入出力エラーが発生した場合
	 */
	public synchronized byte[] readAll()
		throws IOException
	{
		ByteArrayOutputStream out = new ByteArrayOutputStream();
		writeTo(out);

		return out.toByteArray();
	}

	/**
	 * <P>
	 * 入力ストリームのすべての内容を、指定された出力ストリーム引数に書き込みます。
	 * これは out.write(byte[], int, int) を使って出力ストリームの write メソッドを呼び出すのと同じです。
	 * </P>
	 * @param out データを書き込む出力ストリーム
	 * @exception IOException 入出力エラーが発生した場合
	 */
	public synchronized void writeTo(OutputStream out)
		throws IOException
	{
		byte[] b = new byte[buf.length];
		int len = 0;
		while ((len = read(b, 0, b.length)) != -1)
		{
			out.write(b, 0, len);
		}
	}

	/**
	 * <P>
	 * ExpandedInputStream を作成し、その引数である入力ストリーム in をあとで使用できるように保存します。
	 * in が ExpandedInputStream の場合は、それを返します。
	 * </P>
	 * @param in 基本となる入力ストリーム
	 */
	public synchronized static ExpandedInputStream valueOf(InputStream in)
	{
		if (in instanceof ExpandedInputStream)
		{
			return (ExpandedInputStream)in;
		}
		else
		{
			return new ExpandedInputStream(in);
		}
	}
}
