/*
 * 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.BufferedOutputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.net.URL;

/**
 * <P>
 * 出力ストリームファクトリの機能を定義します。
 * 出力ストリームファクトリは、出力ストリームをファイル、パス文字列、バイト配列のサイズ、URL などのオブジェクトから生成するために使用します。
 * </P>
 * @author Kumiko Hiroi
 */
public class OutputStreamFactory
{

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

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

	/**
	 * <P>
	 * 指定された File オブジェクトが表すファイルに書き込むための出力ファイルストリームを作成します。
	 * 2 番目の引数が true の場合、バイトはファイルの先頭ではなく最後に書き込まれます。
	 * このファイル接続を表すために、新しい FileDescriptor オブジェクトが生成されます。
	 * </P>
	 * <P>
	 * まず、セキュリティマネージャが存在する場合、checkWrite メソッドが file 引数によって表されるパスを引数として呼び出されます。
	 * </P>
	 * <P>
	 * ファイルは存在するが、普通のファイルではなくディレクトリである場合、ファイルは存在せず作成もできない場合、またはなんらかの理由で開くことができない場合は、FileNotFoundException がスローされます。
	 * </P>
	 * @param file 書き込みのために開かれるファイル
	 * @param append true の場合、バイトはファイルの先頭ではなく最後に書き込まれる
	 * @return ファイルに書き込むためのファイル出力ストリーム (BufferedOutputStream)
	 * @exception FileNotFoundException ファイルは存在するが、普通のファイルではなくディレクトリである場合、ファイルは存在せず作成もできない場合、またはなんらかの理由で開くことができない場合
	 * @exception SecurityException セキュリティマネージャが存在し、checkWrite メソッドがファイルへの書き込みアクセスを拒否する場合
	 */
	public synchronized OutputStream getOutputStream(File file, boolean append) throws FileNotFoundException
	{
		return new BufferedOutputStream(new FileOutputStream(file, append));
	}

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

	/**
	 * <P>
	 * 指定された path のファイルに書き込むための出力ファイルストリームを作成します。
	 * 2 番目の引数が true の場合、バイトはファイルの先頭ではなく最後に書き込まれます。
	 * このファイル接続を表すために、新しい FileDescriptor オブジェクトが生成されます。
	 * </P>
	 * <P>
	 * まず、セキュリティマネージャが存在する場合、checkWrite メソッドが name を引数として呼び出されます。
	 * </P>
	 * <P>
	 * ファイルは存在するが、普通のファイルではなくディレクトリである場合、ファイルは存在せず作成もできない場合、またはなんらかの理由で開くことができない場合は、FileNotFoundException がスローされます。
	 * </P>
	 * @param name システムに依存するファイル名
	 * @param append true の場合、バイトはファイルの先頭ではなく最後に書き込まれる
	 * @return ファイルに書き込むためのファイル出力ストリーム (BufferedOutputStream)
	 * @exception FileNotFoundException ファイルは存在するが、普通のファイルではなくディレクトリである場合、ファイルは存在せず作成もできない場合、またはなんらかの理由で開くことができない場合
	 * @exception SecurityException セキュリティマネージャが存在し、checkWrite メソッドがファイルへの書き込みアクセスを拒否する場合
	 */
	public synchronized OutputStream getOutputStream(String path, boolean append) throws FileNotFoundException
	{
		return getOutputStream(new File(path), append);
	}

	/**
	 * <P>
	 * バイト数で指定されたサイズのバッファを持つ、バイト配列出力ストリームを新しく作成します。
	 * </P>
	 * @param size 初期サイズ
	 * @return バイト配列出力ストリーム (ByteArrayOutputStream)
	 */
	public synchronized OutputStream getOutputStream(int size)
	{
		return new ByteArrayOutputStream(size);
	}

	/**
	 * <P>
	 * url への接続を確立し、その接続に書き込みを行う出力ストリームを作成します。
	 * </P>
	 * @param url URL
	 * @return URL 接続に書き込みを行う出力ストリーム (BufferedOutputStream)
	 * @exception IOException 入出力例外が発生した場合
	 * @exception UnknownServiceException プロトコルが出力をサポートしていない場合
	 */
	public synchronized OutputStream getOutputStream(URL url) throws IOException
	{
		return new BufferedOutputStream(url.openConnection().getOutputStream());
	}
}
