Module jakarta.validation

Package jakarta.validation.constraints

Annotation Interface Pattern

@Target({METHOD,FIELD,ANNOTATION_TYPE,CONSTRUCTOR,PARAMETER,TYPE_USE})
@Retention(RUNTIME)
@Repeatable(Pattern.List.class)
@Documented
@Constraint(validatedBy={})
public @interface Pattern

The annotated CharSequence must match the specified regular expression. The regular expression follows the Java regular expression conventions see Pattern.

Accepts CharSequence. null elements are considered valid.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Pattern.Flag	Possible Regexp flags.
static @interface	Pattern.List	Defines several Pattern annotations on the same element.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	regexp

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Pattern.Flag[]	flags
Class<?>[]	groups
String	message
Class<? extends Payload>[]	payload

Element Details

regexp

String regexp

Returns:

the regular expression to match

flags

Pattern.Flag[] flags

Returns:

array of Flags considered when resolving the regular expression

Default:

{}

message

String message

Returns:

the error message template

Default:

"{jakarta.validation.constraints.Pattern.message}"

groups

Class<?>[] groups

Returns:

the groups the constraint belongs to

Default:

{}

payload

Class<? extends Payload>[] payload

Returns:

the payload associated to the constraint

Default:

{}