public class CalendarValidator extends AbstractCalendarValidator
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:
Locale
Locale
Locale
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:
Locale
Locale
Constructor and Description |
---|
CalendarValidator()
Construct a strict instance with short
date style.
|
CalendarValidator(boolean strict,
int dateStyle)
Construct an instance with the specified strict
and date style parameters.
|
Modifier and Type | Method and Description |
---|---|
static void |
adjustToTimeZone(Calendar value,
TimeZone timeZone)
Adjusts a Calendar's value to a different TimeZone.
|
int |
compareDates(Calendar value,
Calendar compare)
Compare Dates (day, month and year - not time).
|
int |
compareMonths(Calendar value,
Calendar compare)
Compare Months (month and year).
|
int |
compareQuarters(Calendar value,
Calendar compare)
Compare Quarters (quarter and year).
|
int |
compareQuarters(Calendar value,
Calendar compare,
int monthOfFirstQuarter)
Compare Quarters (quarter and year).
|
int |
compareWeeks(Calendar value,
Calendar compare)
Compare Weeks (week and year).
|
int |
compareYears(Calendar value,
Calendar compare)
Compare Years.
|
static CalendarValidator |
getInstance()
Return a singleton instance of this validator.
|
protected Object |
processParsedValue(Object value,
Format formatter)
Convert the parsed
Date to a Calendar . |
Calendar |
validate(String value)
Validate/convert a
Calendar using the default
Locale and TimeZone . |
Calendar |
validate(String value,
Locale locale)
Validate/convert a
Calendar using the specified
Locale and default TimeZone . |
Calendar |
validate(String value,
Locale locale,
TimeZone timeZone)
Validate/convert a
Calendar using the specified
Locale and TimeZone . |
Calendar |
validate(String value,
String pattern)
Validate/convert a
Calendar using the specified
pattern and default TimeZone . |
Calendar |
validate(String value,
String pattern,
Locale locale)
Validate/convert a
Calendar using the specified pattern
and Locale and the default TimeZone . |
Calendar |
validate(String value,
String pattern,
Locale locale,
TimeZone timeZone)
Validate/convert a
Calendar using the specified
pattern, and Locale and TimeZone . |
Calendar |
validate(String value,
String pattern,
TimeZone timeZone)
Validate/convert a
Calendar using the specified
pattern and TimeZone . |
Calendar |
validate(String value,
TimeZone timeZone)
Validate/convert a
Calendar using the specified
TimeZone and default Locale . |
compare, compareTime, format, format, format, format, format, format, getFormat, getFormat, isValid, parse
public CalendarValidator()
public CalendarValidator(boolean strict, int dateStyle)
strict
- true
if strict
Format
parsing should be used.dateStyle
- the date style to use for Locale validation.public static CalendarValidator getInstance()
public Calendar validate(String value)
Validate/convert a Calendar
using the default
Locale
and TimeZone
.
value
- The value validation is being performed on.Calendar
if valid or null
if invalid.public Calendar validate(String value, TimeZone timeZone)
Validate/convert a Calendar
using the specified
TimeZone
and default Locale
.
value
- The value validation is being performed on.timeZone
- The Time Zone used to parse the date, system default if null.Calendar
if valid or null
if invalid.public Calendar validate(String value, String pattern)
Validate/convert a Calendar
using the specified
pattern and default TimeZone
.
value
- The value validation is being performed on.pattern
- The pattern used to validate the value against.Calendar
if valid or null
if invalid.public Calendar validate(String value, String pattern, TimeZone timeZone)
Validate/convert a Calendar
using the specified
pattern and TimeZone
.
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.Calendar
if valid or null
if invalid.public Calendar validate(String value, Locale locale)
Validate/convert a Calendar
using the specified
Locale
and default TimeZone
.
value
- The value validation is being performed on.locale
- The locale to use for the date format, system default if null.Calendar
if valid or null
if invalid.public Calendar validate(String value, Locale locale, TimeZone timeZone)
Validate/convert a Calendar
using the specified
Locale
and TimeZone
.
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.Calendar
if valid or null
if invalid.public Calendar validate(String value, String pattern, Locale locale)
Validate/convert a Calendar
using the specified pattern
and Locale
and the default TimeZone
.
value
- The value validation is being performed on.pattern
- The pattern used to validate the value against, or the
default for the Locale
if null
.locale
- The locale to use for the date format, system default if null.Calendar
if valid or null
if invalid.public Calendar validate(String value, String pattern, Locale locale, TimeZone timeZone)
Validate/convert a Calendar
using the specified
pattern, and Locale
and TimeZone
.
value
- The value validation is being performed on.pattern
- The pattern used to validate the value against, or the
default for the Locale
if null
.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.Calendar
if valid or null
if invalid.public static void adjustToTimeZone(Calendar value, TimeZone timeZone)
Adjusts a Calendar's value to a different TimeZone.
value
- The value to adjust.timeZone
- The new time zone to use to adjust the Calendar to.public int compareDates(Calendar value, Calendar compare)
Compare Dates (day, month and year - not time).
value
- The Calendar
value to check.compare
- The Calendar
to compare the value to.public int compareWeeks(Calendar value, Calendar compare)
Compare Weeks (week and year).
value
- The Calendar
value to check.compare
- The Calendar
to compare the value to.public int compareMonths(Calendar value, Calendar compare)
Compare Months (month and year).
value
- The Calendar
value to check.compare
- The Calendar
to compare the value to.public int compareQuarters(Calendar value, Calendar compare)
Compare Quarters (quarter and year).
value
- The Calendar
value to check.compare
- The Calendar
to check the value against.public int compareQuarters(Calendar value, Calendar compare, int monthOfFirstQuarter)
Compare Quarters (quarter and year).
compareQuarters
in class AbstractCalendarValidator
value
- The Calendar
value to check.compare
- The Calendar
to compare the value to.monthOfFirstQuarter
- The month that the first quarter starts.public int compareYears(Calendar value, Calendar compare)
Compare Years.
value
- The Calendar
value to check.compare
- The Calendar
to compare the value to.protected Object processParsedValue(Object value, Format formatter)
Convert the parsed Date
to a Calendar
.
processParsedValue
in class AbstractCalendarValidator
value
- The parsed Date
object created.formatter
- The Format used to parse the value with.Calendar
.Copyright © 2002–2017 The Apache Software Foundation. All rights reserved.