パッケージ org.iplass.mtp.prefs

クラス Preference

java.lang.Object
org.iplass.mtp.prefs.Preference
すべての実装されたインタフェース:
java.io.Serializable, Definition
直系の既知のサブクラス:
PreferenceSet
public class Preference
extends java.lang.Object
implements Definition
テナント単位に定義可能な汎用の設定を表す。 name、valueのペアを持つ。 また、この設定を元に実行時に初期化、インスタンス化されるruntimeClassを定義することが可能。 runtimeClassは、この設定の読み込み時に1度だけ初期化され、テナントが有効の間、同一のインスタンスが保持される。 ただし、テナント起動中に、Preferenceの変更・再読み込みが発生した場合は、以前のruntimeClassのインスタンスが破棄（GC対象に）され、 新たなインスタンスが生成され初期化される。
runtimeClassはデフォルトコンストラクタを持つ、POJOもしくはPreferenceAwareを実装したクラス。
POJOの場合は、次の形でPreferenceの値が設定される。
  • Preference:POJOのname,valueプロパティに値をセット。その名前のプロパティがない場合は、セットしない。
  • PreferenceSet:上記に加えて、subSetで指定されている各Preferenceのnameをプロパティ名としてvalueを値としてセット。
PreferenceAware実装クラスの場合は、初期化時にinitializeメソッドが呼び出される。 runtimeClassにはutilityClassとして作成されたGroovyクラスの指定も可能。 utilityClassの場合は、そのクラスはGroovyコード内では可視であるが、javaで実装されたクラスからはGroovyObjectとしてのみ参照可能。
関連項目:
PreferenceAware, 直列化された形式

  • コンストラクタの概要

    コンストラクタ 
    コンストラクタ 説明
    Preference()
    コンストラクタ。
    Preference​(java.lang.String name, java.lang.String value)
    コンストラクタ。
    Preference​(java.lang.String name, java.lang.String value, java.lang.String runtimeClassName)
    コンストラクタ。

  • メソッドの概要

    修飾子とタイプ メソッド 説明
    java.lang.String getDescription()
    概要を取得します。
    java.lang.String getDisplayName()
    表示名を取得します。
    java.lang.String getName()
    名前を取得します。
    java.lang.String getRuntimeClassName()  
    java.lang.String getValue()  
    java.lang.String getValue​(java.lang.String defaultValue)
    設定値を取得する。
    void setDescription​(java.lang.String description)
    概要を設定します。
    void setDisplayName​(java.lang.String displayName)
    表示名を設定します。
    void setName​(java.lang.String name)
    名前を設定します。
    void setRuntimeClassName​(java.lang.String runtimeClassName)  
    void setValue​(java.lang.String value)  

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

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

  • コンストラクタの詳細

    • Preference

      public Preference()
      コンストラクタ。

    • Preference

      public Preference​(java.lang.String name, java.lang.String value)
      コンストラクタ。
      パラメータ:
      name - 設定名
      value - 設定値

    • Preference

      public Preference​(java.lang.String name, java.lang.String value, java.lang.String runtimeClassName)
      コンストラクタ。
      パラメータ:
      name - 設定名
      value - 設定値
      runtimeClassName - runtimeClass名

  • メソッドの詳細

    • getName

      public java.lang.String getName()
      インタフェースからコピーされた説明: Definition
      名前を取得します。
      定義:
      getName インタフェース内 Definition
      戻り値:
      名前

    • setName

      public void setName​(java.lang.String name)
      インタフェースからコピーされた説明: Definition
      名前を設定します。
      定義:
      setName インタフェース内 Definition
      パラメータ:
      name - 名前

    • getValue

      public java.lang.String getValue()

    • setValue

      public void setValue​(java.lang.String value)

    • getRuntimeClassName

      public java.lang.String getRuntimeClassName()

    • setRuntimeClassName

      public void setRuntimeClassName​(java.lang.String runtimeClassName)

    • getDisplayName

      public java.lang.String getDisplayName()
      インタフェースからコピーされた説明: Definition
      表示名を取得します。
      定義:
      getDisplayName インタフェース内 Definition
      戻り値:
      表示名

    • setDisplayName

      public void setDisplayName​(java.lang.String displayName)
      インタフェースからコピーされた説明: Definition
      表示名を設定します。
      定義:
      setDisplayName インタフェース内 Definition
      パラメータ:
      displayName - 表示名

    • getDescription

      public java.lang.String getDescription()
      インタフェースからコピーされた説明: Definition
      概要を取得します。
      定義:
      getDescription インタフェース内 Definition
      戻り値:
      概要

    • setDescription

      public void setDescription​(java.lang.String description)
      インタフェースからコピーされた説明: Definition
      概要を設定します。
      定義:
      setDescription インタフェース内 Definition
      パラメータ:
      description - 概要

    • getValue

      public java.lang.String getValue​(java.lang.String defaultValue)
      設定値を取得する。 もし、設定値が未設定の場合、defaultValueを返却する。
      パラメータ:
      defaultValue -
      戻り値: