org.hibernate.validator.internal.engine.constraintvalidation

Class ConstraintValidatorContextImpl

java.lang.Object

org.hibernate.validator.internal.engine.constraintvalidation.ConstraintValidatorContextImpl

All Implemented Interfaces:

javax.validation.ConstraintValidatorContext, HibernateConstraintValidatorContext

public class ConstraintValidatorContextImpl
extends java.lang.Object
implements HibernateConstraintValidatorContext

Author:

Hardy Ferentschik, Gunnar Morling, Guillaume Smet

Nested Class Summary

Nested classes/interfaces inherited from interface javax.validation.ConstraintValidatorContext

javax.validation.ConstraintValidatorContext.ConstraintViolationBuilder

Constructor Summary

Constructors

Constructor and Description
ConstraintValidatorContextImpl(java.util.List<java.lang.String> methodParameterNames, javax.validation.ClockProvider clockProvider, PathImpl propertyPath, javax.validation.metadata.ConstraintDescriptor<?> constraintDescriptor, java.lang.Object constraintValidatorPayload)

Method Summary

Modifier and Type	Method and Description
HibernateConstraintValidatorContext	addExpressionVariable(java.lang.String name, java.lang.Object value) Allows to set an additional expression variable which will be available as an EL variable during interpolation.
HibernateConstraintValidatorContext	addMessageParameter(java.lang.String name, java.lang.Object value) Allows to set an additional named parameter which can be interpolated in the constraint violation message.
javax.validation.ConstraintValidatorContext.ConstraintViolationBuilder	buildConstraintViolationWithTemplate(java.lang.String messageTemplate)
void	disableDefaultConstraintViolation()
javax.validation.ClockProvider	getClockProvider()
javax.validation.metadata.ConstraintDescriptor<?>	getConstraintDescriptor()
<C> C	getConstraintValidatorPayload(java.lang.Class<C> type) Returns an instance of the specified type or null if the current constraint validator payload isn't of the given type.
java.util.List<ConstraintViolationCreationContext>	getConstraintViolationCreationContexts()
java.lang.String	getDefaultConstraintMessageTemplate()
java.util.List<java.lang.String>	getMethodParameterNames()
<T> T	unwrap(java.lang.Class<T> type)
HibernateConstraintValidatorContext	withDynamicPayload(java.lang.Object violationContext) Allows to set an object that may further describe the violation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConstraintValidatorContextImpl

public ConstraintValidatorContextImpl(java.util.List<java.lang.String> methodParameterNames,
                                      javax.validation.ClockProvider clockProvider,
                                      PathImpl propertyPath,
                                      javax.validation.metadata.ConstraintDescriptor<?> constraintDescriptor,
                                      java.lang.Object constraintValidatorPayload)

Method Detail

disableDefaultConstraintViolation

public final void disableDefaultConstraintViolation()

Specified by:

disableDefaultConstraintViolation in interface javax.validation.ConstraintValidatorContext

getDefaultConstraintMessageTemplate

public final java.lang.String getDefaultConstraintMessageTemplate()

Specified by:

getDefaultConstraintMessageTemplate in interface javax.validation.ConstraintValidatorContext

buildConstraintViolationWithTemplate

public final javax.validation.ConstraintValidatorContext.ConstraintViolationBuilder buildConstraintViolationWithTemplate(java.lang.String messageTemplate)

Specified by:

buildConstraintViolationWithTemplate in interface javax.validation.ConstraintValidatorContext

unwrap

public <T> T unwrap(java.lang.Class<T> type)

Specified by:

unwrap in interface javax.validation.ConstraintValidatorContext

addExpressionVariable

public HibernateConstraintValidatorContext addExpressionVariable(java.lang.String name,
                                                                 java.lang.Object value)

Description copied from interface: HibernateConstraintValidatorContext

