Configuration (Bean Validation API 2.0.1.Final)

型パラメータ:

T - この契約に特化したプロバイダ提供の型
```
public interface Configuration<T extends Configuration<T>>
```
設定情報を受け取り、適切なBean検証プロバイダの選択と適切なValidatorFactoryの構築を行います。
使用方法:
```
 //Validationの自動実行メソッドのひとつから提供される
 Configuration<?> configuration =
     ValidatorFactory = configuration
         .messageInterpolator( new CustomMessageInterpolator() )
         .buildValidatorFactory();
 
```
デフォルトではMETA-INF/validation.xmlから設定情報が取得されます。 Configurationのいくつかのメソッドを使用することでXMLファイルから受け取った設定を上書きすることが出来ます。
ValidationProviderResolverは設定時に指定されます。(ValidationProviderを参照してください。) 明示的な要求がない場合はデフォルトのValidationProviderResolverが使用されます。
プロバイダーは次の方法で選択されます。
- Validation.byProvider(Class)を使用してプログラムで特定のプロバイダーが要求された場合、要求されたプロバイダーのクラスで最初に見つかった実装クラスを使用します。
- META-INF/validation.xmlで特定のプロバイダーが要求された場合、要求されたプロバイダーのクラスで最初に見つかった実装クラスを使用します。
- それ以外の場合、ValidationProviderResolverで返された最初のプロバイダーを使用します。
実装がスレッドセーフであるとは限りません。
作成者:

Emmanuel Bernard, Gunnar Morling, Hardy Ferentschik, Guillaume Smet

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド
修飾子とタイプ	メソッドと説明
`T`	`addMapping(InputStream stream)` Add a stream describing constraint mapping in the Bean Validation XML format.
`T`	`addProperty(String name, String value)` Adds a provider specific property.
`T`	`addValueExtractor(ValueExtractor<?> extractor)` Adds a value extractor.
`ValidatorFactory`	`buildValidatorFactory()` Build a `ValidatorFactory` implementation.
`T`	`clockProvider(ClockProvider clockProvider)` 使用される時刻プロバイダーを定義します。
`T`	`constraintValidatorFactory(ConstraintValidatorFactory constraintValidatorFactory)` 使用される制約バリデーターファクトリーを定義します。
`BootstrapConfiguration`	`getBootstrapConfiguration()` Returns configuration information stored in the `META-INF/validation.xml` file.
`ClockProvider`	`getDefaultClockProvider()` Returns an implementation of the `ClockProvider` interface following the default `ClockProvider` defined in the specification: returns a clock representing the current system time and default time zone.
`ConstraintValidatorFactory`	`getDefaultConstraintValidatorFactory()` Returns an implementation of the `ConstraintValidatorFactory` interface following the default `ConstraintValidatorFactory` defined in the specification: uses the public no-arg constructor of the `ConstraintValidator`
`MessageInterpolator`	`getDefaultMessageInterpolator()` Returns an implementation of the `MessageInterpolator` interface following the default `MessageInterpolator` defined in the specification: use the `ValidationMessages` resource bundle to load keys use `Locale.getDefault()`
`ParameterNameProvider`	`getDefaultParameterNameProvider()` Returns an implementation of the `ParameterNameProvider` interface following the default `ParameterNameProvider` defined in the specification: returns the actual parameter names as provided in the validated executable’s definition, if the class file of the executable contains parameter name information otherwise returns names in the form `arg<PARAMETER_INDEX>`, where `PARAMETER_INDEX` starts at 0 for the first parameter, e.g.
`TraversableResolver`	`getDefaultTraversableResolver()` Returns an implementation of the `TraversableResolver` interface following the default `TraversableResolver` defined in the specification: if Java Persistence is available in the runtime environment, a property is considered reachable if Java Persistence considers the property as loaded if Java Persistence is not available in the runtime environment, all properties are considered reachable all properties are considered cascadable.
`T`	`ignoreXmlConfiguration()` このメソッドを呼び出すことで`META-INF/validation.xml`ファイルからのデータを無視します。
`T`	`messageInterpolator(MessageInterpolator interpolator)` 使用されるメッセージインターポレーターを定義します。
`T`	`parameterNameProvider(ParameterNameProvider parameterNameProvider)` 使用されるパラメーター名プロバイダーを定義します。
`T`	`traversableResolver(TraversableResolver resolver)` 使用される横断リゾルバを定義します。

