モジュール java.desktop
パッケージ java.beans

クラスPropertyDescriptor

  • 直系の既知のサブクラス:
    IndexedPropertyDescriptor
    public class PropertyDescriptor
extends FeatureDescriptor
    PropertyDescriptorは、Java Beanが一対のアクセス用メソッドを使ってエクスポートする単一のプロパティを記述します。
    導入されたバージョン:
    1.1

    • コンストラクタのサマリー

      コンストラクタ 
      コンストラクタ 説明
      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オブジェクトを引数に取ります。

    • コンストラクタの詳細

      • 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()
        プロパティのJava型情報を返します。 ClassオブジェクトがintなどのプリミティブなJava型を記述する場合があります。 この型は、読込みメソッドによって返されるか、書込みメソッドのパラメータ型として使用されます。 この型がインデックスなしアクセスをサポートしないインデックス付きプロパティである場合は、nullが返されます。
        戻り値:
        Java型情報を表すClassオブジェクト(型を判別できない場合はnull)

      • getReadMethod

        public Method getReadMethod()
        プロパティ値の読込みに使用するメソッドを取得します。
        戻り値:
        プロパティ値の読込みに使用するメソッド。 プロパティを読み込めない場合はnull。

      • setReadMethod

        public void setReadMethod​(Method readMethod)
                   throws IntrospectionException
        プロパティ値の読込みに使用するメソッドを設定します。
        パラメータ:
        readMethod - 新しい読込みメソッド。
        例外:
        IntrospectionException - 読込みメソッドが無効な場合
        導入されたバージョン:
        1.2

      • getWriteMethod

        public Method getWriteMethod()
        プロパティ値の書込みに使用するメソッドを取得します。
        戻り値:
        プロパティ値の書込みに使用するメソッド。 プロパティを書き込めない場合はnull。

      • setWriteMethod

        public void setWriteMethod​(Method writeMethod)
                    throws IntrospectionException
        プロパティ値の書込みに使用するメソッドを設定します。
        パラメータ:
        writeMethod - 新しい書込みメソッド。
        例外:
        IntrospectionException - 書込みメソッドが無効な場合
        導入されたバージョン:
        1.2

      • 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は同等です。
        オーバーライド:
        equals 、クラス:  Object
        パラメータ:
        obj - 比較対象の参照オブジェクト。
        戻り値:
        このオブジェクトがobj引数と同じである場合はtrue、それ以外の場合はfalse。
        導入されたバージョン:
        1.4
        関連項目:
        Object.hashCode()、HashMap