org.resthub.web.validation

Class ModelConstraint

java.lang.Object

org.resthub.web.validation.ModelConstraint

public class ModelConstraint
extends Object

Object representation of validation constraints defined on a model domain object (POJO). Instances of this class can be easily serialized in JSON or XML format thanks to dedicated Jackson configuration.

Sample JSON serialization:

 {
   "model": "org.resthub.validation.model.User",
      "constraints": {
          "lastName": [{
              "type": "NotBlank",
              "message": "may not be empty"
          }],
          "email": [{
              "type": "NotNull",
              "message": "may not be null"
           }, {
              "type": "Email",
              "message": "not a well-formed email address",
              "flags": [],
              "regexp": ".*"
          }],
          "login": [{
              "type": "NotNull",
              "message": "may not be null"
          }, {
              "type": "Length",
              "message": "length must be between 8 and 2147483647",
              "min": 8,
              "max": 2147483647
          }],
          "firstName": [{
              "type": "NotBlank",
              "message": "may not be empty"
          }]
      }
 }
 

Sample XML serialization:

 < ModelConstraint>
      < model>org.resthub.validation.model.User
      < constraints>
          < lastName>
              < type>NotBlank
              < message>may not be empty
          < /lastName>
          < email>
              < type>NotNull
              < message>may not be null
          < /email>
          < email>
              < type>Email
              < message>not a well-formed email address
              < regexp>.*
          < /email>
          < login>
              < type>NotNull
              < message>may not be null
          < /login>
          < login>
              < type>Length
              < message>length must be between 8 and 2147483647
              < min>8
              < max>2147483647
          < /login>
          < firstName>
              < type>NotBlank
              < message>may not be empty
          < /firstName>
      < /constraints>
 < /ModelConstraint>
 

See Also:

ValidationConstraint

Constructor Summary

Constructors

Constructor and Description
ModelConstraint(String modelRef)

Method Summary

Methods

Modifier and Type	Method and Description
List<ValidationConstraint>	addConstraint(String property, ValidationConstraint constraint) Add a ValidationConstraint for a given property for the current represented model
boolean	equals(Object o)
Map<String,List<ValidationConstraint>>	getConstraints()
String	getModelRef()
int	hashCode()
void	setConstraints(Map<String,List<ValidationConstraint>> constraints)
void	setModelRef(String modelRef)

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelConstraint

public ModelConstraint(String modelRef)

Method Detail

getModelRef

public String getModelRef()

setModelRef

public void setModelRef(String modelRef)

getConstraints

public Map<String,List<ValidationConstraint>> getConstraints()

setConstraints

public void setConstraints(Map<String,List<ValidationConstraint>> constraints)

addConstraint

public List<ValidationConstraint> addConstraint(String property,
                                       ValidationConstraint constraint)

Add a ValidationConstraint for a given property for the current represented model

Parameters:

property - model property holding the constraint

constraint - ValidationConstraint instance to add to model constraints definitions

Returns:

the updated list of ValidationConstraint for the given property parameter.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object