Class AbstractCalendarValidator
- java.lang.Object
-
- org.apache.commons.validator.routines.AbstractFormatValidator
-
- org.apache.commons.validator.routines.AbstractCalendarValidator
-
- All Implemented Interfaces:
java.io.Serializable
- Direct Known Subclasses:
CalendarValidator
,DateValidator
,TimeValidator
public abstract class AbstractCalendarValidator extends AbstractFormatValidator
Abstract class for Date/Time/Calendar validation.
This is a base class for building Date / Time Validators using format parsing.
- Since:
- Validator 1.3.0
- Version:
- $Revision: 1739356 $
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description AbstractCalendarValidator(boolean strict, int dateStyle, int timeStyle)
Construct an instance with the specified strict, time and date style parameters.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected int
compare(java.util.Calendar value, java.util.Calendar compare, int field)
Compares a calendar value to another, indicating whether it is equal, less then or more than at a specified level.protected int
compareQuarters(java.util.Calendar value, java.util.Calendar compare, int monthOfFirstQuarter)
Compares a calendar's quarter value to another, indicating whether it is equal, less then or more than the specified quarter.protected int
compareTime(java.util.Calendar value, java.util.Calendar compare, int field)
Compares a calendar time value to another, indicating whether it is equal, less then or more than at a specified level.java.lang.String
format(java.lang.Object value, java.lang.String pattern, java.util.Locale locale)
Format an object using the specified pattern and/orLocale
.java.lang.String
format(java.lang.Object value, java.lang.String pattern, java.util.Locale locale, java.util.TimeZone timeZone)
Format an object using the specified pattern and/orLocale
.java.lang.String
format(java.lang.Object value, java.lang.String pattern, java.util.TimeZone timeZone)
Format an object into aString
using the specified pattern.protected java.lang.String
format(java.lang.Object value, java.text.Format formatter)
Format a value with the specifiedDateFormat
.java.lang.String
format(java.lang.Object value, java.util.Locale locale, java.util.TimeZone timeZone)
Format an object into aString
using the specified Locale.java.lang.String
format(java.lang.Object value, java.util.TimeZone timeZone)
Format an object into aString
using the default Locale.protected java.text.Format
getFormat(java.lang.String pattern, java.util.Locale locale)
Returns aDateFormat
for the specified pattern and/orLocale
.protected java.text.Format
getFormat(java.util.Locale locale)
Returns aDateFormat
for the specified Locale.boolean
isValid(java.lang.String value, java.lang.String pattern, java.util.Locale locale)
Validate using the specifiedLocale
.protected java.lang.Object
parse(java.lang.String value, java.lang.String pattern, java.util.Locale locale, java.util.TimeZone timeZone)
Checks if the value is valid against a specified pattern.protected abstract java.lang.Object
processParsedValue(java.lang.Object value, java.text.Format formatter)
Process the parsed value, performing any further validation and type conversion required.
-
-
-
Constructor Detail
-
AbstractCalendarValidator
public AbstractCalendarValidator(boolean strict, int dateStyle, int timeStyle)
Construct an instance with the specified strict, time and date style parameters.- Parameters:
strict
-true
if strictFormat
parsing should be used.dateStyle
- the date style to use for Locale validation.timeStyle
- the time style to use for Locale validation.
-
-
Method Detail
-
isValid
public boolean isValid(java.lang.String value, java.lang.String pattern, java.util.Locale locale)
Validate using the specified
Locale
.- Specified by:
isValid
in classAbstractFormatValidator
- Parameters:
value
- The value validation is being performed on.pattern
- The pattern used to format the value.locale
- The locale to use for the Format, defaults to the default- Returns:
true
if the value is valid.
-
format
public java.lang.String format(java.lang.Object value, java.util.TimeZone timeZone)
Format an object into a
String
using the default Locale.- Parameters:
value
- The value validation is being performed on.timeZone
- The Time Zone used to format the date, system default if null (unless value is aCalendar
.- Returns:
- The value formatted as a
String
.
-
format
public java.lang.String format(java.lang.Object value, java.lang.String pattern, java.util.TimeZone timeZone)
Format an object into a
String
using the specified pattern.- Parameters:
value
- The value validation is being performed on.pattern
- The pattern used to format the value.timeZone
- The Time Zone used to format the date, system default if null (unless value is aCalendar
.- Returns:
- The value formatted as a
String
.
-
format
public java.lang.String format(java.lang.Object value, java.util.Locale locale, java.util.TimeZone timeZone)
Format an object into a
String
using the specified Locale.- Parameters:
value
- The value validation is being performed on.locale
- The locale to use for the Format.timeZone
- The Time Zone used to format the date, system default if null (unless value is aCalendar
.- Returns:
- The value formatted as a
String
.
-
format
public java.lang.String format(java.lang.Object value, java.lang.String pattern, java.util.Locale locale)
Format an object using the specified pattern and/or
Locale
.- Overrides:
format
in classAbstractFormatValidator
- Parameters:
value
- The value validation is being performed on.pattern
- The pattern used to format the value.locale
- The locale to use for the Format.- Returns:
- The value formatted as a
String
.
-
format
public java.lang.String format(java.lang.Object value, java.lang.String pattern, java.util.Locale locale, java.util.TimeZone timeZone)
Format an object using the specified pattern and/or
Locale
.- Parameters:
value
- The value validation is being performed on.pattern
- The pattern used to format the value.locale
- The locale to use for the Format.timeZone
- The Time Zone used to format the date, system default if null (unless value is aCalendar
.- Returns:
- The value formatted as a
String
.
-
format
protected java.lang.String format(java.lang.Object value, java.text.Format formatter)
Format a value with the specified
DateFormat
.- Overrides:
format
in classAbstractFormatValidator
- Parameters:
value
- The value to be formatted.formatter
- The Format to use.- Returns:
- The formatted value.
-
parse
protected java.lang.Object parse(java.lang.String value, java.lang.String pattern, java.util.Locale locale, java.util.TimeZone timeZone)
Checks if the value is valid against a specified pattern.
- Parameters:
value
- The value validation is being performed on.pattern
- The pattern used to validate the value against, or the default for theLocale
ifnull
.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 value if valid or
null
if invalid.
-
processParsedValue
protected abstract java.lang.Object processParsedValue(java.lang.Object value, java.text.Format formatter)
Process the parsed value, performing any further validation and type conversion required.
- Specified by:
processParsedValue
in classAbstractFormatValidator
- Parameters:
value
- The parsed object created.formatter
- The Format used to parse the value with.- Returns:
- The parsed value converted to the appropriate type
if valid or
null
if invalid.
-
getFormat
protected java.text.Format getFormat(java.lang.String pattern, java.util.Locale locale)
Returns a
DateFormat
for the specified pattern and/orLocale
.- Specified by:
getFormat
in classAbstractFormatValidator
- Parameters:
pattern
- The pattern used to validate the value against ornull
to use the default for theLocale
.locale
- The locale to use for the currency format, system default if null.- Returns:
- The
DateFormat
to created.
-
getFormat
protected java.text.Format getFormat(java.util.Locale locale)
Returns a
DateFormat
for the specified Locale.- Parameters:
locale
- The locale aDateFormat
is required for, system default if null.- Returns:
- The
DateFormat
to created.
-
compare
protected int compare(java.util.Calendar value, java.util.Calendar compare, int field)
Compares a calendar value to another, indicating whether it is equal, less then or more than at a specified level.
- Parameters:
value
- The Calendar value.compare
- TheCalendar
to check the value against.field
- The field level to compare to - e.g. specifyingCalendar.MONTH
will compare the year and month portions of the calendar.- Returns:
- Zero if the first value is equal to the second, -1 if it is less than the second or +1 if it is greater than the second.
-
compareTime
protected int compareTime(java.util.Calendar value, java.util.Calendar compare, int field)
Compares a calendar time value to another, indicating whether it is equal, less then or more than at a specified level.
- Parameters:
value
- The Calendar value.compare
- TheCalendar
to check the value against.field
- The field level to compare to - e.g. specifyingCalendar.MINUTE
will compare the hours and minutes portions of the calendar.- Returns:
- Zero if the first value is equal to the second, -1 if it is less than the second or +1 if it is greater than the second.
-
compareQuarters
protected int compareQuarters(java.util.Calendar value, java.util.Calendar compare, int monthOfFirstQuarter)
Compares a calendar's quarter value to another, indicating whether it is equal, less then or more than the specified quarter.
- Parameters:
value
- The Calendar value.compare
- TheCalendar
to check the value against.monthOfFirstQuarter
- The month that the first quarter starts.- Returns:
- Zero if the first quarter is equal to the second, -1 if it is less than the second or +1 if it is greater than the second.
-
-