パッケージ org.springframework.core.annotation

クラス AnnotationAttributes

java.lang.ObjectSE
java.util.AbstractMapSE<K,V>
java.util.HashMapSE<K,V>
java.util.LinkedHashMapSE<StringSE,ObjectSE>
org.springframework.core.annotation.AnnotationAttributes
実装されているすべてのインターフェース:
SerializableSE、CloneableSE、MapSE<StringSE,ObjectSE>
public class AnnotationAttributes extends LinkedHashMapSE<StringSE,ObjectSE>
AnnotationUtils、AnnotatedElementUtils、Spring の反射ベースおよび ASM ベースの AnnotationMetadata 実装によって読み取られるアノテーション属性のキーと値のペアを表す LinkedHashMapSE サブクラス。

型安全なメソッドでアノテーション属性を検索するための便利なメソッドと同様に、呼び出しコード内のノイズの多い Map ジェネリクスを回避するための「疑似具体化」を提供します。

導入:
3.1.1
作成者:
Chris Beams, Sam Brannen, Juergen Hoeller
関連事項:

  • コンストラクターの詳細

    • AnnotationAttributes

      public AnnotationAttributes()
      新しい空の AnnotationAttributes インスタンスを作成します。

    • AnnotationAttributes

      public AnnotationAttributes(int initialCapacity)
      指定された初期容量で新しい空の AnnotationAttributes インスタンスを作成して、パフォーマンスを最適化します。
      パラメーター:
      initialCapacity - 基本となるマップの初期サイズ

    • AnnotationAttributes

      public AnnotationAttributes(MapSE<StringSE,ObjectSE> map)
      新しい AnnotationAttributes インスタンスを作成し、提供されたマップとそのすべてのキーと値のペアをラップします。
      パラメーター:
      map - アノテーション属性のキーと値のペアの元のソース
      関連事項:

    • AnnotationAttributes

      public AnnotationAttributes(AnnotationAttributes other)
      新しい AnnotationAttributes インスタンスを作成し、提供されたマップとそのすべてのキーと値のペアをラップします。
      パラメーター:
      other - アノテーション属性のキーと値のペアの元のソース
      関連事項:

    • AnnotationAttributes

      public AnnotationAttributes(ClassSE<? extends AnnotationSE> annotationType)
      指定された annotationType の新しい空の AnnotationAttributes インスタンスを作成します。
      パラメーター:
      annotationType - この AnnotationAttributes インスタンスによって表されるアノテーションの型。null
      導入:
      4.2

    • AnnotationAttributes

      public AnnotationAttributes(StringSE annotationType, @Nullable ClassLoaderSE classLoader)
      指定された annotationType の新しい空の AnnotationAttributes インスタンスを作成します。
      パラメーター:
      annotationType - この AnnotationAttributes インスタンスによって表されるアノテーション型の名前。null
      classLoader - アノテーション型をロードしようとする ClassLoader、またはアノテーション型名を格納するだけの null 
      導入:
      4.3.2

  • メソッドの詳細

    • annotationType

      @Nullable public ClassSE<? extends AnnotationSE> annotationType()
      この AnnotationAttributes によって表されるアノテーションの型を取得します。
      戻り値:
      アノテーション型。不明の場合は null 
      導入:
      4.2

    • getString

      public StringSE getString(StringSE attributeName)
      指定された attributeName に格納されている値を文字列として取得します。
      パラメーター:
      attributeName - 取得する属性の名前。null または空ではありません
      戻り値:
      値
      例外:
      IllegalArgumentExceptionSE - 属性が存在しない場合、または予期された型ではない場合

    • getStringArray

      public StringSE[] getStringArray(StringSE attributeName)
      指定された attributeName に格納されている値を文字列の配列として取得します。

      指定された attributeName に格納されている値が文字列の場合、それを返す前に単一要素の配列にラップされます。

      パラメーター:
      attributeName - 取得する属性の名前。null または空ではありません
      戻り値:
      値
      例外:
      IllegalArgumentExceptionSE - 属性が存在しない場合、または予期された型ではない場合

    • getBoolean

      public boolean getBoolean(StringSE attributeName)
      指定された attributeName に格納されている値をブール値として取得します。
      パラメーター:
      attributeName - 取得する属性の名前。null または空ではありません
      戻り値:
      値
      例外:
      IllegalArgumentExceptionSE - 属性が存在しない場合、または予期された型ではない場合

    • getNumber

      public <N extends NumberSE> N getNumber(StringSE attributeName)
      指定された attributeName に保存されている値を数値として取得します。
      パラメーター:
      attributeName - 取得する属性の名前。null または空ではありません
      戻り値:
      値
      例外:
      IllegalArgumentExceptionSE - 属性が存在しない場合、または予期された型ではない場合

    • getEnum

      public <E extends EnumSE<?>> E getEnum(StringSE attributeName)
      指定された attributeName に格納されている値を列挙として取得します。
      パラメーター:
      attributeName - 取得する属性の名前。null または空ではありません
      戻り値:
      値
      例外:
      IllegalArgumentExceptionSE - 属性が存在しない場合、または予期された型ではない場合

    • getClass

      public <T> ClassSE<? extends T> getClass(StringSE attributeName)
      指定された attributeName にクラスとして保存されている値を取得します。
      パラメーター:
      attributeName - 取得する属性の名前。null または空ではありません
      戻り値:
      値
      例外:
      IllegalArgumentExceptionSE - 属性が存在しない場合、または予期された型ではない場合

    • getClassArray

      public ClassSE<?>[] getClassArray(StringSE attributeName)
      指定された attributeName に格納されている値をクラスの配列として取得します。

      指定された attributeName に格納されている値がクラスの場合、それを返す前に単一要素の配列にラップされます。

      パラメーター:
      attributeName - 取得する属性の名前。null または空ではありません
      戻り値:
      値
      例外:
      IllegalArgumentExceptionSE - 属性が存在しない場合、または予期された型ではない場合

    • getAnnotation

      public AnnotationAttributes getAnnotation(StringSE attributeName)
      指定された attributeName に保存されている AnnotationAttributes を取得します。

      メモ: 実際のアノテーションが必要な場合は、代わりに getAnnotation(String, Class) を呼び出してください。

      パラメーター:
      attributeName - 取得する属性の名前。null または空ではありません
      戻り値:
      AnnotationAttributes
      例外:
      IllegalArgumentExceptionSE - 属性が存在しない場合、または予期された型ではない場合

    • getAnnotation

      public <A extends AnnotationSE> A getAnnotation(StringSE attributeName, ClassSE<A> annotationType)
      指定された attributeName に格納されている型 annotationType のアノテーションを取得します。
      パラメーター:
      attributeName - 取得する属性の名前。null または空ではありません
      annotationType - 予期されるアノテーション型。null
      戻り値:
      アノテーション
      例外:
      IllegalArgumentExceptionSE - 属性が存在しない場合、または予期された型ではない場合
      導入:
      4.2

    • getAnnotationArray

      public AnnotationAttributes[] getAnnotationArray(StringSE attributeName)
      指定された attributeName に格納されている AnnotationAttributes の配列を取得します。

      指定された attributeName に格納されている値が AnnotationAttributes のインスタンスである場合、それを返す前に単一要素の配列にラップされます。

      メモ: アノテーションの実際の配列が必要な場合は、代わりに getAnnotationArray(String, Class) を呼び出します。

      パラメーター:
      attributeName - 取得する属性の名前。null または空ではありません
      戻り値:
      AnnotationAttributes の配列
      例外:
      IllegalArgumentExceptionSE - 属性が存在しない場合、または予期された型ではない場合

    • getAnnotationArray

      public <A extends AnnotationSE> A[] getAnnotationArray(StringSE attributeName, ClassSE<A> annotationType)
      指定された attributeName に格納されている型 annotationType の配列を取得します。

      指定された attributeName に格納されている値が Annotation である場合、それを返す前に単一要素の配列にラップされます。

      パラメーター:
      attributeName - 取得する属性の名前。null または空ではありません
      annotationType - 予期されるアノテーション型。null
      戻り値:
      アノテーション配列
      例外:
      IllegalArgumentExceptionSE - 属性が存在しない場合、または予期された型ではない場合
      導入:
      4.2

    • toString

      public StringSE toString()
      オーバーライド:
      クラス AbstractMapSE<StringSE,ObjectSE> の toString 

    • fromMap

      @Nullable public static AnnotationAttributes fromMap(@Nullable MapSE<StringSE,ObjectSE> map)
      指定されたマップに基づいて AnnotationAttributes インスタンスを返します。

      マップがすでに AnnotationAttributes インスタンスである場合、新しいインスタンスを作成せずに、キャストされてすぐに返されます。それ以外の場合は、提供されたマップを AnnotationAttributes(Map) コンストラクターに渡すことにより、新しいインスタンスが作成されます。

      パラメーター:
      map - アノテーション属性のキーと値のペアの元のソース