com.github.robtimus.validation.month

Annotation Type MonthIs

@Documented
 @Constraint(validatedBy={MonthIsValidator.ForDate.class,MonthIsValidator.ForCalendar.class,MonthIsValidator.ForInstant.class,MonthIsValidator.ForLocalDate.class,MonthIsValidator.ForLocalDateTime.class,MonthIsValidator.ForMonth.class,MonthIsValidator.ForMonthDay.class,MonthIsValidator.ForOffsetDateTime.class,MonthIsValidator.ForYearMonth.class,MonthIsValidator.ForZonedDateTime.class})
 @Target(value={METHOD,FIELD,ANNOTATION_TYPE,CONSTRUCTOR,PARAMETER,TYPE_USE})
 @Retention(value=RUNTIME)
 @Repeatable(value=MonthIs.List.class)
public @interface MonthIs

Validates that the month of a date/time object is a given month. More specifically, for a date/time object object, validates that object.month == value.

Supported types are:

• Date
• Calendar
• Instant
• LocalDate
• LocalDateTime
• Month
• MonthDay
• OffsetDateTime
• YearMonth
• ZonedDateTime

null elements are considered valid.

Author:

Rob Spoor

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Month	value The required month.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>[]	groups The validation groups.
String	message The error message.
Class<? extends Payload>[]	payload The payload.
String	zoneId The zone id to use.

Element Detail

value

public abstract Month value

The required month.

message

public abstract String message

The error message.

Default:

"{com.github.robtimus.validation.month.MonthIs.message}"

groups

public abstract Class<?>[] groups

The validation groups.

Default:

{}

payload

public abstract Class<? extends Payload>[] payload

The payload.

Default:

{}

zoneId

public abstract String zoneId

The zone id to use. This should be system for the value returned by ZoneId.systemDefault(), provided for the zone id from the actual value, or otherwise a value that is accepted by ZoneId.of(String) for a specific zone id.

• For Calendar, OffsetDateTime and ZonedDateTime, if the zone id is not provided, the value is converted to the given zone id before extracting the month.
• For Date and Instant, no zone id is available, so provided is not allowed.
• For LocalDate, LocalDateTime, Month, MonthDay and YearMonth, no zone id is applicable, so only the default value (system) is allowed.

Default:

"system"