Package com.helixframework.validation.address

Annotation Interface ZipCode

@Target(FIELD)
@Retention(RUNTIME)
@Constraint(validatedBy=ZipCodeValidator.class)
public @interface ZipCode

Marks the field for zip code validation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ZipCode.Mode	Validation mode.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Class<?>[]	groups	Sets the error groups.
String	message	Sets the error message.
ZipCode.Mode	mode	Sets the validation mode.
Class<? extends jakarta.validation.Payload>[]	payload	Sets the error payload.

Element Details

mode

ZipCode.Mode mode

Sets the validation mode. Whether the validator is checking for standard zip codes or plus4 codes.

Returns:

validation mode

Default:

PLUS_4

message

String message

Sets the error message.

Returns:

error message

Default:

"Invalid zip code format."

groups

Class<?>[] groups

Sets the error groups.

Returns:

error groups

Default:

{}

payload

Class<? extends jakarta.validation.Payload>[] payload

Sets the error payload.

Returns:

error payload

Default:

{}