T
- この契約のプロバイダー固有の特殊化の型 public interface Configuration<T extends Configuration<T>>
ValidatorFactory
をビルドします。使用法:
//provided by one of the Validation bootstrap methods Configuration<?> configuration = ValidatorFactory = configuration .messageInterpolator( new CustomMessageInterpolator() ) .buildValidatorFactory();
デフォルトでは、構成情報は META-INF/validation.xml
から取得されます。1 つ以上の Configuration
メソッドを使用して、XML ファイルから取得した構成を上書きすることが可能です。
ValidationProviderResolver
は構成時に指定されます(ValidationProvider
を参照)。明示的にリクエストされていない場合は、デフォルトの ValidationProviderResolver
が使用されます。
プロバイダーは次の方法で選択されます。
Validation.byProvider(Class)
を使用してプログラムでリクエストされた場合、リクエストされたプロバイダークラスを実装する最初のプロバイダーを見つけて使用します。META-INF/validation.xml
で特定のプロバイダーがリクエストされた場合は、リクエストされたプロバイダークラスを実装する最初のプロバイダーを見つけて使用します。ValidationProviderResolver
によって返された最初のプロバイダーを使用します 実装はスレッドセーフであることを意図していません。
修飾子と型 | メソッドと説明 |
---|---|
T | addMapping(InputStreamSE stream) Jakarta Bean Validation XML 形式で制約マッピングを記述するストリームを追加します。 |
T | addProperty(StringSE name, StringSE value) プロバイダー固有のプロパティを追加します。 |
T | addValueExtractor(ValueExtractor<?> extractor) 値抽出機能を追加します。 |
ValidatorFactory | buildValidatorFactory() ValidatorFactory 実装を構築します。 |
T | clockProvider(ClockProvider clockProvider) クロックプロバイダーを定義します。 |
T | constraintValidatorFactory(ConstraintValidatorFactory constraintValidatorFactory) 制約バリデータファクトリを定義します。 |
BootstrapConfiguration | getBootstrapConfiguration() META-INF/validation.xml ファイルに保存されている構成情報を返します。 |
ClockProvider | getDefaultClockProvider() 仕様で定義されているデフォルトの ClockProvider に続く ClockProvider インターフェースの実装を返します。現在のシステム時刻とデフォルトのタイムゾーンを表す監視を返します。 |
ConstraintValidatorFactory | getDefaultConstraintValidatorFactory() 仕様で定義されているデフォルトの ConstraintValidatorFactory に続く ConstraintValidatorFactory インターフェースの実装を返します。ConstraintValidator の引数なしの public コンストラクターを使用します |
MessageInterpolator | getDefaultMessageInterpolator() 仕様で定義されているデフォルトの MessageInterpolator に続く MessageInterpolator インターフェースの実装を返します。ValidationMessages リソースバンドルを使用してキーをロードし、Locale.getDefault() を使用します。 |
ParameterNameProvider | getDefaultParameterNameProvider() 仕様で定義されているデフォルトの ParameterNameProvider に続く ParameterNameProvider インターフェースの実装を返します。実行可能ファイルのクラスファイルにパラメーター名情報が含まれている場合は、検証済みの実行可能ファイルの定義で提供されている実際のパラメーター名を返します。それ以外の場合は arg<PARAMETER_INDEX> の形式で名前を返します。ここで PARAMETER_INDEX 最初のパラメーターは 0 から始まります。例: |
TraversableResolver | getDefaultTraversableResolver() 仕様で定義されているデフォルトの TraversableResolver に続く TraversableResolver インターフェースの実装を返します。JavaPersistence がランタイム環境で使用できる場合、Java Persistence がランタイム環境で使用できない場合に Java Persistence がプロパティをロード済みと見なすと、プロパティは到達可能と見なされます。すべてのプロパティは到達可能と見なされ、すべてのプロパティはカスケード可能と見なされます。 |
T | ignoreXmlConfiguration() このメソッドが呼び出された場合、 META-INF/validation.xml ファイルのデータを無視します。 |
T | messageInterpolator(MessageInterpolator interpolator) 使用するメッセージ補間を定義します。 |
T | parameterNameProvider(ParameterNameProvider parameterNameProvider) パラメーター名プロバイダーを定義します。 |
T | traversableResolver(TraversableResolver resolver) 使用される通過可能なリゾルバーを定義します。 |
T ignoreXmlConfiguration()
META-INF/validation.xml
ファイルのデータを無視します。 このメソッドは通常、META-INF/validation.xml
自体を解析し、Configuration
メソッドを介して情報を渡すコンテナーに役立ちます。
this
。T messageInterpolator(MessageInterpolator interpolator)
null
が渡されると、デフォルトのメッセージ補間が使用されます(XML で定義されているか、仕様のデフォルトです)。
interpolator
- メッセージ補間機能の実装 this
T traversableResolver(TraversableResolver resolver)
null
が渡された場合、デフォルトの走査可能なリゾルバーが使用されます(XML または仕様のデフォルトで定義されています)。
resolver
- 走査可能なリゾルバーの実装 this
T constraintValidatorFactory(ConstraintValidatorFactory constraintValidatorFactory)
null
が渡された場合、デフォルトの制約バリデーターファクトリが使用されます(XML または仕様のデフォルトで定義されています)。
constraintValidatorFactory
- 制約ファクトリの実装 this
T parameterNameProvider(ParameterNameProvider parameterNameProvider)
null
が渡された場合、デフォルトのパラメーター名プロバイダーが使用されます(XML または仕様のデフォルトで定義されています)。
parameterNameProvider
- パラメーター名プロバイダーの実装 this
。T clockProvider(ClockProvider clockProvider)
null
が渡された場合、デフォルトのクロックプロバイダーが使用されます(XML または仕様のデフォルトで定義)。
clockProvider
- クロックプロバイダーの実装 this
。T addValueExtractor(ValueExtractor<?> extractor)
extractor
- 値抽出の実装 this
。ValueExtractorDeclarationException
- 同じ型と型パラメーターに複数のエクストラクターが追加された場合 T addMapping(InputStreamSE stream)
ValidatorFactory
が構築された後、ストリームはクライアント API によって閉じられる必要があります。Jakarta Bean Validation プロバイダーはストリームを閉じてはなりません。
stream
- XML マッピングストリーム。指定されたストリームは、マーク / リセット契約をサポートする必要があります(InputStream.markSupported()
SE を参照)。そうでない場合は、Jakarta Bean Validation プロバイダーによってマーク / リセット契約をサポートするストリームにラップされます。this
IllegalArgumentExceptionSE
- stream
が null の場合 T addProperty(StringSE name, StringSE value)
メモ: この型安全でない方法を使用することは、一般的には推奨されません。
可能な場合は、Configuration
サブクラスを介して特定のプロバイダーによって提供される型安全な同等のものを使用する方が適切です。
ValidatorFactory factory = Validation.byProvider(ACMEProvider.class) .configure() .providerSpecificProperty(ACMEState.FAST) .buildValidatorFactory();このメソッドは通常、
META-INF/validation.xml
自体を解析し、Configuration
オブジェクトに状態を注入するコンテナーによって使用されます。特定の名前のプロパティがこのメソッドと XML 構成の両方で定義されている場合、プログラムで設定された値が優先されます。
null
が値として渡される場合、XML で定義された値が使用されます。XML で値が定義されていない場合、プロパティは未設定と見なされます。
name
- プロパティ名 value
- プロパティ値 this
IllegalArgumentExceptionSE
- name
が null の場合 MessageInterpolator getDefaultMessageInterpolator()
MessageInterpolator
に続く MessageInterpolator
インターフェースの実装を返します。ValidationMessages
リソースバンドルを使用してキーをロードする Locale.getDefault()
を使用 MessageInterpolator
実装 TraversableResolver getDefaultTraversableResolver()
TraversableResolver
に続く TraversableResolver
インターフェースの実装を返します。TraversableResolver
実装 ConstraintValidatorFactory getDefaultConstraintValidatorFactory()
ConstraintValidatorFactory
に続く ConstraintValidatorFactory
インターフェースの実装を返します。ConstraintValidator
の引数なしの public コンストラクターを使用します ConstraintValidatorFactory
実装 ParameterNameProvider getDefaultParameterNameProvider()
ParameterNameProvider
に続く ParameterNameProvider
インターフェースの実装を返します。arg<PARAMETER_INDEX>
の形式で名前を返します。PARAMETER_INDEX
は、最初のパラメーターの 0 から始まります。arg0
、arg1
など ParameterNameProvider
実装 ClockProvider getDefaultClockProvider()
ClockProvider
実装 BootstrapConfiguration getBootstrapConfiguration()
META-INF/validation.xml
ファイルに保存されている構成情報を返します。 注 :
実装では、このオブジェクトを遅延してビルドして解析を遅延させることをお勧めします。
BootstrapConfiguration
のインスタンスを返します。このメソッドは null
を返しません。META-INF/validation.xml
がない場合、返されたインスタンスの異なる getter はそれぞれ null
を返し、空のセットまたはマップを返します。ValidatorFactory buildValidatorFactory()
ValidatorFactory
実装を構築します。ValidatorFactory
ValidationException
- ValidatorFactory
を構築できない場合 Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.