/*
このファイルの中身は、NTT オープンソースライセンス　バージョン 1.0（「本
契約」という）の適用を受けます。
本契約を遵守しない限り、このファイルを使用してはなりません。
本契約のコピーは、次のＵＲＬから入手できます。
【配布サイトのURL】 http://www.oss.ecl.ntt.co.jp/lms/

本契約に基づき頒布されるソフトウェアは、現状のまま、明示又は黙示のあらゆ
る種類の保証なしで、頒布されます。本契約に基づく権利及び制限を律する特定
の文言については、本契約を参照してください。

「オリジナルコード」は、 NTT Cyber Space Laboratories Code です。 
「オリジナルコード」の「初期開発者」は、日本電信電話株式会社です。  
日本電信電話株式会社により創作された部分は、Copyright (C) 2004 
日本電信電話株式会社 です。
全ての権利が留保されます。 
「コントリビュータ」：_____________________________________ 


The contents of this file are subject to the NTT Opensource License
Version 1.0 (the License); you may not use this file except in
compliance with the License. You may obtain a copy of the License at
【配布サイトのURL】 http://www.oss.ecl.ntt.co.jp/lms/

Software distributed under the License is distributed on an AS IS
basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
License for the specific language governing rights and limitations
under the License.

The Original Code is NTT Cyber Space Laboratories Code .

The Initial Developer of the Original Code is NIPPON TELEGRAPH AND 
TELEPHONE CORPORATION.
Portions created by the NIPPON TELEGRAPH AND TELEPHONE CORPORATION 
are Copyright (C) 2004 NIPPON TELEGRAPH AND TELEPHONE CORPORATION. 
All Rights Reserved.

Contributor(s) ______________________________________.
*/
package jp.co.ntt.lms.installer.core;

import java.util.Properties;


/**
 * プロパティファイルを上書きする項目についてまとめる値インタフェース。
 * @author T.Nishiki
 */
public interface InstallerOverwritePropertiesValue
		extends InstallerActionValue {
	/**
	 * 上書き対象のプロパティファイルを取得するためのキーを戻します。<br>
	 * 上書き対象のプロパティファイルについて、インストール設定ファイルから
	 * 取得するためのキーを戻します。
	 * @return 上書き対象のプロパティファイル取得用のキー文字列。
	 */
	String getTargetFileKey();

	/**
	 * 上書き対象のプロパティファイル(Native)を取得するためのキーを戻します。<br>
	 * 上書き対象のプロパティファイルを生成するための平文について、
	 * インストール設定ファイルから取得するためのキーを戻します。
	 * @return 上書き対象のプロパティファイル取得用のキー文字列。
	 *          Nativeファイルがない場合はnullを戻します。
	 */
	String getTargetNativeFileKey();

	/**
	 * 上書きするプロパティ一覧を戻します。<br>
	 * @param values インストーラ共通データ・オブジェクト。
	 * @return 「上書きするプロパティのキー」と「その上書き後の値」を
	 *          組とするPropertiesを戻します。
	 *          上書きする対象がない場合は空要素のPropertiesを戻す実装として下さい。
	 * @throws InstallerException 処理中にエラーが発生した場合。
	 */
	Properties getOverwrittenProperties(InstallerValues values)
			throws InstallerException;
}
