Class ContainerElementConstraintMappingContextImpl
- java.lang.Object
-
- org.hibernate.validator.internal.cfg.context.ContainerElementConstraintMappingContextImpl
-
- All Implemented Interfaces:
Cascadable<ContainerElementConstraintMappingContext>,Constrainable<ContainerElementConstraintMappingContext>,ConstraintDefinitionTarget,ConstraintMappingTarget,ConstructorTarget,ContainerElementConstraintMappingContext,ContainerElementTarget,MethodTarget,ParameterTarget,PropertyTarget,ReturnValueTarget,TypeTarget
public class ContainerElementConstraintMappingContextImpl extends Object implements ContainerElementConstraintMappingContext
- Author:
- Gunnar Morling
-
-
Field Summary
Fields Modifier and Type Field Description protected Map<Class<?>,Class<?>>groupConversionsprotected booleanisCascadingprotected DefaultConstraintMappingmappingprotected Map<Integer,ContainerElementConstraintMappingContextImpl>nestedContainerElementContextsContexts for configuring nested container elements, if any.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected voidaddConstraint(org.hibernate.validator.internal.cfg.context.ConfiguredConstraint<?> constraint)Adds a constraint to the set of constraints managed by this creational context.voidaddGroupConversion(Class<?> from, Class<?> to)Adds a group conversion for this element.ContainerElementConstraintMappingContextconstraint(ConstraintDef<?,?> definition)Adds a new constraint.<A extends Annotation>
ConstraintDefinitionContext<A>constraintDefinition(Class<A> annotationClass)ConstructorConstraintMappingContextconstructor(Class<?>... parameterTypes)Selects a constructor to which the next operations shall apply.ContainerElementConstraintMappingContextcontainerElement(ContainerElementTarget parent, TypeConstraintMappingContextImpl<?> typeContext, ConstraintLocation location)ContainerElementConstraintMappingContextcontainerElement(ContainerElementTarget parent, TypeConstraintMappingContextImpl<?> typeContext, ConstraintLocation location, int index, int... nestedIndexes)ContainerElementConstraintMappingContextcontainerElementType()Selects the single type argument of the current element's generic type as the target for the next operations.ContainerElementConstraintMappingContextcontainerElementType(int index, int... nestedIndexes)Selects the single type argument of the current element's generic type as the target for the next operations.GroupConversionTargetContext<C>convertGroup(Class<?> from)Adds a group conversion for this cascadable element.PropertyConstraintMappingContextfield(String property)Selects a field to which the next operations shall apply.protected CascadingMetaDataBuildergetCascadingMetaDataBuilder()protected DefaultConstraintMappinggetConstraintMapping()protected Set<MetaConstraint<?>>getConstraints(ConstraintCreationContext constraintCreationContext)protected ConstraintDescriptorImpl.ConstraintTypegetConstraintType()Returns the type of constraints hosted on the element configured by this creational context.PropertyConstraintMappingContextgetter(String property)Selects a getter to which the next operations shall apply.protected ContainerElementConstraintMappingContextgetThis()Returns this object, narrowed down to the specific sub-type.protected Set<MetaConstraint<?>>getTypeArgumentConstraints(ConstraintCreationContext constraintCreationContext)booleanisCascading()MethodConstraintMappingContextmethod(String name, Class<?>... parameterTypes)Selects a method to which the next operations shall apply.ParameterConstraintMappingContextparameter(int index)Changes the parameter for which added constraints apply.PropertyConstraintMappingContextproperty(String property, ElementType elementType)Deprecated.ReturnValueConstraintMappingContextreturnValue()Selects the current method's return value as the target for the next operations.StringtoString()<C> TypeConstraintMappingContext<C>type(Class<C> type)Cvalid()Marks the current element (property, parameter etc.) as cascadable.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.hibernate.validator.cfg.context.Cascadable
convertGroup, valid
-
Methods inherited from interface org.hibernate.validator.cfg.context.ConstraintDefinitionTarget
constraintDefinition
-
Methods inherited from interface org.hibernate.validator.cfg.context.TypeTarget
type
-
-
-
-
Field Detail
-
nestedContainerElementContexts
protected final Map<Integer,ContainerElementConstraintMappingContextImpl> nestedContainerElementContexts
Contexts for configuring nested container elements, if any. Indexed by type parameter.
-
isCascading
protected boolean isCascading
-
mapping
protected final DefaultConstraintMapping mapping
-
-
Method Detail
-
getThis
protected ContainerElementConstraintMappingContext getThis()
Returns this object, narrowed down to the specific sub-type.- Returns:
- this object, narrowed down to the specific sub-type
- See Also:
- "Get this" trick
-
property
@Deprecated public PropertyConstraintMappingContext property(String property, ElementType elementType)
Deprecated.Description copied from interface:PropertyTargetSelects a property to which the next operations shall apply.Until this method is called constraints apply on class level. After calling this method constraints apply on the specified property with the given access type.
A given property may only be configured once.
- Specified by:
propertyin interfacePropertyTarget- Parameters:
property- The property on which to apply the following constraints (Java Bean notation).elementType- The access type (field/property).- Returns:
- A creational context representing the selected property.
-
field
public PropertyConstraintMappingContext field(String property)
Description copied from interface:PropertyTargetSelects a field to which the next operations shall apply.Until this method is called constraints apply on class level. After calling this method constraints apply on the specified field property.
A given field may only be configured once.
- Specified by:
fieldin interfacePropertyTarget- Parameters:
property- The field name that represents a property on which to apply the following constraints.- Returns:
- A creational context representing the selected field property.
-
getter
public PropertyConstraintMappingContext getter(String property)
Description copied from interface:PropertyTargetSelects a getter to which the next operations shall apply.Until this method is called constraints apply on class level. After calling this method constraints apply on the specified getter property.
A given getter may only be configured once.
- Specified by:
getterin interfacePropertyTarget- Parameters:
property- The getter property name (using the Java Bean notation, e.g.nameto addressgetName()) that represents a property on which to apply the following constraints.- Returns:
- A creational context representing the selected getter property.
-
constructor
public ConstructorConstraintMappingContext constructor(Class<?>... parameterTypes)
Description copied from interface:ConstructorTargetSelects a constructor to which the next operations shall apply.Until this method is called constraints apply on class level. After calling this method constraints apply to the specified constructor.
A given constructor may only be configured once.
- Specified by:
constructorin interfaceConstructorTarget- Parameters:
parameterTypes- The constructor parameter types.- Returns:
- A creational context representing the selected constructor.
-
method
public MethodConstraintMappingContext method(String name, Class<?>... parameterTypes)
Description copied from interface:MethodTargetSelects a method to which the next operations shall apply.Until this method is called constraints apply on class level. After calling this method constraints apply to the specified method.
A given method may only be configured once.
- Specified by:
methodin interfaceMethodTarget- Parameters:
name- The method name.parameterTypes- The method parameter types.- Returns:
- A creational context representing the selected method.
-
parameter
public ParameterConstraintMappingContext parameter(int index)
Description copied from interface:ParameterTargetChanges the parameter for which added constraints apply. A given parameter may only be configured once.- Specified by:
parameterin interfaceParameterTarget- Parameters:
index- The parameter index.- Returns:
- A creational context representing the selected parameter.
-
returnValue
public ReturnValueConstraintMappingContext returnValue()
Description copied from interface:ReturnValueTargetSelects the current method's return value as the target for the next operations. The return value of one method or constructor may only be configured more once.- Specified by:
returnValuein interfaceReturnValueTarget- Returns:
- A creational context representing the current method's or constructor's return value.
-
containerElementType
public ContainerElementConstraintMappingContext containerElementType()
Description copied from interface:ContainerElementTargetSelects the single type argument of the current element's generic type as the target for the next operations. Selects the component type if the current element is of an array type.- Specified by:
containerElementTypein interfaceContainerElementTarget- Returns:
- A creational context representing the single type argument or the component type of the current element's type.
-
containerElementType
public ContainerElementConstraintMappingContext containerElementType(int index, int... nestedIndexes)
Description copied from interface:ContainerElementTargetSelects the single type argument of the current element's generic type as the target for the next operations. Selects the component type if the current element is of an array type.- Specified by:
containerElementTypein interfaceContainerElementTarget- Parameters:
index- The index of the type argument to configure. Pass 0 when navigating into an array type.nestedIndexes- the nested index(es) in case the container element to configure is a generic type within another generic type, e.g.List<Map<String, String>>, a multi-dimensional array or a combination of (nested) parameterized and array types.- Returns:
- A creational context representing the specified type argument.
-
constraint
public ContainerElementConstraintMappingContext constraint(ConstraintDef<?,?> definition)
Description copied from interface:ConstrainableAdds a new constraint.- Specified by:
constraintin interfaceConstrainable<ContainerElementConstraintMappingContext>- Parameters:
definition- The constraint to add.- Returns:
- The current creational context following the method chaining pattern.
-
getConstraintType
protected ConstraintDescriptorImpl.ConstraintType getConstraintType()
Returns the type of constraints hosted on the element configured by this creational context.- Returns:
- the type of constraints hosted on the element configured by this creational context
-
addGroupConversion
public void addGroupConversion(Class<?> from, Class<?> to)
Adds a group conversion for this element.- Parameters:
from- the source group of the conversionto- the target group of the conversion
-
valid
public C valid()
Description copied from interface:CascadableMarks the current element (property, parameter etc.) as cascadable.- Specified by:
validin interfaceCascadable<C extends Cascadable<C>>- Returns:
- The current creational context following the method chaining pattern.
-
convertGroup
public GroupConversionTargetContext<C> convertGroup(Class<?> from)
Description copied from interface:CascadableAdds a group conversion for this cascadable element. Several conversions may be configured for one element.- Specified by:
convertGroupin interfaceCascadable<C extends Cascadable<C>>- Parameters:
from- the source group of the conversion to be configured- Returns:
- a creational context allow to set the target group of the conversion
-
containerElement
public ContainerElementConstraintMappingContext containerElement(ContainerElementTarget parent, TypeConstraintMappingContextImpl<?> typeContext, ConstraintLocation location)
-
containerElement
public ContainerElementConstraintMappingContext containerElement(ContainerElementTarget parent, TypeConstraintMappingContextImpl<?> typeContext, ConstraintLocation location, int index, int... nestedIndexes)
-
isCascading
public boolean isCascading()
-
getTypeArgumentConstraints
protected Set<MetaConstraint<?>> getTypeArgumentConstraints(ConstraintCreationContext constraintCreationContext)
-
getCascadingMetaDataBuilder
protected CascadingMetaDataBuilder getCascadingMetaDataBuilder()
-
getConstraintMapping
protected DefaultConstraintMapping getConstraintMapping()
-
addConstraint
protected void addConstraint(org.hibernate.validator.internal.cfg.context.ConfiguredConstraint<?> constraint)
Adds a constraint to the set of constraints managed by this creational context.- Parameters:
constraint- the constraint to add
-
getConstraints
protected Set<MetaConstraint<?>> getConstraints(ConstraintCreationContext constraintCreationContext)
-
type
public <C> TypeConstraintMappingContext<C> type(Class<C> type)
-
constraintDefinition
public <A extends Annotation> ConstraintDefinitionContext<A> constraintDefinition(Class<A> annotationClass)
-
-