com.google.gwt.validation.client.impl

Class BaseGwtConfiguration

java.lang.Object

com.google.gwt.validation.client.impl.BaseGwtConfiguration

All Implemented Interfaces:

Configuration<BaseGwtConfiguration>

Direct Known Subclasses:

GwtConfiguration

public abstract class BaseGwtConfiguration
extends Object
implements Configuration<BaseGwtConfiguration>

Base GWT Configuration.

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.validation.ConstraintValidatorFactory	constraintValidatorFactory
protected MessageInterpolator	messageInterpolator
protected Map<String,String>	properties
protected GwtValidationProvider	provider
protected javax.validation.spi.BootstrapState	state
protected javax.validation.TraversableResolver	traversableResolver

Constructor Summary

Constructors

Constructor and Description
BaseGwtConfiguration(GwtValidationProvider gwtValidationProvider, javax.validation.spi.BootstrapState state)

Method Summary

Modifier and Type	Method and Description
BaseGwtConfiguration	addProperty(String name, String value) Add a provider specific property.
javax.validation.ValidatorFactory	buildValidatorFactory() Build a ValidatorFactory implementation.
BaseGwtConfiguration	constraintValidatorFactory(javax.validation.ConstraintValidatorFactory constraintValidatorFactory) ConstraintValidatorFactory is unsupported in GWT. Constraint validators are instead created using GWT.create- with no factory.
javax.validation.ConstraintValidatorFactory	getDefaultConstraintValidatorFactory() Return 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() Return 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()
javax.validation.TraversableResolver	getDefaultTraversableResolver() Return 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.
BaseGwtConfiguration	ignoreXmlConfiguration() Ignore data from the META-INF/validation.xml file if this method is called.
BaseGwtConfiguration	messageInterpolator(MessageInterpolator interpolator) Defines the message interpolator used.
BaseGwtConfiguration	traversableResolver(javax.validation.TraversableResolver resolver) Defines the traversable resolver used.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Methods inherited from interface javax.validation.Configuration

addMapping

Field Detail

provider

protected final GwtValidationProvider provider

state

protected final javax.validation.spi.BootstrapState state

properties

protected final Map<String,String> properties

constraintValidatorFactory

protected javax.validation.ConstraintValidatorFactory constraintValidatorFactory

messageInterpolator

protected MessageInterpolator messageInterpolator

traversableResolver

protected javax.validation.TraversableResolver traversableResolver

Constructor Detail

BaseGwtConfiguration

public BaseGwtConfiguration(GwtValidationProvider gwtValidationProvider,
                            javax.validation.spi.BootstrapState state)

Method Detail

addProperty

public final BaseGwtConfiguration addProperty(String name,
                                              String value)

Description copied from interface: Configuration

Add 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(ACMEPrivoder.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.

Specified by:

addProperty in interface Configuration<BaseGwtConfiguration>

Parameters:

name - property name.

value - property value.

Returns:

this following the chaining method pattern.

buildValidatorFactory

public final javax.validation.ValidatorFactory buildValidatorFactory()

Description copied from interface: Configuration

Build a ValidatorFactory implementation.

Specified by:

buildValidatorFactory in interface Configuration<BaseGwtConfiguration>

Returns:

ValidatorFactory

constraintValidatorFactory

public final BaseGwtConfiguration constraintValidatorFactory(javax.validation.ConstraintValidatorFactory constraintValidatorFactory)

ConstraintValidatorFactory is unsupported in GWT. Constraint validators are instead created using GWT.create- with no factory.

Specified by:

constraintValidatorFactory in interface Configuration<BaseGwtConfiguration>

Parameters:

constraintValidatorFactory - constraint factory inmplementation.

Returns:

this following the chaining method pattern.

getDefaultConstraintValidatorFactory

public final javax.validation.ConstraintValidatorFactory getDefaultConstraintValidatorFactory()

Description copied from interface: Configuration

Return an implementation of the ConstraintValidatorFactory interface following the default ConstraintValidatorFactory defined in the specification:

• uses the public no-arg constructor of the ConstraintValidator

Specified by:

getDefaultConstraintValidatorFactory in interface Configuration<BaseGwtConfiguration>

Returns:

default ConstraintValidatorFactory implementation compliant with the specification

getDefaultMessageInterpolator

public final MessageInterpolator getDefaultMessageInterpolator()

Description copied from interface: Configuration

Return 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()

Specified by:

getDefaultMessageInterpolator in interface Configuration<BaseGwtConfiguration>

Returns:

default MessageInterpolator implementation compliant with the specification

getDefaultTraversableResolver

public final javax.validation.TraversableResolver getDefaultTraversableResolver()

Description copied from interface: Configuration

Return 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.

Specified by:

getDefaultTraversableResolver in interface Configuration<BaseGwtConfiguration>

Returns:

default TraversableResolver implementation compliant with the specification

ignoreXmlConfiguration

public final BaseGwtConfiguration ignoreXmlConfiguration()

Description copied from interface: Configuration

Ignore data from the META-INF/validation.xml file if this method is called. This method is typically useful for containers that parse META-INF/validation.xml themselves and pass the information via the Configuration methods.

Specified by:

ignoreXmlConfiguration in interface Configuration<BaseGwtConfiguration>

Returns:

this following the chaining method pattern.

messageInterpolator

public final BaseGwtConfiguration messageInterpolator(MessageInterpolator interpolator)

Description copied from interface: Configuration

Defines the message interpolator used. Has priority over the configuration based message interpolator. If null is passed, the default message interpolator is used (defined in XML or the specification default).

Specified by:

messageInterpolator in interface Configuration<BaseGwtConfiguration>

Parameters:

interpolator - message interpolator implementation.

Returns:

this following the chaining method pattern.

traversableResolver

public final BaseGwtConfiguration traversableResolver(javax.validation.TraversableResolver resolver)

Description copied from interface: Configuration

Defines the traversable resolver used. Has priority over the configuration based traversable resolver. If null is passed, the default traversable resolver is used (defined in XML or the specification default).

Specified by:

traversableResolver in interface Configuration<BaseGwtConfiguration>

Parameters:

resolver - traversable resolver implementation.

Returns:

this following the chaining method pattern.