パッケージ org.springframework.boot.origin

インターフェース OriginLookup<K>

型パラメーター:
K - ルックアップキー型
すべての既知の実装クラス:
ConfigTreePropertySource、OriginTrackedMapPropertySource、SystemEnvironmentPropertySourceEnvironmentPostProcessor.OriginAwareSystemEnvironmentPropertySource
関数インターフェース:
これは関数インターフェースであるため、ラムダ式またはメソッド参照の割り当てターゲットとして使用できます。
@FunctionalInterfaceSE public interface OriginLookup<K>
特定のキーから Origin 情報を検索できるオブジェクトによって実装される可能性のあるインターフェース。既存のクラスにオリジンサポートを追加するために使用できます。
導入:
2.0.0
作成者:
Phillip Webb

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    static <K> Origin
    getOrigin(ObjectSE source, K key)
    指定されたソースからオリジンを検索してみてください。
    Origin
    getOrigin(K key)
    指定されたキーの起源を返すか、起源を特定できない場合は null を返します。
    default StringSE
    getPrefix()
    ルックアップの実行時に適用される暗黙のプレフィックスを返します。プレフィックスが使用されていない場合は null を返します。
    default boolean
    isImmutable()
    このルックアップが不変で、内容が決して変更されない場合、true を返します。

  • メソッドの詳細

    • getOrigin

      Origin getOrigin(K key)
      指定されたキーの起源を返すか、起源を特定できない場合は null を返します。
      パラメーター:
      key - 検索するキー
      戻り値:
      キーまたは null の起源

    • isImmutable

      default boolean isImmutable()
      このルックアップが不変で、内容が決して変更されない場合、true を返します。
      戻り値:
      ルックアップが不変の場合
      導入:
      2.2.0

    • getPrefix

      default StringSE getPrefix()
      ルックアップの実行時に適用される暗黙のプレフィックスを返します。プレフィックスが使用されていない場合は null を返します。プレフィックスを使用して、他の方法では衝突するキーを明確にすることができます。例: 複数のアプリケーションが同じマシンで実行されている場合は、アプリケーションごとに異なるプレフィックスを設定して、異なる環境変数が使用されるようにすることができます。
      戻り値:
      ルックアップクラスまたは null によって適用されるプレフィックス。
      導入:
      2.5.0

    • getOrigin

      static <K> Origin getOrigin(ObjectSE source, K key)
      指定されたソースからオリジンを検索してみてください。ソースが OriginLookup でない場合、またはルックアップ中に例外が発生した場合は、null が返されます。
      型パラメーター:
      K - キー型
      パラメーター:
      source - ソースオブジェクト
      key - 検索するキー
      戻り値:
      Origin または null