Size class
A constraint on the length of a string, or the number of entries of a list, set or map: from min to max, both included.
Use it for limits such as a name of 2 to 20 characters or at most 5
tags; the limits often mirror a database column. null passes (add
NotNull to require a value), and Size(min: 1) does not reject
' ' (use NotBlank). The arguments of a field error are
[field, max, min], so a message such as Size={0} has {2} to {1} characters can show the limits. On a value of another type the
generator fails the build and the validator throws an
UnexpectedTypeException; invalid limits throw a
ConstraintDeclarationException.
In Flutter apps the class is exported as SizeConstraint, since
Flutter has a Size class of its own.
// A display name of 2 to 20 characters.
@Introspected()
class Signup {
@Size(min: 2, max: 20)
String name = '';
}
Spring (Java):
class Signup {
@Size(min = 2, max = 20)
private String name;
}
- Inheritance
-
- Object
- Constraint
- Size
Constructors
Properties
-
attributes
→ Map<
String, Object?> -
The settings of the constraint by name, such as
{'max': 20, 'min': 0}: they fill the{max}placeholders of messages and, sorted by name, become the arguments{1},{2}, ... of field errors. Empty by default; override it when a custom constraint has settings.no setteroverride - defaultMessage → String
-
The text of a violation when message is not set, with the same
placeholders, such as
size must be between {min} and {max}.no setteroverride -
groups
→ List<
Type> -
The validation groups the constraint belongs to, such as
[OnUpdate]; it is only checked when one of them is asked for. Empty means Default.finalinherited - hashCode → int
-
The hash code for this object.
no setterinherited
- max → int
-
The largest allowed length, included; by default 2147483647 (Java's
Integer.MAX_VALUE), so no limit. Must not be below min.final - message → String?
-
The text of a violation instead of defaultMessage;
nullkeeps the default.finalinherited - min → int
-
The smallest allowed length, included;
0by default. Must not be negative.final - name → String
-
The error code of a violation, such as
NotBlank: the start of the message codes (NotBlank.signup.name, ...,NotBlank) and the Jakarta name of the constraint. Custom constraints usually return their class name.no setteroverride - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
appliesTo(
List< Type> requested) → bool -
Whether the constraint is checked when a validation asks for the
requestedgroups: when one of its groups is requested.inherited -
checkParameters(
) → void -
Throws a ConstraintDeclarationException when the constraint's own
settings are invalid:
Size(min: -1),min > max, a malformed regular expression. Does nothing by default.override -
interpolate(
String template) → String -
templatewith its{attribute}placeholders replaced by the values of attributes; other placeholders and${...}expressions stay, and the escapes\{,\},\$,\\become the literal characters.inherited -
interpolatedMessage(
) → String -
message, or defaultMessage, with the
{attribute}placeholders filled in; message keys and${...}expressions stay, since only the validator can resolve them.inherited -
isValid(
Object? value) → bool -
Whether
valuesatisfies the constraint; the method a custom constraint implements.override -
isValidWithContext(
Object? value, ConstraintValidatorContext context) → bool -
Whether
valuesatisfies the constraint, with access to the validationcontext; the methodBeanValidatorcalls. By default it returns isValid.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
supports(
Object value) → bool -
Whether the constraint can check a value of this type at all;
valueis nevernull.@Sizesupports strings, collections and maps, not anint.override -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited