/*
 * 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.ByteArrayInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;

/**
 * <P>
 * 入力ストリームファクトリの機能を定義します。
 * 入力ストリームファクトリは、入力ストリームをファイル、パス文字列、バイト配列、URL などのオブジェクトから生成するために使用します。
 * </P>
 * <P>
 * この実装の getInputStream メソッドは、ExpandedInputStream を返します。
 * </P>
 * @author Kumiko Hiroi
 */
public class InputStreamFactory
{

	/**
	 * <P>
	 * InputStreamFactory オブジェクトを作成します。
	 * </P>
	 */
	public InputStreamFactory()
	{
		super();
	}

	/**
	 * <P>
	 * ファイルシステムの実際のファイル (File オブジェクト file により指定) に接続することにより、FileInputStream を作成します。
	 * このファイルの接続を表すために、新しい FileDescriptor オブジェクトが生成されます。
	 * </P>
	 * <P>
	 * まず、セキュリティマネージャが存在する場合、checkRead メソッドが、file 引数によって表されるパスを引数として呼び出されます。
	 * </P>
	 * <P>
	 * 指定されたファイルが存在しないか、普通のファイルではなくディレクトリであるか、またはなんらかの理由で開くことができない場合は、FileNotFoundException がスローされます。
	 * </P>
	 * @param file 読み込みのために開かれるファイル
	 * @return ファイルを読み込むための入力ストリーム (ExpandedInputStream)
	 * @exception FileNotFoundException ファイルが存在しないか、普通のファイルではなくディレクトリであるか、またはなんらかの理由で開くことができない場合
	 * @exception SecurityException セキュリティマネージャが存在し、checkRead メソッドがファイルへの読み込みアクセスを拒否する場合
	 */
	public synchronized InputStream getInputStream(File file) throws FileNotFoundException
	{
		return new ExpandedInputStream(new FileInputStream(file));
	}

	/**
	 * <P>
	 * ファイルシステムの実際のファイル (パス名 path により指定) に接続することにより、FileInputStream を作成します。
	 * このファイルの接続を表すために、新しい FileDescriptor オブジェクトが生成されます。
	 * </P>
	 * <P>
	 * まず、セキュリティマネージャが存在する場合、checkRead メソッドが name 引数を引数として呼び出されます。
	 * </P>
	 * <P>
	 * 指定されたファイルが存在しないか、普通のファイルではなくディレクトリであるか、またはなんらかの理由で開くことができない場合は、FileNotFoundException がスローされます。
	 * </P>
	 * @param name システム依存のファイル名
	 * @return ファイルを読み込むための入力ストリーム (ExpandedInputStream)
	 * @exception FileNotFoundException ファイルが存在しないか、普通のファイルではなくディレクトリであるか、またはなんらかの理由で開くことができない場合
	 * @exception SecurityException セキュリティマネージャが存在し、checkRead メソッドがファイルへの読み込みアクセスを拒否する場合
	 */
	public synchronized InputStream getInputStream(String path) throws FileNotFoundException
	{
		return getInputStream(new File(path));
	}

	/**
	 * <P>
	 * bytes をバッファ配列として使うように、ByteArrayInputStream を作成します。
	 * バッファ配列はコピーされません。
	 * pos の初期値は 0 で、count の初期値は bytes の長さです。
	 * </P>
	 * @param bytes 入力バッファ
	 * @return バイト配列を読み込むための入力ストリーム (ExpandedInputStream)
	 */
	public synchronized InputStream getInputStream(byte[] bytes)
	{
		return new ExpandedInputStream(new ByteArrayInputStream(bytes));
	}

	/**
	 * <P>
	 * bytes をバッファ配列として使うように、ByteArrayInputStream を作成します。
	 * pos の初期値は offset で、count の初期値は offset + len です。
	 * バッファ配列はコピーされません。
	 * バッファのマークは指定したオフセットに設定されます。
	 * </P>
	 * @param bytes 入力バッファ
	 * @param offset バッファからのバイト読み込み開始オフセット
	 * @param length バッファから読み込む最大バイト数
	 * @return バイト配列を読み込むための入力ストリーム (ExpandedInputStream)
	 */
	public synchronized InputStream getInputStream(byte[] bytes, int offset, int length)
	{
		return new ExpandedInputStream(new ByteArrayInputStream(bytes, offset, length));
	}

	/**
	 * <P>
	 * url への接続を確立し、その接続から読み込みを行うための InputStream を作成します。
	 * </P>
	 * @param url URL
	 * @return URL 接続から入力を読み込むための入力ストリーム (ExpandedInputStream)
	 * @exception IOException 入出力例外が発生した場合
	 */
	public synchronized InputStream getInputStream(URL url) throws IOException
	{
		return new ExpandedInputStream(url.openStream());
	}
}
