java.beans
クラス PropertyDescriptor

java.lang.Object
  |
  +--java.beans.FeatureDescriptor
        |
        +--java.beans.PropertyDescriptor

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

IndexedPropertyDescriptor

public class PropertyDescriptor

extends FeatureDescriptor

PropertyDescriptor は、アクセス用メソッドのペアを介して Java Bean が公開するプロパティを 1 つ記述します。

コンストラクタの概要

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

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

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

メソッドの概要

Class	getPropertyEditorClass() このプロパティに対して登録されている明示的な PropertyEditor クラスを取得します。
Class	getPropertyType() プロパティの Class オブジェクトを取得します。
Method	getReadMethod() プロパティ値の読み込みに使うメソッドを取得します。
Method	getWriteMethod() プロパティ値の書き込みに使うメソッドを取得します。
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 getter) プロパティ値の読み込みに使うメソッドを設定します。
void	setWriteMethod(Method setter) プロパティ値の書き込みに使うメソッドを設定します。

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

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

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

clone, equals, finalize, getClass, hashCode, 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 getterName,
                          String setterName)
                   throws IntrospectionException

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

パラメータ:

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

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

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

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

例外:

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

PropertyDescriptor

public PropertyDescriptor(String propertyName,
                          Method getter,
                          Method setter)
                   throws IntrospectionException

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

パラメータ:

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

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

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

例外:

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

メソッドの詳細

getPropertyType

public Class getPropertyType()

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

戻り値:

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

ReadMethod が返す型

getReadMethod

public Method getReadMethod()

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

戻り値:

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

setReadMethod

public void setReadMethod(Method getter)
                   throws IntrospectionException

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

パラメータ:

getter - 新しい読み込み用メソッド

getWriteMethod

public Method getWriteMethod()

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

戻り値:

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

setWriteMethod

public void setWriteMethod(Method setter)
                    throws IntrospectionException

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

パラメータ:

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

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 クラス。通常は null を返し、特別なエディタが登録されていないため、PropertyEditorManager を使って適切な PropertyEditor を検索するべきであることを示す