- メソッドの詳細
  - ignoreXmlConfiguration
```
T ignoreXmlConfiguration()
```
    このメソッドを呼び出すことでMETA-INF/validation.xmlファイルからのデータを無視します。
    このメソッドは通常、META-INF/validation.xml自体を解析し、Configurationのメソッドを介して情報を渡すコンテナで便利です。
    
    戻り値:
    
    メソッドチェーンパターンに従った this
  - messageInterpolator
```
T messageInterpolator(MessageInterpolator interpolator)
```
    使用されるメッセージインターポレーターを定義します。設定ベースのメッセージインターポレーターよりも優先されます。
    nullが渡された場合、(XML内で定義されたものもしくは仕様のデフォルトによる)デフォルトのメッセージインターセプターが使用されます。
    
    パラメータ:
    
    interpolator - メッセージインターポレーターの実装
    
    戻り値:
    
    メソッドチェーンパターンに従った this
  - traversableResolver
```
T traversableResolver(TraversableResolver resolver)
```
    使用される横断リゾルバを定義します。設定ベースの横断リゾルバよりも優先されます。
    nullが渡された場合、(XML内で定義されたものもしくは仕様のデフォルトによる)デフォルトの横断リゾルバが使用されます。
    
    パラメータ:
    
    resolver - 横断リゾルバの実装
    
    戻り値:
    
    メソッドチェーンパターンに従った this
  - constraintValidatorFactory
```
T constraintValidatorFactory(ConstraintValidatorFactory constraintValidatorFactory)
```
    使用される制約バリデーターファクトリーを定義します。設定ベースの制約バリデーターファクトリーよりも優先されます。
    nullが渡された場合、(XML内で定義されたものもしくは仕様のデフォルトによる)デフォルトの制約バリデーターファクトリーが使用されます。
    
    パラメータ:
    
    constraintValidatorFactory - 制約バリデーターファクトリーの実装
    
    戻り値:
    
    メソッドチェーンパターンに従った this
  - parameterNameProvider
```
T parameterNameProvider(ParameterNameProvider parameterNameProvider)
```
    使用されるパラメーター名プロバイダーを定義します。設定ベースのパラメーター名プロバイダーよりも優先されます。
    nullが渡された場合、(XML内で定義されたものもしくは仕様のデフォルトによる)デフォルトのパラメーター名プロバイダーが使用されます。
    
    パラメータ:
    
    parameterNameProvider - パラメーター名プロバイダーの実装
    
    戻り値:
    
    メソッドチェーンパターンに従った this
    
    導入されたバージョン:
    
    1.1
  - clockProvider
```
T clockProvider(ClockProvider clockProvider)
```
    使用される時刻プロバイダーを定義します。設定ベースの時刻プロバイダーよりも優先されます。
    nullが渡された場合、(XML内で定義されたものもしくは仕様のデフォルトによる)デフォルトの時刻プロバイダーが使用されます。
    
    パラメータ:
    
    clockProvider - 時刻プロバイダーの実装
    
    戻り値:
    
    メソッドチェーンパターンに従った this
    
    導入されたバージョン:
    
    2.0
  - addValueExtractor
```
T addValueExtractor(ValueExtractor<?> extractor)
```
    Adds a value extractor. Has priority over any extractor for the same type and type parameter detected through the service loader or given in the XML configuration.
    
    パラメータ:
    
    extractor - 値エクストラクターの実装
    
    戻り値:
    
    メソッドチェーンパターンに従った this
    
    例外:
    
    ValueExtractorDeclarationException - if more than one extractor for the same type and type parameter is added
    
    導入されたバージョン:
    
    2.0
  - addMapping
```
T addMapping(InputStream stream)
```
    Add a stream describing constraint mapping in the Bean Validation XML format.
    The stream should be closed by the client API after the ValidatorFactory has been built. The Bean Validation provider must not close the stream.
    
    パラメータ:
    
    stream - XML mapping stream; the given stream should support the mark/reset contract (see InputStream.markSupported()); if it doesn't, it will be wrapped into a stream supporting the mark/reset contract by the Bean Validation provider
    
    戻り値:
    
    メソッドチェーンパターンに従った this
    
    例外:
    
    IllegalArgumentException - if stream is null
  - addProperty
