org.apache.commons.validator.routines

Class DateValidator

public class DateValidator extends AbstractCalendarValidator

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:

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:

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:

Since: Validator 1.3.0

Version: $Revision: 478334 $ $Date: 2006-11-22 21:31:54 +0000 (Wed, 22 Nov 2006) $

Field Summary
static DateValidatorVALIDATOR
Constructor Summary
DateValidator()
Construct a strict instance with short date style.
DateValidator(boolean strict, int dateStyle)
Construct an instance with the specified strict and date style parameters.
Method Summary
intcompareDates(Date value, Date compare, TimeZone timeZone)

Compare Dates (day, month and year - not time).

intcompareMonths(Date value, Date compare, TimeZone timeZone)

Compare Months (month and year).

intcompareQuarters(Date value, Date compare, TimeZone timeZone)

Compare Quarters (quarter and year).

intcompareQuarters(Date value, Date compare, TimeZone timeZone, int monthOfFirstQuarter)

Compare Quarters (quarter and year).

intcompareWeeks(Date value, Date compare, TimeZone timeZone)

Compare Weeks (week and year).

intcompareYears(Date value, Date compare, TimeZone timeZone)

Compare Years.

CalendargetCalendar(Date value, TimeZone timeZone)

Convert a Date to a Calendar.

static DateValidatorgetInstance()
Return a singleton instance of this validator.
protected ObjectprocessParsedValue(Object value, Format formatter)

Returns the parsed Date unchanged.

Datevalidate(String value)

Validate/convert a Date using the default Locale and TimeZone.

Datevalidate(String value, TimeZone timeZone)

Validate/convert a Date using the specified TimeZone and default Locale.

Datevalidate(String value, String pattern)

Validate/convert a Date using the specified pattern and default TimeZone.

Datevalidate(String value, String pattern, TimeZone timeZone)

Validate/convert a Date using the specified pattern and TimeZone.

Datevalidate(String value, Locale locale)

Validate/convert a Date using the specified Locale and default TimeZone.

Datevalidate(String value, Locale locale, TimeZone timeZone)

Validate/convert a Date using the specified Locale and TimeZone.

Datevalidate(String value, String pattern, Locale locale)

Validate/convert a Date using the specified pattern and Locale and the default TimeZone.

Datevalidate(String value, String pattern, Locale locale, TimeZone timeZone)

Validate/convert a Date using the specified pattern, and Locale and TimeZone.

Field Detail

VALIDATOR

private static final DateValidator VALIDATOR

Constructor Detail

DateValidator

public DateValidator()
Construct a strict instance with short date style.

DateValidator

public DateValidator(boolean strict, int dateStyle)
Construct an instance with the specified strict and date style parameters.

Parameters: strict true if strict Format parsing should be used. dateStyle the date style to use for Locale validation.

Method Detail

compareDates

public int compareDates(Date value, Date compare, TimeZone timeZone)

Compare Dates (day, month and year - not time).

Parameters: value The Calendar value to check. compare The Calendar to compare the value to. timeZone The Time Zone used to compare the dates, system default if null.

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

public int compareMonths(Date value, Date compare, TimeZone timeZone)

Compare Months (month and year).

Parameters: value The Date value to check. compare The Date to compare the value to. timeZone The Time Zone used to compare the dates, system default if null.

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

public int compareQuarters(Date value, Date compare, TimeZone timeZone)

Compare Quarters (quarter and year).

Parameters: value The Date value to check. compare The Date to compare the value to. timeZone The Time Zone used to compare the dates, system default if null.

Returns: Zero if the months 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

public int compareQuarters(Date value, Date compare, TimeZone timeZone, int monthOfFirstQuarter)

Compare Quarters (quarter and year).

Parameters: value The Date value to check. compare The Date to compare the value to. timeZone The Time Zone used to compare the dates, system default if null. 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

public int compareWeeks(Date value, Date compare, TimeZone timeZone)

Compare Weeks (week and year).

Parameters: value The Date value to check. compare The Date to compare the value to. timeZone The Time Zone used to compare the dates, system default if null.

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

public int compareYears(Date value, Date compare, TimeZone timeZone)

Compare Years.

Parameters: value The Date value to check. compare The Date to compare the value to. timeZone The Time Zone used to compare the dates, system default if null.

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.

getCalendar

private Calendar getCalendar(Date value, TimeZone timeZone)

Convert a Date to a Calendar.

Parameters: value The date value to be converted.

Returns: The converted Calendar.

getInstance

public static DateValidator getInstance()
Return a singleton instance of this validator.

Returns: A singleton instance of the DateValidator.

processParsedValue

protected Object processParsedValue(Object value, Format formatter)

Returns the parsed Date unchanged.

Parameters: value The parsed Date object created. formatter The Format used to parse the value with.

Returns: The parsed value converted to a Calendar.

validate

public Date validate(String value)

Validate/convert a Date using the default Locale and TimeZone.

Parameters: value The value validation is being performed on.

Returns: The parsed Date if valid or null if invalid.

validate

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. timeZone The Time Zone used to parse the date, system default if null.

Returns: The parsed Date if valid or null if invalid.

validate

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. pattern The pattern used to validate the value against, or the default for the Locale if null.

Returns: The parsed Date if valid or null if invalid.

validate

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. pattern The pattern used to validate the value against, or the default for the Locale if null. timeZone The Time Zone used to parse the date, system default if null.

Returns: The parsed Date if valid or null if invalid.

validate

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. locale The locale to use for the date format, system default if null.

Returns: The parsed Date if valid or null if invalid.

validate

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. 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 Date if valid or null if invalid.

validate

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. 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.

Returns: The parsed Date if valid or null if invalid.

validate

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. 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.

Returns: The parsed Date if valid or null if invalid.

Copyright (c) 2001-2004 Apache Software Foundation