org.seasar.aptina.beans
注釈型 BeanState

@Target(value=TYPE)
@Retention(value=SOURCE)
@Documented
public @interface BeanState

JavaBean の状態を保持するクラスであることを示す注釈です．

Aptina Beans の提供する Annotation Processor (BeansProcessor) は， この注釈が付けられたクラス (以下「状態クラス」) のサブクラス (以下「Bean クラス」) を生成します． Bean クラスは，状態クラスに定義されたフィールドに対する getter/setter メソッドを持つ JavaBeans です．

この注釈が付けられる状態クラスは次のようなクラスでなければなりません．

• 通常のクラスであること (インタフェースやアノテーション，列挙は状態クラスにできません)．
• トップレベルのクラスであること (ネストしたクラスは状態クラスにできません)．
• public なクラスであること．
• final クラスではないこと．

プロパティ

状態クラスの次の条件を満たすフィールドが Bean クラスのプロパティとなります．

• static，private，public の修飾子が付けられていないこと．
• Property アノテーションで AccessType.NONE が指定されていないこと．

状態クラスのフィールドに Property アノテーションを付与し， Property.access() 要素で getter/setter をどのように生成するか指定することができます． Property.access() 要素の型は AccessType です．

AccessType の値	説明
AccessType.NONE	プロパティとしてアクセスしません (getter/setter とも生成されません)．
AccessType.READ_ONLY	参照のみ可能なプロパティです (getter のみ生成されます)．
AccessType.WRITE_ONLY	変更のみ可能なプロパティです (setter のみ生成されます)． フィールドが final の場合はエラーになります．
AccessType.READ_WRITE (デフォルト)	参照・変更とも可能なプロパティです (getter/setter とも生成されます)． フィールドが final の場合， setter は生成されません．

indexed プロパティ

配列型のプロパティには， 標準の getter/setter メソッドに加えて次のメソッドが生成されます．

• public <PropertyType> get<PropertyName>(int n)
• public void set<PropertyName>(int n, <PoerptyType> <propertyName>)

bound プロパティ

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 プロパティ

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)

コンストラクタ

状態クラスの非 private コンストラクタは Bean クラスに引き継がれます． 引き継がれるコンストラクタが一つもない場合はエラーとなります．

作成者:

koichik

任意要素の概要

boolean	boundProperties bound プロパティ (PropertyChangeListener) をサポートすることを示します．
boolean	constrainedProperties constrained プロパティ (VetoableChangeListener) をサポートすることを示します．

boundProperties

public abstract boolean boundProperties

bound プロパティ (PropertyChangeListener) をサポートすることを示します．

デフォルト:

false

constrainedProperties

public abstract boolean constrainedProperties

constrained プロパティ (VetoableChangeListener) をサポートすることを示します．

デフォルト:

false