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 を使って検索されます。
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 - 新しい読み込みメソッド

例外:

IntrospectionException

getWriteMethod

public Method getWriteMethod()

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

戻り値:

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

setWriteMethod

public void setWriteMethod(Method writeMethod)
                    throws IntrospectionException

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

パラメータ:

writeMethod - 新しい書き込みメソッド

例外:

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