java.beans
クラス PropertyDescriptor

java.lang.Object
  java.beans.FeatureDescriptor
      java.beans.PropertyDescriptor

直系の既知のサブクラス:

IndexedPropertyDescriptor

public class PropertyDescriptor
extends FeatureDescriptor

PropertyDescriptor は、Java Bean が一対のアクセス用メソッドを使ってエクスポートする単一のプロパティを記述します。

コンストラクタの概要

PropertyDescriptor(String propertyName, Class<?> beanClass)
アクセス用メソッド getFoo および setFoo を使って、標準の Java 規約に準拠しているプロパティの PropertyDescriptor を構築します。

PropertyDescriptor(String propertyName, Class<?> beanClass, String readMethodName, String writeMethodName)
このコンストラクタは、単純なプロパティ名と、プロパティの読み込みおよび書き込み用のメソッド名を引数に取ります。

PropertyDescriptor(String propertyName, Method readMethod, Method writeMethod)
このコンストラクタは、単純なプロパティ名と、プロパティの読み込みおよび書き込み用の Method オブジェクトを引数に取ります。

メソッドの概要

PropertyEditor	createPropertyEditor(Object bean) 現在のプロパティエディタクラスを使用して、プロパティエディタのインスタンスを構築します。
boolean	equals(Object obj) PropertyDescriptor と指定されたオブジェクトを照合します。
Class<?>	getPropertyEditorClass() このプロパティの明示的な登録済み PropertyEditor クラスを取得します。
Class<?>	getPropertyType() プロパティの Class オブジェクトを取得します。
Method	getReadMethod() プロパティ値の読み込みに使用するメソッドを取得します。
Method	getWriteMethod() プロパティ値の書き込みに使用するメソッドを取得します。
int	hashCode() このオブジェクトのハッシュコード値を返します。
boolean	isBound() バウンドプロパティを更新し、プロパティの変更時に PropertyChange イベントがトリガされるようにします。
boolean	isConstrained() 制約プロパティの更新を試み、プロパティの変更時に VetoableChange イベントがトリガされるようにします。
void	setBound(boolean bound) バウンドプロパティを更新し、プロパティの変更時に PropertyChange イベントがトリガされるようにします。
void	setConstrained(boolean constrained) 制約プロパティの更新を試み、プロパティの変更時に VetoableChange イベントがトリガされるようにします。
void	setPropertyEditorClass(Class<?> propertyEditorClass) 通常、PropertyEditor は PropertyEditorManager を使って検索されますが、何らかの理由により特定の PropertyEditor を指定プロパティに関連付けたい場合は、このメソッドを使用できます。
void	setReadMethod(Method readMethod) プロパティ値の読み込みに使用するメソッドを設定します。
void	setWriteMethod(Method writeMethod) プロパティ値の書き込みに使用するメソッドを設定します。

クラス java.beans.FeatureDescriptor から継承されたメソッド

attributeNames, getDisplayName, getName, getShortDescription, getValue, isExpert, isHidden, isPreferred, setDisplayName, setExpert, setHidden, setName, setPreferred, setShortDescription, setValue

クラス java.lang.Object から継承されたメソッド

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

PropertyDescriptor

public PropertyDescriptor(String propertyName,
                          Class<?> beanClass)
                   throws IntrospectionException

アクセス用メソッド getFoo および setFoo を使って、標準の Java 規約に準拠しているプロパティの PropertyDescriptor を構築します。引数名が fred であれば、書き込み用メソッドは setFred、読み込み用メソッドは getFred (boolean プロパティでは isFred) になります。プロパティ名は必ず小文字で始まりますが、メソッド名では先頭文字が大文字になることに注意してください。

パラメータ:

propertyName - プロパティのプログラム名

beanClass - ターゲット bean の Class オブジェクト。たとえば、sun.beans.OurButton.class

例外:

IntrospectionException - イントロスペクション中に例外が発生した場合

PropertyDescriptor

public PropertyDescriptor(String propertyName,
                          Class<?> beanClass,
                          String readMethodName,
                          String writeMethodName)
                   throws IntrospectionException

このコンストラクタは、単純なプロパティ名と、プロパティの読み込みおよび書き込み用のメソッド名を引数に取ります。

パラメータ:

propertyName - プロパティのプログラム名

beanClass - ターゲット bean の Class オブジェクト。たとえば、sun.beans.OurButton.class

readMethodName - プロパティ値の読み込みに使用するメソッド名。プロパティが書き込み専用の場合は null

writeMethodName - プロパティ値の書き込みに使用するメソッド名。プロパティが読み取り専用の場合は null

例外:

IntrospectionException - イントロスペクション中に例外が発生した場合

PropertyDescriptor

public PropertyDescriptor(String propertyName,
                          Method readMethod,
                          Method writeMethod)
                   throws IntrospectionException