```
T addProperty(String name,
              String value)
```
    Adds a provider specific property. This property is equivalent to XML configuration properties. If the underlying provider does not know how to handle the property, it must silently ignore it.
    Note: Using this non type-safe method is generally not recommended.
    It is more appropriate to use, if available, the type-safe equivalent provided by a specific provider via its Configuration subclass.
```
 ValidatorFactory factory = Validation.byProvider(ACMEProvider.class)
     .configure()
         .providerSpecificProperty(ACMEState.FAST)
     .buildValidatorFactory();
 
```
    This method is typically used by containers parsing META-INF/validation.xml themselves and injecting the state to the Configuration object.
    If a property with a given name is defined both via this method and in the XML configuration, the value set programmatically has priority.
    If null is passed as a value, the value defined in XML is used. If no value is defined in XML, the property is considered unset.
    パラメータ:
    
    name - property name
    
    value - property value
    
    戻り値:
    
    メソッドチェーンパターンに従った this
    
    例外:
    
    IllegalArgumentException - if name is null
  - getDefaultMessageInterpolator
```
MessageInterpolator getDefaultMessageInterpolator()
```
    Returns an implementation of the MessageInterpolator interface following the default MessageInterpolator defined in the specification:
    - use the ValidationMessages resource bundle to load keys
    - use Locale.getDefault()
    戻り値:
    
    default MessageInterpolator implementation compliant with the specification
  - getDefaultTraversableResolver
```
TraversableResolver getDefaultTraversableResolver()
```
    Returns an implementation of the TraversableResolver interface following the default TraversableResolver defined in the specification:
    - if Java Persistence is available in the runtime environment, a property is considered reachable if Java Persistence considers the property as loaded
    - if Java Persistence is not available in the runtime environment, all properties are considered reachable
    - all properties are considered cascadable.
    戻り値:
    
    default TraversableResolver implementation compliant with the specification
  - getDefaultConstraintValidatorFactory
```
ConstraintValidatorFactory getDefaultConstraintValidatorFactory()
```
    Returns an implementation of the ConstraintValidatorFactory interface following the default ConstraintValidatorFactory defined in the specification:
    - uses the public no-arg constructor of the ConstraintValidator
    戻り値:
    
    default ConstraintValidatorFactory implementation compliant with the specification
  - getDefaultParameterNameProvider
```
ParameterNameProvider getDefaultParameterNameProvider()
```
    Returns an implementation of the ParameterNameProvider interface following the default ParameterNameProvider defined in the specification:
    - returns the actual parameter names as provided in the validated executable’s definition, if the class file of the executable contains parameter name information
    - otherwise returns names in the form arg<PARAMETER_INDEX>, where PARAMETER_INDEX starts at 0 for the first parameter, e.g. arg0, arg1 etc.
    戻り値:
    
    default ParameterNameProvider implementation compliant with the specification
    
    導入されたバージョン:
    
    1.1
  - getDefaultClockProvider
```
ClockProvider getDefaultClockProvider()
```
    Returns an implementation of the ClockProvider interface following the default ClockProvider defined in the specification:
    - returns a clock representing the current system time and default time zone.
    戻り値:
    
    default ClockProvider implementation compliant with the specification
    
    導入されたバージョン:
    
    2.0
  - getBootstrapConfiguration
```
BootstrapConfiguration getBootstrapConfiguration()
```
    Returns configuration information stored in the META-INF/validation.xml file.
    Note:
    Implementations are encouraged to lazily build this object to delay parsing.
    
    戻り値:
    
    returns an instance of BootstrapConfiguration; this method never returns null; if there is no META-INF/validation.xml the different getters of the returned instance will return null respectively an empty set or map
    
    導入されたバージョン:
    
    1.1
  - buildValidatorFactory
```
ValidatorFactory buildValidatorFactory()
```
    Build a ValidatorFactory implementation.
    
    戻り値:
    
    the ValidatorFactory
    
    例外:
    
    ValidationException - if the ValidatorFactory cannot be built

インタフェース Configuration<T extends Configuration<T>>

メソッドのサマリー

メソッドの詳細

ignoreXmlConfiguration

messageInterpolator

traversableResolver

constraintValidatorFactory

parameterNameProvider

clockProvider

addValueExtractor

addMapping

addProperty

getDefaultMessageInterpolator

getDefaultTraversableResolver

getDefaultConstraintValidatorFactory

getDefaultParameterNameProvider

getDefaultClockProvider

getBootstrapConfiguration

buildValidatorFactory