Allows to set an additional expression variable which will be available as an EL variable during interpolation. The variable will be available for interpolation for all constraint violations generated for this constraint. This includes the default one as well as all violations created by the ConstraintViolationBuilder. To create multiple constraint violations with different variable values, this method can be called between successive calls to ConstraintValidatorContext.ConstraintViolationBuilder.addConstraintViolation().

For example:

 
 public boolean isValid(String value, ConstraintValidatorContext constraintValidatorContext) {
     HibernateConstraintValidatorContext context = constraintValidatorContext.unwrap( HibernateConstraintValidatorContext.class );

     context.addExpressionVariable( "foo", "bar" );
     context.buildConstraintViolationWithTemplate( "${foo}" )
            .addConstraintViolation();

     context.addExpressionVariable( "foo", "snafu" );
     context.buildConstraintViolationWithTemplate( "${foo}" )
            .addConstraintViolation();

     return false;
  }
  

 

Specified by:

addExpressionVariable in interface HibernateConstraintValidatorContext

Parameters:

name - the name under which to bind the expression variable, cannot be null

value - the value to be bound to the specified name

Returns:

a reference to itself to allow method chaining

addMessageParameter

public HibernateConstraintValidatorContext addMessageParameter(java.lang.String name,
                                                               java.lang.Object value)

Description copied from interface: HibernateConstraintValidatorContext

Allows to set an additional named parameter which can be interpolated in the constraint violation message. The variable will be available for interpolation for all constraint violations generated for this constraint. This includes the default one as well as all violations created by the ConstraintViolationBuilder. To create multiple constraint violations with different variable values, this method can be called between successive calls to ConstraintViolationBuilder#addConstraintViolation().

For example:

 
 public boolean isValid(String value, ConstraintValidatorContext constraintValidatorContext) {
     HibernateConstraintValidatorContext context = constraintValidatorContext.unwrap( HibernateConstraintValidatorContext.class );

     context.addMessageParameter( "foo", "bar" );
     context.buildConstraintViolationWithTemplate( "{foo}" )
            .addConstraintViolation();

     context.addMessageParameter( "foo", "snafu" );
     context.buildConstraintViolationWithTemplate( "{foo}" )
            .addConstraintViolation();

     return false;
  }
  

 

Specified by:

addMessageParameter in interface HibernateConstraintValidatorContext

Parameters:

name - the name under which to bind the parameter, cannot be null

value - the value to be bound to the specified name

Returns:

a reference to itself to allow method chaining

getClockProvider

public javax.validation.ClockProvider getClockProvider()

Specified by:

getClockProvider in interface javax.validation.ConstraintValidatorContext

withDynamicPayload

public HibernateConstraintValidatorContext withDynamicPayload(java.lang.Object violationContext)

Description copied from interface: HibernateConstraintValidatorContext

Allows to set an object that may further describe the violation. The user is responsible himself to ensure that this payload is serializable in case the javax.validation.ConstraintViolation has to be serialized.

Specified by:

withDynamicPayload in interface HibernateConstraintValidatorContext

Parameters:

violationContext - an object representing additional information about the violation

Returns:

a reference to itself to allow method chaining

getConstraintValidatorPayload

public <C> C getConstraintValidatorPayload(java.lang.Class<C> type)

Description copied from interface: HibernateConstraintValidatorContext

Returns an instance of the specified type or null if the current constraint validator payload isn't of the given type.

Specified by:

getConstraintValidatorPayload in interface HibernateConstraintValidatorContext

Parameters:

type - the type of payload to retrieve

Returns:

an instance of the specified type or null if the current constraint validator payload isn't of the given type

See Also:

HibernateValidatorConfiguration.constraintValidatorPayload(Object)

getConstraintDescriptor

public final javax.validation.metadata.ConstraintDescriptor<?> getConstraintDescriptor()

getConstraintViolationCreationContexts

public final java.util.List<ConstraintViolationCreationContext> getConstraintViolationCreationContexts()

getMethodParameterNames

public java.util.List<java.lang.String> getMethodParameterNames()