プロパティ
状態クラスの次の条件を満たすフィールドが Bean クラスのプロパティとなります．
static，private，publicの修飾子が付けられていないこと．PropertyアノテーションでAccessType#NONEが指定されていないこと．
状態クラスのプロパティが配列型の場合， Bean クラスにはインデックス付きの getter/setter メソッドが生成されます．
状態クラスのフィールドに
Property
アノテーションを付与し，
access
要素で getter/setter をどのように生成するか指定することができます．
access
要素の型は
AcessType
です．
AccessType
の値
|
説明 |
|---|---|
NONE |
プロパティとしてアクセスしません (getter/setter とも生成されません)． |
READ_ONLY |
参照のみ可能なプロパティです (getter のみ生成されます)． |
WRITE_ONLY |
変更のみ可能なプロパティです (setter のみ生成されます)．
フィールドが
final
の場合はエラーになります．
|
READ_WRITE(デフォルト) |
参照・変更とも可能なプロパティです (getter/setter とも生成されます)．
フィールドが
final
の場合， setter は生成されません．
|
indexed プロパティ
配列型のプロパティには， 標準の getter/setter メソッドに加えて次のメソッドが生成されます．
public <PropertyType> get<PropertyName>(int n)public void set<PropertyName>(int n, <PoerptyType> <propertyName>)
bound プロパティ
BeanState
アノテーションの
boundProperties
要素に
true
を指定すると bound プロパティ (
PropertyChangeListener
) がサポートされ， 次のメソッドが生成されます．
public void addPropertyChangeListener(PropertyChangeListener listener)public void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)public void removePropertyChangeListener(PropertyChangeListener listener)public void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
変更可能なプロパティごとに次のメソッドが生成されます．
public void add<PropertyName>Listener(PropertyChangeListener listener)public void remove<PropertyName>Listener(PropertyChangeListener listener)
constrained プロパティ
BeanState
アノテーションの
constrainedProperties
要素に
true
を指定すると constrained プロパティ (
VetoableChangeListener
) がサポートされ， 次のメソッドが生成されます．
public void addVetoableChangeListener(VetoableChangeListener listener)public void addVetoableChangeListener(String propertyName, VetoableChangeListener listener)public void removeVetoableChangeListener(VetoableChangeListener listener)public void removeVetoableChangeListener(String propertyName, VetoableChangeListener listener)
変更可能なプロパティごとに次のメソッドが生成されます．
public void add<PropertyName>Listener(VetoableChangeListener listener)public void remove<PropertyName>Listener(VetoableChangeListener listener)
Javadocコメント
Bean クラスの getter/setter メソッドには Javadoc コメントが付けられます． 状態クラスのフィールドに Javadoc コメントが付けられている場合は， その内容を元に Bean クラスのメソッドに付けられる Javadoc コメントが作成されます． 例えば次の状態クラスのフィールドから
/** 従業員名 */ String employeeName;
次のようなコメントが生成されます．
/**
* {@literal 従業員名} を返します．
*
* @return {@literal 従業員名}
*/
public String getEmployeeName {
return employeeName;
}
このように， 状態クラスのフィールドに付ける Javadoc コメントは， 1 行でプロパティを表す名詞形にすることを推奨します．
状態クラスのフィールドに Javadoc コメントが付けられていない場合は， フィールド名を元に Bean クラスのメソッドに付けられる Javadoc コメントが作成されます． 例えば次の状態クラスのフィールドから
String employeeName;
次のようなコメントが生成されます．
/**
* {@literal employeeName} を返します．
*
* @return {@literal employeeName}
*/
public String getEmployeeName {
return employeeName;
}