Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.commons.validator.routines.AbstractFormatValidator
org.apache.commons.validator.routines.AbstractCalendarValidator
public abstract class AbstractCalendarValidator
extends AbstractFormatValidator
Fields inherited from class org.apache.commons.validator.routines.AbstractFormatValidator | |
strict |
Constructor Summary | |
|
Method Summary | |
private int |
|
private int |
|
protected int |
|
protected int |
|
protected int |
|
protected String |
|
String |
|
String |
|
String |
|
String |
|
String |
|
protected Format |
|
protected Format |
|
boolean |
|
protected Object |
|
protected abstract Object |
|
Methods inherited from class org.apache.commons.validator.routines.AbstractFormatValidator | |
format , format , format , format , format , getFormat , isStrict , isValid , isValid , isValid , isValid , parse , processParsedValue |
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.
private int calculateCompareResult(Calendar value, Calendar compare, int field)
Compares the field from two calendars indicating whether the field for the first calendar is equal to, less than or greater than the field from the second calendar.
- Parameters:
value
- The Calendar value.compare
- TheCalendar
to check the value against.field
- The field to compare for the calendars.
- Returns:
- Zero if the first calendar's field is equal to the seconds, -1 if it is less than the seconds or +1 if it is greater than the seconds.
private int calculateQuarter(Calendar calendar, int monthOfFirstQuarter)
Calculate the quarter for the specified Calendar.
- Parameters:
calendar
- The Calendar value.monthOfFirstQuarter
- The month that the first quarter starts.
- Returns:
- The calculated quarter.
protected int compare(Calendar value, 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.
protected int compareQuarters(Calendar value, 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.
protected int compareTime(Calendar value, 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.
protected String format(Object value, Format formatter)
Format a value with the specifiedDateFormat
.
- Overrides:
- format in interface AbstractFormatValidator
- Parameters:
value
- The value to be formatted.formatter
- The Format to use.
- Returns:
- The formatted value.
public String format(Object value, Locale locale, TimeZone timeZone)
Format an object into aString
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
.
public String format(Object value, String pattern, Locale locale)
Format an object using the specified pattern and/orLocale
.
- Overrides:
- format in interface AbstractFormatValidator
- 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
.
public String format(Object value, String pattern, Locale locale, TimeZone timeZone)
Format an object using the specified pattern and/orLocale
.
- 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
.
public String format(Object value, String pattern, TimeZone timeZone)
Format an object into aString
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
.
public String format(Object value, TimeZone timeZone)
Format an object into aString
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
.
protected Format getFormat(Locale locale)
Returns aDateFormat
for the specified Locale.
- Parameters:
locale
- The locale aDateFormat
is required for, system default if null.
- Returns:
- The
DateFormat
to created.
protected Format getFormat(String pattern, Locale locale)
Returns aDateFormat
for the specified pattern and/orLocale
.
- Overrides:
- getFormat in interface AbstractFormatValidator
- 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.
public boolean isValid(String value, String pattern, Locale locale)
Validate using the specifiedLocale
.
- Overrides:
- isValid in interface AbstractFormatValidator
- 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.
protected Object parse(String value, String pattern, Locale locale, 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.
protected abstract Object processParsedValue(Object value, Format formatter)
Process the parsed value, performing any further validation and type conversion required.
- Overrides:
- processParsedValue in interface AbstractFormatValidator
- 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.