クラスPropertyDescriptor

java.lang.Object
java.beans.FeatureDescriptor
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オブジェクトを引数に取ります。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    PropertyEditor
    createPropertyEditor(Object bean)
    現在のプロパティ・エディタ・クラスを使用してプロパティ・エディタのインスタンスを構築します。
    boolean
    equals(Object obj)
    このPropertyDescriptorを指定されたオブジェクトと比較します。
    Class<?>
    getPropertyEditorClass()
    このプロパティの明示的な登録済みPropertyEditorクラスを取得します。
    Class<?>
    getPropertyType()
    プロパティのJava型情報を返します。
    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)
    プロパティ値の書込みに使用するメソッドを設定します。

    クラスで宣言されたメソッド FeatureDescriptor

    attributeNames, getDisplayName, getName, getShortDescription, getValue, isExpert, isHidden, isPreferred, setDisplayName, setExpert, setHidden, setName, setPreferred, setShortDescription, setValue, toString
    修飾子と型
    メソッド
    説明
    Enumeration<String>
    attributeNames()
    この機能のロケールに依存しない名前の列挙を取得します。
    String
    getDisplayName()
    この機能のローカライズされた表示名を取得します。
    String
    getName()
    この機能のプログラム名を取得します。
    String
    getShortDescription()
    この機能の短い説明を取得します。
    Object
    getValue(String attributeName)
    この機能を使用して名前付きの属性を取得します。
    boolean
    isExpert()
    「エキスパート」フラグは、上級者向けの機能を一般ユーザー向けの機能と区別するために使用されます。
    boolean
    isHidden()
    「隠し」フラグは、ツールだけで使用され、ユーザーには提供されない機能を識別するために使用されます。
    boolean
    isPreferred()
    「優先」フラグは、ユーザーへ表示する特に重要である機能を識別するために使用されます。
    void
    setDisplayName(String displayName)
    この機能のローカライズされた表示名を設定します。
    void
    setExpert(boolean expert)
    「エキスパート」フラグは、上級者向けの機能を一般ユーザー向けの機能と区別するために使用されます。
    void
    setHidden(boolean hidden)
    「隠し」フラグは、ツールだけで使用され、ユーザーには提供されない機能を識別するために使用されます。
    void
    setName(String name)
    この機能のプログラム名を設定します。
    void
    setPreferred(boolean preferred)
    「優先」フラグは、ユーザーへ表示する特に重要である機能を識別するために使用されます。
    void
    setShortDescription(String text)
    短い説明的な文字列を機能と関連付けることができます。
    void
    setValue(String attributeName, Object value)
    名前付きの属性をこの機能と関連付けます。
    String
    toString()
    オブジェクトの文字列表現を返します。

    クラスオブジェクトで宣言されたメソッド

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    修飾子と型
    メソッド
    説明
    protected Object
    clone()
    このオブジェクトのコピーを作成して、返します。
    protected void
    finalize()
    削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
    最終決定は非推奨であり、将来のリリースで削除される可能性があります。
    final Class<?>
    getClass()
    このObjectの実行時クラスを返します。
    final void
    notify()
    このオブジェクトのモニターで待機中のスレッドを1つ再開します。
    final void
    notifyAll()
    このオブジェクトのモニターで待機中のすべてのスレッドを再開します。
    final void
    wait()
    現在のスレッドが目覚めるまで待機します。通常、notifiedまたはinterruptedです。
    final void
    wait(long timeoutMillis)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。
    final void
    wait(long timeoutMillis, int nanos)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。

  • コンストラクタの詳細

    • 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
      関連項目:

    • hashCode

      public int hashCode()
      オブジェクトのハッシュ・コード値を返します。 詳細は、Object.hashCode()を参照してください。
      オーバーライド:
      hashCode、クラスObject
      戻り値:
      このオブジェクトのハッシュ・コード値。
      導入されたバージョン:
      1.5
      関連項目: