パッケージ jakarta.validation.spi

インターフェース ConfigurationState


public interface ConfigurationState
ValidatorFactory を作成するための ConfigurationValidationProvider 間の契約。

XML 構成で定義され、Configuration に提供される構成アーティファクトはマージされ、ConfigurationState を介して渡されます。

作成者:
Emmanuel Bernard, Hardy Ferentschik, Gunnar Morling, Guillaume Smet
  • メソッドの詳細

    • isIgnoreXmlConfiguration

      boolean isIgnoreXmlConfiguration()
      Configuration.ignoreXmlConfiguration() が呼び出された場合、true を返します。

      この場合、ValidatorFactory は META-INF/validation.xml を無視する必要があります。

      戻り値:
       META-INF/validation.xml を無視する必要がある場合は true 
    • getMessageInterpolator

      MessageInterpolator getMessageInterpolator()
      この構成のメッセージ補間器を返します。

      メッセージ補間は、次の優先度の降順で定義されます。

      • Configuration プログラマティック API を介して設定
      • ignoreXmlConfiguration が false の場合、META-INF/validation.xml で定義されます。この場合、インスタンスは引数なしのコンストラクターを介して作成されます。
      • 未定義の場合は null
      戻り値:
      メッセージ補間インスタンスまたは定義されていない場合は null 
    • getMappingStreams

      SetSE<InputStreamSE> getMappingStreams()
      構成ストリームのセットを返します。

      ストリームは次のように定義されます。

      • Configuration でプログラム的に渡された XML ストリームのマッピング
      • META-INF/validation.xml で定義されたリソースにある XML ストリームのマッピング (制約マッピング要素)

      XML 構成で表され、Configuration 実装によって開かれたストリームは、ValidatorFactory の作成後(または例外が発生した場合)に Configuration 実装によって閉じられる必要があります。すべてのストリームは、マーク / リセット契約に準拠することが保証されています(Jakarta Validation プロバイダーによる InputStream.markSupported() を参照)。

      戻り値:
      入力ストリームのセット
    • getValueExtractors

      SetSE<ValueExtractor<?>> getValueExtractors()
      値エクストラクターのセットを返します。

      エクストラクターは、次のソースから降順で取得されます。

      • Configuration にプログラムで渡される抽出
      • ignoredXmlConfiguration が false である場合、META-INF/validation.xml で定義されたエクストラクター
      • Java サービスローダーを介してロードされたエクストラクター
      プログラムで渡された特定の型および型・パラメーターのエクストラクターは、META-INF/validation.xml で定義された、またはサービスローダーを介してロードされた同じ型および型・パラメーターのエクストラクターよりも優先されます。META-INF/validation.xml で定義されたエクストラクターは、サービスローダーを介してロードされた同じ型および型パラメーターのエクストラクターよりも優先されます。

      META-INF/validation.xml で定義された、またはサービスローダーを介してロードされたエクストラクターは、引数なしのコンストラクターを使用してインスタンス化されます。

      戻り値:
      値抽出のセット。空の場合がありますが、null はありません
      導入:
      2.0
    • getConstraintValidatorFactory

      ConstraintValidatorFactory getConstraintValidatorFactory()
      この構成の制約検証ファクトリを返します。

      ConstraintValidatorFactory の実装は、次の優先度の低いもので定義されています。

      • Configuration プログラマティック API を介して設定
      • ignoredXmlConfiguration が false である場合、META-INF/validation.xml で定義されます。この場合、インスタンスは引数なしのコンストラクターを介して作成されます。
      • 未定義の場合は null
      戻り値:
      ファクトリインスタンスまたは定義されていない場合は null 
    • getTraversableResolver

      TraversableResolver getTraversableResolver()
      この構成のトラバース可能なリゾルバーを返します。

      TraversableResolver は、次の優先度の降順で定義されます。

      • Configuration プログラマティック API を介して設定
      • ignoredXmlConfiguration が false である場合、META-INF/validation.xml で定義されます。この場合、インスタンスは引数なしのコンストラクターを介して作成されます。
      • 未定義の場合は null
      戻り値:
      トラバース可能なリゾルバーインスタンスまたは定義されていない場合は null 
    • getParameterNameProvider

      ParameterNameProvider getParameterNameProvider()
      この構成のパラメーター名プロバイダーを返します。

      ParameterNameProvider は、次の優先度の降順で定義されます。

      • Configuration プログラマティック API を介して設定
      • ignoreXmlConfiguration が false である場合、META-INF/validation.xml で定義されます。この場合、インスタンスは引数なしのコンストラクターを介して作成されます。
      • 未定義の場合は null
      戻り値:
      パラメーター名プロバイダーインスタンスまたは定義されていない場合は null 
      導入:
      1.1
    • getClockProvider

      ClockProvider getClockProvider()
      この構成のクロックプロバイダーを返します。

      ClockProvider は、次の優先度の降順で定義されます。

      • Configuration プログラマティック API を介して設定
      • ignoreXmlConfiguration が false である場合、META-INF/validation.xml で定義されます。この場合、インスタンスは引数なしのコンストラクターを介して作成されます。
      • 未定義の場合は null
      戻り値:
      クロックプロバイダーインスタンスまたは定義されていない場合は null 
      導入:
      2.0
    • getProperties

      MapSE<StringSE,StringSE> getProperties()
      型安全ではないカスタムプロパティのマップを返します。

      次の方法で定義されたプロパティ:

      プロパティがプログラムと XML の両方で定義されている場合、プログラムで定義された値が優先されます。

      戻り値:
      キーがプロパティキーで値がプロパティ値である Map