/*
 * 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.util;

/**
 * <P>
 * プリミティブ型の値をマッピングするオブジェクトです。
 * これは java.util.Map オブジェクトのような Map に、プリミティブ型の値をマッピングすることを可能にします。
 * boolean 、byte 、char 、double 、float 、int 、long 、short 、その他のプリミティブ型の値は、オブジェクトにラップされて Map オブジェクトにマッピングされます。
 * </P>
 * @author Kenichi Fukuda
 */
public interface PrimitiveHolderMap
	extends java.util.Map
{

	/**
	 * <P>
	 * マップが指定のキーをマップする値を入力ストリームとして取得します。
	 * </P>
	 * @param key 関連付けられた値が返されるキー
	 * @return マップが指定されたキーをマップする値
	 */
	public java.io.InputStream getInputStream(Object key);

	/**
	 * <P>
	 * 指定の入力ストリームをマップ内の指定のキーと関連付けます。
	 * </P>
	 * @param key 指定された値が関連付けられるキー
	 * @param value 指定されたキーに関連付けられる値
	 */
	public void putInputStream(Object key, java.io.InputStream value);

	/**
	 * <P>
	 * マップが指定のキーをマップする値を java.math.BigDecimal オブジェクトとして取得します。
	 * </P>
	 * @param key 関連付けられた値が返されるキー
	 * @return マップが指定されたキーをマップする値
	 */
	public java.math.BigDecimal getBigDecimal(Object key);

	/**
	 * <P>
	 * 指定の java.math.BigDecimal オブジェクトをマップ内の指定のキーと関連付けます。
	 * </P>
	 * @param key 指定された値が関連付けられるキー
	 * @param value 指定されたキーに関連付けられる値
	 */
	public void putBigDecimal(Object key, java.math.BigDecimal value);

	/**
	 * <P>
	 * マップが指定のキーをマップする値を java.math.BigInteger オブジェクトとして取得します。
	 * </P>
	 * @param key 関連付けられた値が返されるキー
	 * @return マップが指定されたキーをマップする値
	 */
	public java.math.BigInteger getBigInteger(Object key);

	/**
	 * <P>
	 * 指定の java.math.BigInteger オブジェクトをマップ内の指定のキーと関連付けます。
	 * </P>
	 * @param key 指定された値が関連付けられるキー
	 * @param value 指定されたキーに関連付けられる値
	 */
	public void putBigInteger(Object key, java.math.BigInteger value);

	/**
	 * <P>
	 * マップが指定のキーをマップする値を Java プログラミング言語の boolean として取得します。
	 * </P>
	 * @param key 関連付けられた値が返されるキー
	 * @return マップが指定されたキーをマップする値
	 */
	public boolean getBoolean(Object key);

	/**
	 * <P>
	 * 指定の boolean 値をマップ内の指定のキーと関連付けます。
	 * </P>
	 * @param key 指定された値が関連付けられるキー
	 * @param value 指定されたキーに関連付けられる値
	 */
	public void putBoolean(Object key, boolean value);

	/**
	 * <P>
	 * マップが指定のキーをマップする値を Java プログラミング言語の byte として取得します。
	 * </P>
	 * @param key 関連付けられた値が返されるキー
	 * @return マップが指定されたキーをマップする値
	 */
	public byte getByte(Object key);

	/**
	 * <P>
	 * 指定の byte 値をマップ内の指定のキーと関連付けます。
	 * </P>
	 * @param key 指定された値が関連付けられるキー
	 * @param value 指定されたキーに関連付けられる値
	 */
	public void putByte(Object key, byte value);

	/**
	 * <P>
	 * マップが指定のキーをマップする値を Java プログラミング言語の byte 配列として取得します。
	 * </P>
	 * @param key 関連付けられた値が返されるキー
	 * @return マップが指定されたキーをマップする値
	 */
	public byte[] getBytes(Object key);

	/**
	 * <P>
	 * 指定の byte 配列をマップ内の指定のキーと関連付けます。
	 * </P>
	 * @param key 指定された値が関連付けられるキー
	 * @param value 指定されたキーに関連付けられる値
	 */
	public void putBytes(Object key, byte[] value);

	/**
	 * <P>
	 * マップが指定のキーをマップする値を Java プログラミング言語の char として取得します。
	 * </P>
	 * @param key 関連付けられた値が返されるキー
	 * @return マップが指定されたキーをマップする値
	 */
	public char getChar(Object key);

	/**
	 * <P>
	 * 指定の char 値をマップ内の指定のキーと関連付けます。
	 * </P>
	 * @param key 指定された値が関連付けられるキー
	 * @param value 指定されたキーに関連付けられる値
	 */
	public void putChar(Object key, char value);

	/**
	 * <P>
	 * マップが指定のキーをマップする値を java.io.Reader オブジェクトとして取得します。
	 * </P>
	 * @param key 関連付けられた値が返されるキー
	 * @return マップが指定されたキーをマップする値
	 */
	public java.io.Reader getReader(Object key);

	/**
	 * <P>
	 * 指定の java.io.Reader オブジェクトをマップ内の指定のキーと関連付けます。
	 * </P>
	 * @param key 指定された値が関連付けられるキー
	 * @param value 指定されたキーに関連付けられる値
	 */
	public void putReader(Object key, java.io.Reader value);

	/**
	 * <P>
	 * マップが指定のキーをマップする値を java.util.Date オブジェクトとして取得します。
	 * </P>
	 * @param key 関連付けられた値が返されるキー
	 * @return マップが指定されたキーをマップする値
	 */
	public java.util.Date getDate(Object key);

	/**
	 * <P>
	 * マップが指定のキーをマップする値の文字列表現を pattern で指定した日付／時刻パターンで解析して、java.util.Date オブジェクトとして取得します。
	 * </P>
	 * @param key 関連付けられた値が返されるキー
	 * @param pattern 日付／時刻パターン
	 * @return マップが指定されたキーをマップする値
	 */
	public java.util.Date parseDate(Object key, String pattern);

	/**
	 * <P>
	 * 指定の java.util.Date 値をマップ内の指定のキーと関連付けます。
	 * </P>
	 * @param key 指定された値が関連付けられるキー
	 * @param value 指定されたキーに関連付けられる値
	 */
	public void putDate(Object key, java.util.Date value);

	/**
	 * <P>
	 * マップが指定のキーをマップする値を Java プログラミング言語の double として取得します。
	 * </P>
	 * @param key 関連付けられた値が返されるキー
	 * @return マップが指定されたキーをマップする値
	 */
	public double getDouble(Object key);

	/**
	 * <P>
	 * 指定の double 値をマップ内の指定のキーと関連付けます。
	 * </P>
	 * @param key 指定された値が関連付けられるキー
	 * @param value 指定されたキーに関連付けられる値
	 */
	public void putDouble(Object key, double value);

	/**
	 * <P>
	 * マップが指定のキーをマップする値を Java プログラミング言語の float として取得します。
	 * </P>
	 * @param key 関連付けられた値が返されるキー
	 * @return マップが指定されたキーをマップする値
	 */
	public float getFloat(Object key);

	/**
	 * <P>
	 * 指定の float 値をマップ内の指定のキーと関連付けます。
	 * </P>
	 * @param key 指定された値が関連付けられるキー
	 * @param value 指定されたキーに関連付けられる値
	 */
	public void putFloat(Object key, float value);

	/**
	 * <P>
	 * マップが指定のキーをマップする値を Java プログラミング言語の int として取得します。
	 * </P>
	 * @param key 関連付けられた値が返されるキー
	 * @return マップが指定されたキーをマップする値
	 */
	public int getInt(Object key);

	/**
	 * <P>
	 * 指定の int 値をマップ内の指定のキーと関連付けます。
	 * </P>
	 * @param key 指定された値が関連付けられるキー
	 * @param value 指定されたキーに関連付けられる値
	 */
	public void putInt(Object key, int value);

	/**
	 * <P>
	 * マップが指定のキーをマップする値を Java プログラミング言語の long として取得します。
	 * </P>
	 * @param key 関連付けられた値が返されるキー
	 * @return マップが指定されたキーをマップする値
	 */
	public long getLong(Object key);

	/**
	 * <P>
	 * 指定の long 値をマップ内の指定のキーと関連付けます。
	 * </P>
	 * @param key 指定された値が関連付けられるキー
	 * @param value 指定されたキーに関連付けられる値
	 */
	public void putLong(Object key, long value);

	/**
	 * <P>
	 * マップが指定のキーをマップする値を Java プログラミング言語の Object として取得します。
	 * </P>
	 * @param key 関連付けられた値が返されるキー
	 * @return マップが指定されたキーをマップする値
	 */
	public Object getObject(Object key);

	/**
	 * <P>
	 * 指定の Object 値をマップ内の指定のキーと関連付けます。
	 * </P>
	 * @param key 指定された値が関連付けられるキー
	 * @param value 指定されたキーに関連付けられる値
	 */
	public void putObject(Object key, Object value);

	/**
	 * <P>
	 * マップが指定のキーをマップする値を Java プログラミング言語の short として取得します。
	 * </P>
	 * @param key 関連付けられた値が返されるキー
	 * @return マップが指定されたキーをマップする値
	 */
	public short getShort(Object key);

	/**
	 * <P>
	 * 指定の short 値をマップ内の指定のキーと関連付けます。
	 * </P>
	 * @param key 指定された値が関連付けられるキー
	 * @param value 指定されたキーに関連付けられる値
	 */
	public void putShort(Object key, short value);

	/**
	 * <P>
	 * マップが指定のキーをマップする値を Java プログラミング言語の String として取得します。
	 * </P>
	 * @param key 関連付けられた値が返されるキー
	 * @return マップが指定されたキーをマップする値
	 */
	public String getString(Object key);

	/**
	 * <P>
	 * 指定の String 値をマップ内の指定のキーと関連付けます。
	 * </P>
	 * @param key 指定された値が関連付けられるキー
	 * @param value 指定されたキーに関連付けられる値
	 */
	public void putString(Object key, String value);

	/**
	 * <P>
	 * マップが指定のキーをマップする値を java.util.List として取得します。
	 * </P>
	 * @param key 関連付けられた値が返されるキー
	 * @return マップが指定されたキーをマップする値
	 */
	public java.util.List getList(Object key);

	/**
	 * <P>
	 * 指定の java.util.List をマップ内の指定のキーと関連付けます。
	 * </P>
	 * @param key 指定された値が関連付けられるキー
	 * @param value 指定されたキーに関連付けられる値
	 */
	public void putList(Object key, java.util.List value);

	/**
	 * <P>
	 * マップが指定のキーをマップする値を java.util.Map として取得します。
	 * </P>
	 * @param key 関連付けられた値が返されるキー
	 * @return マップが指定されたキーをマップする値
	 */
	public java.util.Map getMap(Object key);

	/**
	 * <P>
	 * 指定の java.util.Map をマップ内の指定のキーと関連付けます。
	 * </P>
	 * @param key 指定された値が関連付けられるキー
	 * @param value 指定されたキーに関連付けられる値
	 */
	public void putMap(Object key, java.util.Map value);

}
