クラス Constants

java.lang.ObjectSE
org.springframework.core.Constants

@DeprecatedSE(since="6.1") public class Constants extends ObjectSE
使用すべきではありません。
6.1 以来、代替はありません。代わりに列挙型、マップ、同様のカスタムソリューションを使用してください
このクラスを使用して、public static final メンバーの定数定義を含む他のクラスを解析できます。このクラスの asXXXX メソッドを使用すると、これらの定数値に文字列名を介してアクセスできます。

public static final int CONSTANT1 = 66; を含むクラス Foo を検討します。Foo.class をラップするこのクラスのインスタンスは、引数 "CONSTANT1" を指定すると、asNumber メソッドから定数値 66 を返します。

このクラスは PropertyEditors での使用に最適であり、定数自体と同じ名前を認識できるようにし、独自のマッピングの維持から解放します。

導入:
16.03.2003
作成者:
Rod Johnson, Juergen Hoeller
  • ネストされたクラスの要約

    ネストされたクラス
    修飾子と型
    クラス
    説明
    static class
    使用すべきではありません。
    Constants クラスが無効な定数名を要求されたときにスローされる例外。
  • コンストラクターの概要

    コンストラクター
    コンストラクター
    説明
    Constants(ClassSE<?> clazz)
    使用すべきではありません。
    指定されたクラスをラップする新しい定数コンバータークラスを作成します。
  • 方法の概要

    修飾子と型
    メソッド
    説明
    使用すべきではありません。
    Number にキャストされた定数値を返します。
    使用すべきではありません。
    指定された文字列 (大文字または小文字を受け入れます) を解析し、分析しているクラスの定数フィールドの名前である場合は、適切な値を返します。
    使用すべきではありません。
    定数値を文字列として返します。
    final StringSE
    使用すべきではありません。
    分析されたクラスの名前を返します。
    protected final MapSE<StringSE,ObjectSE>
    使用すべきではありません。
    フィールドキャッシュをサブクラス(String フィールド名からオブジェクト値へのマップ)に公開します。
    使用すべきではありません。
    指定された定数グループのすべての名前を返します。
    使用すべきではありません。
    指定された Bean プロパティ名の定数グループのすべての名前を返します。
    使用すべきではありません。
    指定された定数グループのすべての名前を返します。
    final int
    使用すべきではありません。
    公開されている定数の数を返します。
    使用すべきではありません。
    指定した定数グループのすべての値を返します。
    使用すべきではありません。
    指定された Bean プロパティ名の定数グループのすべての値を返します。
    使用すべきではありません。
    指定した定数グループのすべての値を返します。
    使用すべきではありません。
    指定された Bean プロパティ名を定数名のプレフィックスに変換します。
    toCode(ObjectSE value, @Nullable StringSE namePrefix)
    使用すべきではありません。
    指定された定数グループ内で指定された値を検索します。
    toCodeForProperty(ObjectSE value, StringSE propertyName)
    使用すべきではありません。
    指定された Bean プロパティ名の定数グループ内で指定された値を検索します。
    使用すべきではありません。
    指定された定数グループ内で指定された値を検索します。

    クラス ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
  • コンストラクターの詳細

    • Constants

      public Constants(ClassSE<?> clazz)
      使用すべきではありません。
      指定されたクラスをラップする新しい定数コンバータークラスを作成します。

      型に関係なく、すべてのパブリック static final 変数が公開されます。

      パラメーター:
      clazz - 分析するクラス
      例外:
      IllegalArgumentExceptionSE - 提供された clazz が null の場合
  • メソッドの詳細

    • getClassName

      public final StringSE getClassName()
      使用すべきではありません。
      分析されたクラスの名前を返します。
    • getSize

      public final int getSize()
      使用すべきではありません。
      公開されている定数の数を返します。
    • getFieldCache

      protected final MapSE<StringSE,ObjectSE> getFieldCache()
      使用すべきではありません。
      フィールドキャッシュをサブクラス(String フィールド名からオブジェクト値へのマップ)に公開します。
    • asNumber

      public NumberSE asNumber(StringSE code) throws Constants.ConstantException
      使用すべきではありません。
      Number にキャストされた定数値を返します。
      パラメーター:
      code - フィールドの名前 (非 null)
      戻り値:
      数値
      例外:
      Constants.ConstantException - フィールド名が見つからなかった場合、または型が Number と互換性がない場合
      関連事項:
    • asString

      public StringSE asString(StringSE code) throws Constants.ConstantException
      使用すべきではありません。
      定数値を文字列として返します。
      パラメーター:
      code - フィールドの名前 (非 null)
      戻り値:
      文字列値は、文字列でなくても機能します(toString() を呼び出します)。
      例外:
      Constants.ConstantException - フィールド名が見つからなかった場合
      関連事項:
    • asObject

      public ObjectSE asObject(StringSE code) throws Constants.ConstantException
      使用すべきではありません。
      指定された文字列 (大文字または小文字を受け入れます) を解析し、分析しているクラスの定数フィールドの名前である場合は、適切な値を返します。
      パラメーター:
      code - フィールドの名前 (非 null)
      戻り値:
      オブジェクト値
      例外:
      Constants.ConstantException - そのようなフィールドがない場合
    • getNames

      public SetSE<StringSE> getNames(@Nullable StringSE namePrefix)
      使用すべきではありません。
      指定された定数グループのすべての名前を返します。

      このメソッドは、定数が定数値の標準 Java 規則(つまり、すべて大文字)に従って命名されていることを前提としていることに注意してください。提供された namePrefix は、このメソッドのメインロジックが開始される前に大文字になります(ロケールに依存しないメソッドで)。

      パラメーター:
      namePrefix - 検索する定数名のプレフィックス (null の場合があります)
      戻り値:
      定数名のセット
    • getNamesForProperty

      public SetSE<StringSE> getNamesForProperty(StringSE propertyName)
      使用すべきではありません。
      指定された Bean プロパティ名の定数グループのすべての名前を返します。
      パラメーター:
      propertyName - Bean プロパティの名前
      戻り値:
      値のセット
      関連事項:
    • getNamesForSuffix

      public SetSE<StringSE> getNamesForSuffix(@Nullable StringSE nameSuffix)
      使用すべきではありません。
      指定された定数グループのすべての名前を返します。

      このメソッドは、定数が定数値の標準 Java 規則(つまり、すべて大文字)に従って命名されていることを前提としていることに注意してください。提供された nameSuffix は、このメソッドのメインロジックが開始される前に大文字になります(ロケールに依存しないメソッドで)。

      パラメーター:
      nameSuffix - 検索する定数名の接尾辞 (null の場合があります)
      戻り値:
      定数名のセット
    • getValues

      public SetSE<ObjectSE> getValues(@Nullable StringSE namePrefix)
      使用すべきではありません。
      指定した定数グループのすべての値を返します。

      このメソッドは、定数が定数値の標準 Java 規則(つまり、すべて大文字)に従って命名されていることを前提としていることに注意してください。提供された namePrefix は、このメソッドのメインロジックが開始される前に大文字になります(ロケールに依存しないメソッドで)。

      パラメーター:
      namePrefix - 検索する定数名のプレフィックス (null の場合があります)
      戻り値:
      値のセット
    • getValuesForProperty

      public SetSE<ObjectSE> getValuesForProperty(StringSE propertyName)
      使用すべきではありません。
      指定された Bean プロパティ名の定数グループのすべての値を返します。
      パラメーター:
      propertyName - Bean プロパティの名前
      戻り値:
      値のセット
      関連事項:
    • getValuesForSuffix

      public SetSE<ObjectSE> getValuesForSuffix(@Nullable StringSE nameSuffix)
      使用すべきではありません。
      指定した定数グループのすべての値を返します。

      このメソッドは、定数が定数値の標準 Java 規則(つまり、すべて大文字)に従って命名されていることを前提としていることに注意してください。提供された nameSuffix は、このメソッドのメインロジックが開始される前に大文字になります(ロケールに依存しないメソッドで)。

      パラメーター:
      nameSuffix - 検索する定数名の接尾辞 (null の場合があります)
      戻り値:
      値のセット
    • toCode

      public StringSE toCode(ObjectSE value, @Nullable StringSE namePrefix) throws Constants.ConstantException
      使用すべきではありません。
      指定された定数グループ内で指定された値を検索します。

      最初の一致を返します。

      パラメーター:
      value - 検索する定数値
      namePrefix - 検索する定数名のプレフィックス (null の場合があります)
      戻り値:
      定数フィールドの名前
      例外:
      Constants.ConstantException - 値が見つからなかった場合
    • toCodeForProperty

      public StringSE toCodeForProperty(ObjectSE value, StringSE propertyName) throws Constants.ConstantException
      使用すべきではありません。
      指定された Bean プロパティ名の定数グループ内で指定された値を検索します。最初の一致を返します。
      パラメーター:
      value - 検索する定数値
      propertyName - Bean プロパティの名前
      戻り値:
      定数フィールドの名前
      例外:
      Constants.ConstantException - 値が見つからなかった場合
      関連事項:
    • toCodeForSuffix

      public StringSE toCodeForSuffix(ObjectSE value, @Nullable StringSE nameSuffix) throws Constants.ConstantException
      使用すべきではありません。
      指定された定数グループ内で指定された値を検索します。

      最初の一致を返します。

      パラメーター:
      value - 検索する定数値
      nameSuffix - 検索する定数名の接尾辞 (null の場合があります)
      戻り値:
      定数フィールドの名前
      例外:
      Constants.ConstantException - 値が見つからなかった場合
    • propertyToConstantNamePrefix

      public StringSE propertyToConstantNamePrefix(StringSE propertyName)
      使用すべきではありません。
      指定された Bean プロパティ名を定数名のプレフィックスに変換します。

      一般的な命名法を使用します。すべての小文字を大文字に変換し、大文字にアンダースコアを付加します。

      例: "imageSize" → "IMAGE_SIZE"
      例: "imagesize" → "IMAGESIZE"。
      例: "ImageSize" → "_IMAGE_SIZE"。
      例: "IMAGESIZE" → "_I_M_A_G_E_S_I_Z_E"

      パラメーター:
      propertyName - Bean プロパティの名前
      戻り値:
      対応する定数名の接頭辞
      関連事項: