| java.lang.Object
 org.apache.commons.validator.routines.AbstractFormatValidator
org.apache.commons.validator.routines.AbstractCalendarValidator
org.apache.commons.validator.routines.DateValidator
| DateValidator | | public class DateValidator extends AbstractCalendarValidator (Code) | | Date Validation and Conversion routines (java.util.Date).
This validator provides a number of methods for validating/converting
a String date value to a java.util.Date 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 Date value.
Implementations of the validate() method are provided
to create Date objects for different time zones
if the system default is not appropriate.
Once a value has been sucessfully converted the following
methods can be used to perform various date comparison checks:
compareDates() compares the day, month and
year of two dates, returing 0, -1 or +1 indicating
whether the first date is equal, before or after the second.compareWeeks() compares the week and
year of two dates, returing 0, -1 or +1 indicating
whether the first week is equal, before or after the second.compareMonths() compares the month and
year of two dates, returing 0, -1 or +1 indicating
whether the first month is equal, before or after the second.compareQuarters() compares the quarter and
year of two dates, returing 0, -1 or +1 indicating
whether the first quarter is equal, before or after the second.compareYears() compares the
year of two dates, returing 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
version:
$Revision: 478334 $ $Date: 2006-11-22 21:31:54 +0000 (Wed, 22 Nov 2006) $
since:
Validator 1.3.0 |
| Constructor Summary | |
| public | DateValidator()
Construct a strict instance with short
date style. | | public | DateValidator(boolean strict, int dateStyle)
Construct an instance with the specified strict
and date style parameters. |
| Method Summary | |
| public int | compareDates(Date value, Date compare, TimeZone timeZone)
Compare Dates (day, month and year - not time).
Parameters:
value - The Calendar value to check.
Parameters:
compare - The Calendar to compare the value to.
Parameters:
timeZone - The Time Zone used to compare the dates, system default if null. | | public int | compareMonths(Date value, Date compare, TimeZone timeZone)
Compare Months (month and year).
Parameters:
value - The Date value to check.
Parameters:
compare - The Date to compare the value to.
Parameters:
timeZone - The Time Zone used to compare the dates, system default if null. | | public int | compareQuarters(Date value, Date compare, TimeZone timeZone)
Compare Quarters (quarter and year).
Parameters:
value - The Date value to check.
Parameters:
compare - The Date to compare the value to.
Parameters:
timeZone - The Time Zone used to compare the dates, system default if null. | | public int | compareQuarters(Date value, Date compare, TimeZone timeZone, int monthOfFirstQuarter)
Compare Quarters (quarter and year).
Parameters:
value - The Date value to check.
Parameters:
compare - The Date to compare the value to.
Parameters:
timeZone - The Time Zone used to compare the dates, system default if null.
Parameters:
monthOfFirstQuarter - The month that the first quarter starts. | | public int | compareWeeks(Date value, Date compare, TimeZone timeZone)
Compare Weeks (week and year).
Parameters:
value - The Date value to check.
Parameters:
compare - The Date to compare the value to.
Parameters:
timeZone - The Time Zone used to compare the dates, system default if null. | | public int | compareYears(Date value, Date compare, TimeZone timeZone)
Compare Years.
Parameters:
value - The Date value to check.
Parameters:
compare - The Date to compare the value to.
Parameters:
timeZone - The Time Zone used to compare the dates, system default if null. | | public static DateValidator | getInstance()
Return a singleton instance of this validator. | | protected Object | processParsedValue(Object value, Format formatter)
Returns the parsed Date unchanged.
Parameters:
value - The parsed Date object created.
Parameters:
formatter - The Format used to parse the value with. | | public Date | validate(String value)
Validate/convert a Date using the default
Locale and TimeZone. | | public Date | validate(String value, TimeZone timeZone)
Validate/convert a Date using the specified
TimeZone and default Locale.
Parameters:
value - The value validation is being performed on.
Parameters:
timeZone - The Time Zone used to parse the date, system default if null. | | public Date | validate(String value, String pattern)
Validate/convert a Date using the specified
pattern and default TimeZone.
Parameters:
value - The value validation is being performed on.
Parameters:
pattern - The pattern used to validate the value against, or thedefault for the Locale if null. | | public Date | validate(String value, String pattern, TimeZone timeZone)
Validate/convert a Date using the specified
pattern and TimeZone.
Parameters:
value - The value validation is being performed on.
Parameters:
pattern - The pattern used to validate the value against, or thedefault for the Locale if null.
Parameters:
timeZone - The Time Zone used to parse the date, system default if null. | | public Date | validate(String value, Locale locale)
Validate/convert a Date using the specified
Locale and default TimeZone.
Parameters:
value - The value validation is being performed on.
Parameters:
locale - The locale to use for the date format, system default if null. | | public Date | validate(String value, Locale locale, TimeZone timeZone)
Validate/convert a Date using the specified
Locale and TimeZone.
Parameters:
value - The value validation is being performed on.
Parameters:
locale - The locale to use for the date format, system default if null.
Parameters:
timeZone - The Time Zone used to parse the date, system default if null. | | public Date | validate(String value, String pattern, Locale locale)
Validate/convert a Date using the specified pattern
and Locale and the default TimeZone.
Parameters:
value - The value validation is being performed on.
Parameters:
pattern - The pattern used to validate the value against, or thedefault for the Locale if null.
Parameters:
locale - The locale to use for the date format, system default if null. | | public Date | validate(String value, String pattern, Locale locale, TimeZone timeZone)
Validate/convert a Date using the specified
pattern, and Locale and TimeZone.
Parameters:
value - The value validation is being performed on.
Parameters:
pattern - The pattern used to validate the value against, or thedefault for the Locale if null.
Parameters:
locale - The locale to use for the date format, system default if null.
Parameters:
timeZone - The Time Zone used to parse the date, system default if null. |
| DateValidator | | public DateValidator()(Code) | | Construct a strict instance with short
date style.
|
| DateValidator | | public DateValidator(boolean strict, int dateStyle)(Code) | | Construct an instance with the specified strict
and date style parameters.
Parameters:
strict - true if strict Format parsing should be used.
Parameters:
dateStyle - the date style to use for Locale validation. |
| compareDates | | public int compareDates(Date value, Date compare, TimeZone timeZone)(Code) | | Compare Dates (day, month and year - not time).
Parameters:
value - The Calendar value to check.
Parameters:
compare - The Calendar to compare the value to.
Parameters:
timeZone - The Time Zone used to compare the dates, system default if null. Zero if the dates are equal, -1 if firstdate is less than the seconds and +1 if the firstdate is greater than. |
| compareMonths | | public int compareMonths(Date value, Date compare, TimeZone timeZone)(Code) | | Compare Months (month and year).
Parameters:
value - The Date value to check.
Parameters:
compare - The Date to compare the value to.
Parameters:
timeZone - The Time Zone used to compare the dates, system default if null. Zero if the months are equal, -1 if firstparameter's month is less than the seconds and +1 if the firstparameter's month is greater than. |
| compareQuarters | | public int compareQuarters(Date value, Date compare, TimeZone timeZone)(Code) | | Compare Quarters (quarter and year).
Parameters:
value - The Date value to check.
Parameters:
compare - The Date to compare the value to.
Parameters:
timeZone - The Time Zone used to compare the dates, system default if null. Zero if the months are equal, -1 if firstparameter's quarter is less than the seconds and +1 if the firstparameter's quarter is greater than. |
| compareQuarters | | public int compareQuarters(Date value, Date compare, TimeZone timeZone, int monthOfFirstQuarter)(Code) | | Compare Quarters (quarter and year).
Parameters:
value - The Date value to check.
Parameters:
compare - The Date to compare the value to.
Parameters:
timeZone - The Time Zone used to compare the dates, system default if null.
Parameters:
monthOfFirstQuarter - The month that the first quarter starts. Zero if the quarters are equal, -1 if firstparameter's quarter is less than the seconds and +1 if the firstparameter's quarter is greater than. |
| compareWeeks | | public int compareWeeks(Date value, Date compare, TimeZone timeZone)(Code) | | Compare Weeks (week and year).
Parameters:
value - The Date value to check.
Parameters:
compare - The Date to compare the value to.
Parameters:
timeZone - The Time Zone used to compare the dates, system default if null. Zero if the weeks are equal, -1 if firstparameter's week is less than the seconds and +1 if the firstparameter's week is greater than. |
| compareYears | | public int compareYears(Date value, Date compare, TimeZone timeZone)(Code) | | Compare Years.
Parameters:
value - The Date value to check.
Parameters:
compare - The Date to compare the value to.
Parameters:
timeZone - The Time Zone used to compare the dates, system default if null. Zero if the years are equal, -1 if firstparameter's year is less than the seconds and +1 if the firstparameter's year is greater than. |
| getInstance | | public static DateValidator getInstance()(Code) | | Return a singleton instance of this validator.
A singleton instance of the DateValidator. |
| processParsedValue | | protected Object processParsedValue(Object value, Format formatter)(Code) | | Returns the parsed Date unchanged.
Parameters:
value - The parsed Date object created.
Parameters:
formatter - The Format used to parse the value with. The parsed value converted to a Calendar. |
| validate | | public Date validate(String value)(Code) | | Validate/convert a Date using the default
Locale and TimeZone.
Parameters:
value - The value validation is being performed on. The parsed Date if valid or nullif invalid. |
| validate | | public Date validate(String value, TimeZone timeZone)(Code) | | Validate/convert a Date using the specified
TimeZone and default Locale.
Parameters:
value - The value validation is being performed on.
Parameters:
timeZone - The Time Zone used to parse the date, system default if null. The parsed Date if valid or null if invalid. |
| validate | | public Date validate(String value, String pattern)(Code) | | Validate/convert a Date using the specified
pattern and default TimeZone.
Parameters:
value - The value validation is being performed on.
Parameters:
pattern - The pattern used to validate the value against, or thedefault for the Locale if null. The parsed Date if valid or null if invalid. |
| validate | | public Date validate(String value, String pattern, TimeZone timeZone)(Code) | | Validate/convert a Date using the specified
pattern and TimeZone.
Parameters:
value - The value validation is being performed on.
Parameters:
pattern - The pattern used to validate the value against, or thedefault for the Locale if null.
Parameters:
timeZone - The Time Zone used to parse the date, system default if null. The parsed Date if valid or null if invalid. |
| validate | | public Date validate(String value, Locale locale)(Code) | | Validate/convert a Date using the specified
Locale and default TimeZone.
Parameters:
value - The value validation is being performed on.
Parameters:
locale - The locale to use for the date format, system default if null. The parsed Date if valid or null if invalid. |
| validate | | public Date validate(String value, Locale locale, TimeZone timeZone)(Code) | | Validate/convert a Date using the specified
Locale and TimeZone.
Parameters:
value - The value validation is being performed on.
Parameters:
locale - The locale to use for the date format, system default if null.
Parameters:
timeZone - The Time Zone used to parse the date, system default if null. The parsed Date if valid or null if invalid. |
| validate | | public Date validate(String value, String pattern, Locale locale)(Code) | | Validate/convert a Date using the specified pattern
and Locale and the default TimeZone.
Parameters:
value - The value validation is being performed on.
Parameters:
pattern - The pattern used to validate the value against, or thedefault for the Locale if null.
Parameters:
locale - The locale to use for the date format, system default if null. The parsed Date if valid or null if invalid. |
| validate | | public Date validate(String value, String pattern, Locale locale, TimeZone timeZone)(Code) | | Validate/convert a Date using the specified
pattern, and Locale and TimeZone.
Parameters:
value - The value validation is being performed on.
Parameters:
pattern - The pattern used to validate the value against, or thedefault for the Locale if null.
Parameters:
locale - The locale to use for the date format, system default if null.
Parameters:
timeZone - The Time Zone used to parse the date, system default if null. The parsed Date if valid or null if invalid. |
| Methods inherited from org.apache.commons.validator.routines.AbstractCalendarValidator | protected int compare(Calendar value, Calendar compare, int field)(Code)(Java Doc)
protected int compareQuarters(Calendar value, Calendar compare, int monthOfFirstQuarter)(Code)(Java Doc)
protected int compareTime(Calendar value, Calendar compare, int field)(Code)(Java Doc)
public String format(Object value, TimeZone timeZone)(Code)(Java Doc)
public String format(Object value, String pattern, TimeZone timeZone)(Code)(Java Doc)
public String format(Object value, Locale locale, TimeZone timeZone)(Code)(Java Doc)
public String format(Object value, String pattern, Locale locale)(Code)(Java Doc)
public String format(Object value, String pattern, Locale locale, TimeZone timeZone)(Code)(Java Doc)
protected String format(Object value, Format formatter)(Code)(Java Doc)
protected Format getFormat(String pattern, Locale locale)(Code)(Java Doc)
protected Format getFormat(Locale locale)(Code)(Java Doc)
public boolean isValid(String value, String pattern, Locale locale)(Code)(Java Doc)
protected Object parse(String value, String pattern, Locale locale, TimeZone timeZone)(Code)(Java Doc)
abstract protected Object processParsedValue(Object value, Format formatter)(Code)(Java Doc)
|
| Methods inherited from org.apache.commons.validator.routines.AbstractFormatValidator | public String format(Object value)(Code)(Java Doc)
public String format(Object value, String pattern)(Code)(Java Doc)
public String format(Object value, Locale locale)(Code)(Java Doc)
public String format(Object value, String pattern, Locale locale)(Code)(Java Doc)
protected String format(Object value, Format formatter)(Code)(Java Doc)
abstract protected Format getFormat(String pattern, Locale locale)(Code)(Java Doc)
public boolean isStrict()(Code)(Java Doc)
public boolean isValid(String value)(Code)(Java Doc)
public boolean isValid(String value, String pattern)(Code)(Java Doc)
public boolean isValid(String value, Locale locale)(Code)(Java Doc)
abstract public boolean isValid(String value, String pattern, Locale locale)(Code)(Java Doc)
protected Object parse(String value, Format formatter)(Code)(Java Doc)
abstract protected Object processParsedValue(Object value, Format formatter)(Code)(Java Doc)
|
|
|