クラス CandidateComponentsIndex

java.lang.ObjectSE
org.springframework.context.index.CandidateComponentsIndex
public class CandidateComponentsIndex extends ObjectSE
META-INF/spring.components コンポーネントインデックスファイルで定義されている候補 (CandidateComponentsIndex(List) を参照) またはプログラムで登録されている候補 (CandidateComponentsIndex() を参照) へのアクセスを提供します。

任意の数のステレオタイプをインデックスに登録（および照会）できます。典型的な例は、特定のユースケースのクラスにフラグを付けるアノテーションの完全修飾名です。次の呼び出しは、com.example パッケージ（およびそのサブパッケージ）のすべての @Component  候補型を返します。

Set<String> candidates = index.getCandidateTypes(
        "com.example", "org.springframework.stereotype.Component");

type は通常、クラスの完全修飾名ですが、これはルールではありません。同様に、stereotype は通常、アノテーション型の完全修飾名ですが、実際には任意のマーカーを使用できます。

導入:
5.0
作成者:
Stephane Nicoll, Juergen Hoeller

  • コンストラクターの概要

    コンストラクター
    コンストラクター
    説明
    CandidateComponentsIndex()
    プログラムによる入力用に新しいインデックスインスタンスを作成します。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    SetSE<StringSE>
    getCandidateTypes(StringSE basePackage, StringSE stereotype)
    指定されたステレオタイプに関連付けられている候補型を返します。
    SetSE<StringSE>
    getRegisteredScans()
    登録された基本パッケージ (または基本パッケージパターン) を返します。
    SetSE<StringSE>
    getRegisteredStereotypes()
    登録されたステレオタイプパッケージ (または基本パッケージパターン) を返します。
    boolean
    hasScannedPackage(StringSE packageName)
    このインデックスに、指定された基本パッケージ (または基本パッケージパターン) のエントリが含まれているかどうかを判断します。
    void
    registerCandidateType(StringSE type, StringSE... stereotypes)
    指定された候補型に対して 1 つ以上のステレオタイプをプログラムで登録します。
    void
    registerScan(StringSE... basePackages)
    指定された基本パッケージ (または基本パッケージパターン) をスキャン済みとしてプログラムで登録します。

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

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE

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

  • メソッドの詳細

    • registerScan

      public void registerScan(StringSE... basePackages)
      指定された基本パッケージ (または基本パッケージパターン) をスキャン済みとしてプログラムで登録します。
      導入:
      7.0
      関連事項:

    • getRegisteredScans

      public SetSE<StringSE> getRegisteredScans()
      登録された基本パッケージ (または基本パッケージパターン) を返します。
      導入:
      7.0
      関連事項:

    • hasScannedPackage

      public boolean hasScannedPackage(StringSE packageName)
      このインデックスに、指定された基本パッケージ (または基本パッケージパターン) のエントリが含まれているかどうかを判断します。
      導入:
      7.0

    • registerCandidateType

      public void registerCandidateType(StringSE type, StringSE... stereotypes)
      指定された候補型に対して 1 つ以上のステレオタイプをプログラムで登録します。

      Note that the containing packages for candidates are not automatically considered scanned packages. Make sure to call registerScan(String...) with the scan-specific base package accordingly.

      導入:
      7.0
      関連事項:

    • getRegisteredStereotypes

      public SetSE<StringSE> getRegisteredStereotypes()
      登録されたステレオタイプパッケージ (または基本パッケージパターン) を返します。
      導入:
      7.0

    • getCandidateTypes

      public SetSE<StringSE> getCandidateTypes(StringSE basePackage, StringSE stereotype)
      指定されたステレオタイプに関連付けられている候補型を返します。
      パラメーター:
      basePackage - 候補者をチェックするパッケージ
      stereotype - 使用するステレオタイプ
      戻り値:
      指定された stereotype に関連付けられた候補型、または指定された basePackage に何も見つからなかった場合は空のセット