org.mklab.tool.control.system.parameter
注釈型 Parameter

@Documented
@Retention(value=RUNTIME)
@Target(value=FIELD)
public @interface Parameter

システムのパラメータを表わすアノテーションです。

バージョン:

$Revision: 1.2 $, 2007/01/22

作成者:

koga

任意要素の概要

String	description パラメータの説明を返します。
boolean	internationalization パラメータの説明が国際化されているか判定します。
String	name パラメータの名前を返します。
QuantityType	quantity 量の型を返します。
SIunit[]	unit パラメータの単位を返します。
boolean	update パラメータの変更に伴い、システムの他のパラメータを更新するか判定します。

name

public abstract String name

パラメータの名前を返します。

戻り値:

パラメータの名前

デフォルト:

""

unit

public abstract SIunit[] unit

パラメータの単位を返します。

戻り値:

パラメータの単位

デフォルト:

org.mklab.tool.control.system.parameter.SIunit.undefined

quantity

public abstract QuantityType quantity

量の型を返します。

戻り値:

量の型

デフォルト:

org.mklab.tool.control.system.parameter.QuantityType.UNDEFINED

description

public abstract String description

パラメータの説明を返します。

戻り値:

パラメータの説明

デフォルト:

""

update

public abstract boolean update

パラメータの変更に伴い、システムの他のパラメータを更新するか判定します。 パラメータの更新機能を有効にするには、ParameterUpdatorインターフェースを実装する必要があります。

戻り値:

パラメータの変更に伴い、システムの他のパラメータを更新するならばtrue、そうでなければfalse

デフォルト:

false

internationalization

public abstract boolean internationalization

パラメータの説明が国際化されているか判定します。 外部化(国際化)されたパラメータの説明を取得可能にするには、StringExternalizableインターフェースを実装する必要があります。

戻り値:

パラメータの説明が国際化されていればtrue、そうでなければfalse

デフォルト:

false