Constraints (Play 2.7.6)

java.lang.Object
- play.data.validation.Constraints

public class Constraints
extends java.lang.Object

Defines a set of built-in validation constraints.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Constraints.Email` Defines a email constraint for a string field.
`static class`	`Constraints.EmailValidator` Validator for `@Email` fields.
`static interface`	`Constraints.Max` Defines a maximum value for a numeric field.
`static interface`	`Constraints.MaxLength` Defines a maximum length for a string field.
`static class`	`Constraints.MaxLengthValidator` Validator for `@MaxLength` fields.
`static class`	`Constraints.MaxValidator` Validator for `@Max` fields.
`static interface`	`Constraints.Min` Defines a minimum value for a numeric field.
`static interface`	`Constraints.MinLength` Defines a minimum length for a string field.
`static class`	`Constraints.MinLengthValidator` Validator for `@MinLength` fields.
`static class`	`Constraints.MinValidator` Validator for `@Min` fields.
`static interface`	`Constraints.Pattern` Defines a pattern constraint for a string field.
`static class`	`Constraints.PatternValidator` Validator for `@Pattern` fields.
`static interface`	`Constraints.PlayConstraintValidator<A extends java.lang.annotation.Annotation,T>`
`static interface`	`Constraints.PlayConstraintValidatorWithPayload<A extends java.lang.annotation.Annotation,T>`
`static interface`	`Constraints.Required` Defines a field as required.
`static class`	`Constraints.RequiredValidator` Validator for `@Required` fields.
`static interface`	`Constraints.Validatable<T>`
`static interface`	`Constraints.ValidatableWithPayload<T>`
`static interface`	`Constraints.Validate`
`static interface`	`Constraints.ValidatePayloadWith` Defines a custom validator.
`static class`	`Constraints.ValidatePayloadWithValidator` Validator for `@ValidatePayloadWith` fields.
`static class`	`Constraints.ValidateValidator`
`static class`	`Constraints.ValidateValidatorWithPayload`
`static interface`	`Constraints.ValidateWith` Defines a custom validator.
`static interface`	`Constraints.ValidateWithPayload`
`static class`	`Constraints.ValidateWithValidator` Validator for `@ValidateWith` fields.
`static class`	`Constraints.ValidationPayload`
`static class`	`Constraints.Validator<T>` Super-type for validators.
`static class`	`Constraints.ValidatorWithPayload<T>` Super-type for validators with a payload.

Constructor Summary

Constructors
Constructor and Description

Constraints()

Constructors
Constructor and Description
`Constraints()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static F.Tuple<java.lang.String,java.util.List<java.lang.Object>>`	`displayableConstraint(javax.validation.metadata.ConstraintDescriptor<?> constraint)` Converts a constraint to a human-readable value.
`static java.util.List<F.Tuple<java.lang.String,java.util.List<java.lang.Object>>>`	`displayableConstraint(java.util.Set<javax.validation.metadata.ConstraintDescriptor<?>> constraints)` Converts a set of constraints to human-readable values.
`static java.util.List<F.Tuple<java.lang.String,java.util.List<java.lang.Object>>>`	`displayableConstraint(java.util.Set<javax.validation.metadata.ConstraintDescriptor<?>> constraints, java.lang.annotation.Annotation[] orderedAnnotations)` Converts a set of constraints to human-readable values in guaranteed order.
`static Constraints.Validator<java.lang.String>`	`email()` Constructs a 'email' validator.
`static Constraints.Validator<java.lang.Number>`	`max(long value)` Constructs a 'max' validator.
`static Constraints.Validator<java.lang.String>`	`maxLength(long value)` Constructs a 'maxLength' validator.
`static Constraints.Validator<java.lang.Number>`	`min(long value)` Constructs a 'min' validator.
`static Constraints.Validator<java.lang.String>`	`minLength(long value)` Constructs a 'minLength' validator.
`static Constraints.Validator<java.lang.String>`	`pattern(java.lang.String regex)` Constructs a 'pattern' validator.
`static Constraints.Validator<java.lang.Object>`	`required()` Constructs a 'required' validator.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Constraints
```
public Constraints()
```
- Method Detail
  - displayableConstraint
```
public static java.util.List<F.Tuple<java.lang.String,java.util.List<java.lang.Object>>> displayableConstraint(java.util.Set<javax.validation.metadata.ConstraintDescriptor<?>> constraints)
```
    Converts a set of constraints to human-readable values. Does not guarantee the order of the returned constraints.
    This method calls displayableConstraint under the hood.
    
    Parameters:
    
    constraints - the set of constraint descriptors.
    
    Returns:
    
    a list of pairs of tuples assembled from displayableConstraint.
  - displayableConstraint
```
public static java.util.List<F.Tuple<java.lang.String,java.util.List<java.lang.Object>>> displayableConstraint(java.util.Set<javax.validation.metadata.ConstraintDescriptor<?>> constraints,
                                                                                                               java.lang.annotation.Annotation[] orderedAnnotations)
```
    Converts a set of constraints to human-readable values in guaranteed order. Only constraints that have an annotation that intersect with the orderedAnnotations parameter will be considered. The order of the returned constraints corresponds to the order of the orderedAnnotations parameter.
    
    Parameters:
    
    constraints - the set of constraint descriptors.
    
    orderedAnnotations - the array of annotations
    
    Returns:
    
    a list of tuples showing readable constraints.
  - displayableConstraint
```
public static F.Tuple<java.lang.String,java.util.List<java.lang.Object>> displayableConstraint(javax.validation.metadata.ConstraintDescriptor<?> constraint)
```
    Converts a constraint to a human-readable value.
    
    Parameters:
    
    constraint - the constraint descriptor.
    
    Returns:
    
    A tuple containing the constraint's display name and the constraint attributes.
  - required
```
public static Constraints.Validator<java.lang.Object> required()
```
    Constructs a 'required' validator.
    
    Returns:
    
    the RequiredValidator
  - min
```
public static Constraints.Validator<java.lang.Number> min(long value)
```
    Constructs a 'min' validator.
    
    Parameters:
    
    value - the minimum value
    
    Returns:
    
    a validator for number.
  - max
```
public static Constraints.Validator<java.lang.Number> max(long value)
```
    Constructs a 'max' validator.
    
    Parameters:
    
    value - maximum value
    
    Returns:
    
    a validator using MaxValidator.
  - minLength
```
public static Constraints.Validator<java.lang.String> minLength(long value)
```
    Constructs a 'minLength' validator.
    
    Parameters:
    
    value - the minimum length value.
    
    Returns:
    
    the MinLengthValidator
  - maxLength
```
public static Constraints.Validator<java.lang.String> maxLength(long value)
```
    Constructs a 'maxLength' validator.
    
    Parameters:
    
    value - the max length
    
    Returns:
    
    the MaxLengthValidator
  - email
```
public static Constraints.Validator<java.lang.String> email()
```
    Constructs a 'email' validator.
    
    Returns:
    
    the EmailValidator
  - pattern
```
public static Constraints.Validator<java.lang.String> pattern(java.lang.String regex)
```
    Constructs a 'pattern' validator.
    
    Parameters:
    
    regex - the regular expression to match.
    
    Returns:
    
    the PatternValidator.

Class Constraints

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Constraints

Method Detail

displayableConstraint

displayableConstraint

displayableConstraint

required

min

max

minLength

maxLength

email

pattern