Class CalendarValidator
- All Implemented Interfaces:
Serializable
Calendar Validation and Conversion routines (java.util.Calendar).
This validator provides a number of methods for validating/converting
a String date value to a java.util.Calendar using
java.text.DateFormat to parse either:
- using the default format for the default
Locale - using a specified pattern with the default
Locale - using the default format for a specified
Locale - using a specified pattern with a specified
Locale
For each of the above mechanisms, conversion method (i.e the
validate methods) implementations are provided which
either use the default TimeZone or allow the
TimeZone to be specified.
Use one of the isValid() methods to just validate or
one of the validate() methods to validate and receive a
converted Calendar value.
Implementations of the validate() method are provided
to create Calendar objects for different time zones
if the system default is not appropriate.
Alternatively the CalendarValidator's adjustToTimeZone() method
can be used to adjust the TimeZone of the Calendar
object afterwards.
Once a value has been successfully converted the following methods can be used to perform various date comparison checks:
compareDates()compares the day, month and year of two calendars, returning 0, -1 or +1 indicating whether the first date is equal, before or after the second.compareWeeks()compares the week and year of two calendars, returning 0, -1 or +1 indicating whether the first week is equal, before or after the second.compareMonths()compares the month and year of two calendars, returning 0, -1 or +1 indicating whether the first month is equal, before or after the second.compareQuarters()compares the quarter and year of two calendars, returning 0, -1 or +1 indicating whether the first quarter is equal, before or after the second.compareYears()compares the year of two calendars, returning 0, -1 or +1 indicating whether the first year is equal, before or after the second.
So that the same mechanism used for parsing an input value
for validation can be used to format output, corresponding
format() methods are also provided. That is you can
format either:
- using a specified pattern
- using the format for a specified
Locale - using the format for the default
Locale
- Since:
- 1.3.0
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs a strict instance with short date style.CalendarValidator(boolean strict, int dateStyle) Constructs an instance with the specified strict and date style parameters. -
Method Summary
Modifier and TypeMethodDescriptionstatic voidadjustToTimeZone(Calendar value, TimeZone timeZone) Adjusts a Calendar's value to a different TimeZone.intcompareDates(Calendar value, Calendar compare) Compare Dates (day, month and year - not time).intcompareMonths(Calendar value, Calendar compare) Compare Months (month and year).intcompareQuarters(Calendar value, Calendar compare) Compare Quarters (quarter and year).intcompareQuarters(Calendar value, Calendar compare, int monthOfFirstQuarter) Compare Quarters (quarter and year).intcompareWeeks(Calendar value, Calendar compare) Compare Weeks (week and year).intcompareYears(Calendar value, Calendar compare) Compare Years.static CalendarValidatorGets the singleton instance of this validator.protected ObjectprocessParsedValue(Object value, Format formatter) Convert the parsedDateto aCalendar.Validate/convert aCalendarusing the defaultLocaleandTimeZone.Validate/convert aCalendarusing the specified pattern and defaultTimeZone.Validate/convert aCalendarusing the specified pattern andLocaleand the defaultTimeZone.Validate/convert aCalendarusing the specified pattern, andLocaleandTimeZone.Validate/convert aCalendarusing the specified pattern andTimeZone.Validate/convert aCalendarusing the specifiedLocaleand defaultTimeZone.Validate/convert aCalendarusing the specifiedLocaleandTimeZone.Validate/convert aCalendarusing the specifiedTimeZoneand defaultLocale.Methods inherited from class org.apache.commons.validator.routines.AbstractCalendarValidator
compare, compareTime, format, format, format, format, format, format, getFormat, getFormat, isValid, parse
-
Constructor Details
-
CalendarValidator
public CalendarValidator()Constructs a strict instance with short date style. -
CalendarValidator
Constructs an instance with the specified strict and date style parameters.- Parameters:
strict-trueif strictFormatparsing should be used.dateStyle- the date style to use for Locale validation.
-
-
Method Details
-
adjustToTimeZone
Adjusts a Calendar's value to a different TimeZone.
- Parameters:
value- The value to adjust.timeZone- The new time zone to use to adjust the Calendar to.
-
getInstance
Gets the singleton instance of this validator.- Returns:
- A singleton instance of the CalendarValidator.
-
compareDates
Compare Dates (day, month and year - not time).
- Parameters:
value- TheCalendarvalue to check.compare- TheCalendarto compare the value to.- Returns:
- Zero if the dates are equal, -1 if first date is less than the seconds and +1 if the first date is greater than.
-
compareMonths
Compare Months (month and year).
- Parameters:
value- TheCalendarvalue to check.compare- TheCalendarto compare the value to.- Returns:
- Zero if the months are equal, -1 if first parameter's month is less than the seconds and +1 if the first parameter's month is greater than.
-
compareQuarters
Compare Quarters (quarter and year).
- Parameters:
value- TheCalendarvalue to check.compare- TheCalendarto check the value against.- Returns:
- Zero if the quarters are equal, -1 if first parameter's quarter is less than the seconds and +1 if the first parameter's quarter is greater than.
-
compareQuarters
Compare Quarters (quarter and year).
- Overrides:
compareQuartersin classAbstractCalendarValidator- Parameters:
value- TheCalendarvalue to check.compare- TheCalendarto compare the value to.monthOfFirstQuarter- The month that the first quarter starts.- Returns:
- Zero if the quarters are equal, -1 if first parameter's quarter is less than the seconds and +1 if the first parameter's quarter is greater than.
-
compareWeeks
Compare Weeks (week and year).
- Parameters:
value- TheCalendarvalue to check.compare- TheCalendarto compare the value to.- Returns:
- Zero if the weeks are equal, -1 if first parameter's week is less than the seconds and +1 if the first parameter's week is greater than.
-
compareYears
Compare Years.
- Parameters:
value- TheCalendarvalue to check.compare- TheCalendarto compare the value to.- Returns:
- Zero if the years are equal, -1 if first parameter's year is less than the seconds and +1 if the first parameter's year is greater than.
-
processParsedValue
Convert the parsed
Dateto aCalendar.- Specified by:
processParsedValuein classAbstractCalendarValidator- Parameters:
value- The parsedDateobject created.formatter- The Format used to parse the value with.- Returns:
- The parsed value converted to a
Calendar.
-
validate
Validate/convert a
Calendarusing the defaultLocaleandTimeZone.- Parameters:
value- The value validation is being performed on.- Returns:
- The parsed
Calendarif valid ornullif invalid.
-
validate
Validate/convert a
Calendarusing the specifiedLocaleand defaultTimeZone.- Parameters:
value- The value validation is being performed on.locale- The locale to use for the date format, system default if null.- Returns:
- The parsed
Calendarif valid ornullif invalid.
-
validate
Validate/convert a
Calendarusing the specifiedLocaleandTimeZone.- Parameters:
value- The value validation is being performed on.locale- The locale to use for the date format, system default if null.timeZone- The Time Zone used to parse the date, system default if null.- Returns:
- The parsed
Calendarif valid ornullif invalid.
-
validate
Validate/convert a
Calendarusing the specified pattern and defaultTimeZone.- Parameters:
value- The value validation is being performed on.pattern- The pattern used to validate the value against.- Returns:
- The parsed
Calendarif valid ornullif invalid.
-
validate
Validate/convert a
Calendarusing the specified pattern andLocaleand the defaultTimeZone.- Parameters:
value- The value validation is being performed on.pattern- The pattern used to validate the value against, or the default for theLocaleifnull.locale- The locale to use for the date format, system default if null.- Returns:
- The parsed
Calendarif valid ornullif invalid.
-
validate
Validate/convert a
Calendarusing the specified pattern, andLocaleandTimeZone.- Parameters:
value- The value validation is being performed on.pattern- The pattern used to validate the value against, or the default for theLocaleifnull.locale- The locale to use for the date format, system default if null.timeZone- The Time Zone used to parse the date, system default if null.- Returns:
- The parsed
Calendarif valid ornullif invalid.
-
validate
Validate/convert a
Calendarusing the specified pattern andTimeZone.- Parameters:
value- The value validation is being performed on.pattern- The pattern used to validate the value against.timeZone- The Time Zone used to parse the date, system default if null.- Returns:
- The parsed
Calendarif valid ornullif invalid.
-
validate
Validate/convert a
Calendarusing the specifiedTimeZoneand defaultLocale.- Parameters:
value- The value validation is being performed on.timeZone- The Time Zone used to parse the date, system default if null.- Returns:
- The parsed
Calendarif valid ornullif invalid.
-