クラス PropertyMapper

java.lang.ObjectSE
org.springframework.boot.context.properties.PropertyMapper
public final class PropertyMapper extends ObjectSE
指定されたソースから宛先に値をマップするために使用できるユーティリティ。主に、@ConfigurationProperties からサードパーティのクラスにマッピングするときに役立つことを目的としています。

述語に基づいて値をフィルタリングし、必要に応じて値を適合させることができます。例：

PropertyMapper map = PropertyMapper.get();
map.from(source::getName)
  .to(destination::setName);
map.from(source::getTimeout)
  .when(this::thisYear)
  .asInt(Duration::getSeconds)
  .to(destination::setTimeoutSecs);
map.from(source::isEnabled)
  .whenFalse().
  .toCall(destination::disable);

マッピングは、最終的に setter に適用したり、method call をトリガーしたり、new instance を作成したりできます。

デフォルトでは、null 値とサプライヤーからスローされた NullPointerExceptionSE はフィルタリングされ、コンシューマーには適用されません。NULL 値を適用したい場合は、PropertyMapper.Source.always() を使用してください。

導入:
2.0.0
作成者:
Phillip Webb, Artsiom Yudovin, Chris Bono, Moritz Halbritter

  • メソッドの詳細

    • alwaysApplying

      public PropertyMapper alwaysApplying(PropertyMapper.SourceOperator operator)
      指定された PropertyMapper.SourceOperator をすべてのソースに適用する新しい PropertyMapper インスタンスを返します。
      パラメーター:
      operator - 適用するソース演算子
      戻り値:
      新しいプロパティマッパーインスタンス

    • from

      public <T> PropertyMapper.Source<T> from(@Nullable T value)
      マッピングの実行に使用できる指定された値から新しい PropertyMapper.Source を返します。
      型パラメーター:
      T - ソース型
      パラメーター:
      value - 値
      戻り値:
      マッピングを完了するために使用できる PropertyMapper.Source

    • from

      public <T> PropertyMapper.Source<T> from(SupplierSE<? extends @Nullable T> supplier)
      マッピングの実行に使用できる指定された値サプライヤーから新しい PropertyMapper.Source を返します。
      型パラメーター:
      T - ソース型
      パラメーター:
      supplier - 価値サプライヤー
      戻り値:
      マッピングを完了するために使用できる PropertyMapper.Source
      関連事項:

    • get

      public static PropertyMapper get()
      プロパティマッパーを返します。
      戻り値:
      プロパティマッパー