このコンストラクタは、単純なプロパティ名と、プロパティの読み込みおよび書き込み用の Method オブジェクトを引数に取ります。

パラメータ:

propertyName - プロパティのプログラム名

readMethod - プロパティ値の読み込みに使用するメソッド。プロパティが書き込み専用の場合は null

writeMethod - プロパティ値の書き込みに使用するメソッド。プロパティが読み取り専用の場合は null

例外:

IntrospectionException - イントロスペクション中に例外が発生した場合

メソッドの詳細

getPropertyType

public Class<?> getPropertyType()

プロパティの Class オブジェクトを取得します。

戻り値:

プロパティの Java 型情報。Class オブジェクトは、int などの組み込みの Java 型を記述する場合があるので注意する。インデックスなしアクセスをサポートしないインデックス付きプロパティの場合、結果は null になる

ReadMethod が返す型

getReadMethod

public Method getReadMethod()

プロパティ値の読み込みに使用するメソッドを取得します。

戻り値:

プロパティ値の読み込みに使用するメソッド。プロパティを読み込めない場合は null

setReadMethod

public void setReadMethod(Method readMethod)
                   throws IntrospectionException

プロパティ値の読み込みに使用するメソッドを設定します。

パラメータ:

readMethod - 新しい read メソッド

例外:

IntrospectionException

getWriteMethod

public Method getWriteMethod()

プロパティ値の書き込みに使用するメソッドを取得します。

戻り値:

プロパティ値の書き込みに使用するメソッド。プロパティを書き込めない場合は null

setWriteMethod

public void setWriteMethod(Method writeMethod)
                    throws IntrospectionException

プロパティ値の書き込みに使用するメソッドを設定します。

パラメータ:

writeMethod - 新しい write メソッド

例外:

IntrospectionException

isBound

public boolean isBound()

バウンドプロパティを更新し、プロパティの変更時に PropertyChange イベントがトリガされるようにします。

戻り値:

バウンドプロパティの場合は true

setBound

public void setBound(boolean bound)

バウンドプロパティを更新し、プロパティの変更時に PropertyChange イベントがトリガされるようにします。

パラメータ:

bound - バウンドプロパティの場合は true

isConstrained

public boolean isConstrained()

制約プロパティの更新を試み、プロパティの変更時に VetoableChange イベントがトリガされるようにします。

戻り値:

制約プロパティの場合は true

setConstrained

public void setConstrained(boolean constrained)

制約プロパティの更新を試み、プロパティの変更時に VetoableChange イベントがトリガされるようにします。

パラメータ:

constrained - 制約プロパティの場合は true

setPropertyEditorClass

public void setPropertyEditorClass(Class<?> propertyEditorClass)

通常、PropertyEditor は PropertyEditorManager を使って検索されますが、何らかの理由により特定の PropertyEditor を指定プロパティに関連付けたい場合は、このメソッドを使用できます。

パラメータ:

propertyEditorClass - PropertyEditor の Class

getPropertyEditorClass

public Class<?> getPropertyEditorClass()

このプロパティの明示的な登録済み PropertyEditor クラスを取得します。

戻り値:

このプロパティの明示的な登録済み PropertyEditor クラス。通常は、特別なエディタが登録されていないため PropertyEditorManager を使って適切な PropertyEditor を検索するべきであることを示す null が返される

createPropertyEditor

public PropertyEditor createPropertyEditor(Object bean)

現在のプロパティエディタクラスを使用して、プロパティエディタのインスタンスを構築します。

プロパティエディタクラスに Object 引数を取る public コンストラクタがある場合は、bean パラメータを引数として使用して呼び出されます。それ以外の場合は、デフォルトのコンストラクタが呼び出されます。

パラメータ:

bean - ソース オブジェクト

戻り値:

プロパティエディタインスタンス。プロパティエディタが定義されていない場合、または作成できない場合は null

導入されたバージョン:

1.5

equals

public boolean equals(Object obj)

PropertyDescriptor と指定されたオブジェクトを照合します。両者が等価である場合、true を返します。読み込み、書き込み、プロパティの型、プロパティエディタ、およびフラグが等しければ、2 つの PropertyDescriptor は等価です。

オーバーライド:

クラス Object 内の equals

パラメータ:

obj - 比較対象の参照オブジェクト

戻り値:

obj 引数に指定されたオブジェクトとこのオブジェクトが等しい場合は true、そうでない場合は false

導入されたバージョン:

1.4

関連項目:

Object.hashCode(), Hashtable

hashCode

public int hashCode()

このオブジェクトのハッシュコード値を返します。完全な説明については、Object.hashCode() を参照してください。

オーバーライド:

クラス Object 内の hashCode

戻り値:

このオブジェクトのハッシュコード値

導入されたバージョン:

1.5

関連項目:

Object.equals(java.lang.Object), Hashtable