パッケージ jp.go.nict.langrid.commons.parameter

パラメータローディングフレームワーク。

参照先:
説明

クラスの概要

CmdArgParameterContext	コマンドライン引数を対象にしたParameterContext。
ParameterContext	パラメータを取得するクラスの基底クラス。
ParameterLoader	パラメータをロードする。
PropertiesParameterContext	Propertiesクラスを利用したParameterContext。
StringMapParameterContext	Mapクラスを利用したParameterContext。

例外の概要

ParameterRequiredException

@Parameter(required=true)が指定されているフィールドの読込に失敗した場合に発生する例外。

パッケージ jp.go.nict.langrid.commons.parameter の説明

パラメータローディングフレームワーク。 このパッケージには、パラメータローディングを行うためのクラス群が含まれています。 パラメータを読み込むには、以下の手順を行います。

1. 各パラメータを読み込むフィールドをフレームワークに認識させる(コーディング時)。
   • @Parameterアノテーションを付加する。
   • 又は、フィールドを保持するクラスに@ParameterConfig(loadAllFields=true)を付加する。
2. ParameterContextを取得する(実行時)。
   • PropertiesParameterContextを使う。
   • 又は、各環境に合わせたParameterContextを実装する。
3. ParameterLoaderを使用してパラメータを読み込む(実行時)。

例1:

class Bean{
        @Parameter
        private int parameter1;
        private String parameter2;
};
Bean b = new Bean();
// parameter1が読み込まれます。parameter2には何も行いません。
ParameterLoader.load(b, context);

例2:

@ParameterConfig(loadAllFields=true)
class Bean{
        private int parameter1;
        private String parameter2;
};
Bean b = new Bean();
// parameter1とparameter2が読み込まれます。
ParameterLoader.load(b, context);

例3:

@ParameterConfig(prefix="p.")
class Bean{
        @Parameter
        private int parameter1;
};
Bean b = new Bean();
// "p.parameter1"という名前のパラメータがparameter1に読み込まれます。
ParameterLoader.load(b, context);

関連項目:

ParameterContext, ParameterLoader, PropertiesParameterContext