| java.lang.Object
 org.apache.commons.validator.routines.AbstractFormatValidator
org.apache.commons.validator.routines.AbstractCalendarValidator
org.apache.commons.validator.routines.TimeValidator
| TimeValidator | | public class TimeValidator extends AbstractCalendarValidator (Code) | | Time Validation and Conversion routines (java.util.Calendar).
This validator provides a number of methods for validating/converting
a String time value to a java.util.Calendar 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 Calendar value for the time.
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 sucessfully converted the following
methods can be used to perform various time comparison checks:
compareTime() compares the hours, minutes, seconds
and milliseconds of two calendars, returing 0, -1 or +1 indicating
whether the first time is equal, before or after the second.compareSeconds() compares the hours, minutes and
seconds of two times, returing 0, -1 or +1 indicating
whether the first is equal to, before or after the second.compareMinutes() compares the hours and minutes
two times, returing 0, -1 or +1 indicating
whether the first is equal to, before or after the second.compareHours() compares the hours
of two times, returing 0, -1 or +1 indicating
whether the first is equal to, 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 | TimeValidator()
Construct a strict instance with short
time style. | | public | TimeValidator(boolean strict, int timeStyle)
Construct an instance with the specified strict
and time style parameters. |
| Method Summary | |
| public int | compareHours(Calendar value, Calendar compare)
Compare Hours.
Parameters:
value - The Calendar value to check.
Parameters:
compare - The Calendar to compare the value to. | | public int | compareMinutes(Calendar value, Calendar compare)
Compare Minutes (hours and minutes).
Parameters:
value - The Calendar value to check.
Parameters:
compare - The Calendar to compare the value to. | | public int | compareSeconds(Calendar value, Calendar compare)
Compare Seconds (hours, minutes and seconds).
Parameters:
value - The Calendar value to check.
Parameters:
compare - The Calendar to compare the value to. | | public int | compareTime(Calendar value, Calendar compare)
Compare Times (hour, minute, second and millisecond - not date).
Parameters:
value - The Calendar value to check.
Parameters:
compare - The Calendar to compare the value to. | | public static TimeValidator | getInstance()
Return a singleton instance of this validator. | | protected Object | processParsedValue(Object value, Format formatter)
Convert the parsed Date to a Calendar.
Parameters:
value - The parsed Date object created.
Parameters:
formatter - The Format used to parse the value with. | | public Calendar | validate(String value)
Validate/convert a time using the default Locale
and TimeZone. | | public Calendar | validate(String value, TimeZone timeZone)
Validate/convert a time 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 time, system default if null. | | public Calendar | validate(String value, String pattern)
Validate/convert a time 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. | | public Calendar | validate(String value, String pattern, TimeZone timeZone)
Validate/convert a time 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.
Parameters:
timeZone - The Time Zone used to parse the time, system default if null. | | public Calendar | validate(String value, Locale locale)
Validate/convert a time using the specified Locale
default TimeZone.
Parameters:
value - The value validation is being performed on.
Parameters:
locale - The locale to use for the time format, system default if null. | | public Calendar | validate(String value, Locale locale, TimeZone timeZone)
Validate/convert a time using the specified specified Locale
and TimeZone.
Parameters:
value - The value validation is being performed on.
Parameters:
locale - The locale to use for the time format, system default if null.
Parameters:
timeZone - The Time Zone used to parse the time, system default if null. | | public Calendar | validate(String value, String pattern, Locale locale)
Validate/convert a time 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 Calendar | validate(String value, String pattern, Locale locale, TimeZone timeZone)
Validate/convert a time using the specified pattern, 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. |
| TimeValidator | | public TimeValidator()(Code) | | Construct a strict instance with short
time style.
|
| TimeValidator | | public TimeValidator(boolean strict, int timeStyle)(Code) | | Construct an instance with the specified strict
and time style parameters.
Parameters:
strict - true if strict Format parsing should be used.
Parameters:
timeStyle - the time style to use for Locale validation. |
| compareHours | | public int compareHours(Calendar value, Calendar compare)(Code) | | Compare Hours.
Parameters:
value - The Calendar value to check.
Parameters:
compare - The Calendar to compare the value to. Zero if the hours are equal, -1 if firstparameter's hour is less than the seconds and +1 if the firstparameter's hour is greater than. |
| compareMinutes | | public int compareMinutes(Calendar value, Calendar compare)(Code) | | Compare Minutes (hours and minutes).
Parameters:
value - The Calendar value to check.
Parameters:
compare - The Calendar to compare the value to. Zero if the hours are equal, -1 if firstparameter's minutes are less than the seconds and +1 if the firstparameter's minutes are greater than. |
| compareSeconds | | public int compareSeconds(Calendar value, Calendar compare)(Code) | | Compare Seconds (hours, minutes and seconds).
Parameters:
value - The Calendar value to check.
Parameters:
compare - The Calendar to compare the value to. Zero if the hours are equal, -1 if firstparameter's seconds are less than the seconds and +1 if the firstparameter's seconds are greater than. |
| compareTime | | public int compareTime(Calendar value, Calendar compare)(Code) | | Compare Times (hour, minute, second and millisecond - not date).
Parameters:
value - The Calendar value to check.
Parameters:
compare - The Calendar to compare the value to. Zero if the hours are equal, -1 if firsttime is less than the seconds and +1 if the firsttime is greater than. |
| getInstance | | public static TimeValidator getInstance()(Code) | | Return a singleton instance of this validator.
A singleton instance of the TimeValidator. |
| processParsedValue | | protected Object processParsedValue(Object value, Format formatter)(Code) | | Convert the parsed Date to a Calendar.
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 Calendar validate(String value)(Code) | | Validate/convert a time using the default Locale
and TimeZone.
Parameters:
value - The value validation is being performed on. The parsed Calendar if valid or nullif invalid. |
| validate | | public Calendar validate(String value, TimeZone timeZone)(Code) | | Validate/convert a time 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 time, system default if null. The parsed Calendar if valid or null if invalid. |
| validate | | public Calendar validate(String value, String pattern)(Code) | | Validate/convert a time 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. The parsed Calendar if valid or null if invalid. |
| validate | | public Calendar validate(String value, String pattern, TimeZone timeZone)(Code) | | Validate/convert a time 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.
Parameters:
timeZone - The Time Zone used to parse the time, system default if null. The parsed Calendar if valid or null if invalid. |
| validate | | public Calendar validate(String value, Locale locale)(Code) | | Validate/convert a time using the specified Locale
default TimeZone.
Parameters:
value - The value validation is being performed on.
Parameters:
locale - The locale to use for the time format, system default if null. The parsed Calendar if valid or null if invalid. |
| validate | | public Calendar validate(String value, Locale locale, TimeZone timeZone)(Code) | | Validate/convert a time using the specified specified Locale
and TimeZone.
Parameters:
value - The value validation is being performed on.
Parameters:
locale - The locale to use for the time format, system default if null.
Parameters:
timeZone - The Time Zone used to parse the time, system default if null. The parsed Calendar if valid or null if invalid. |
| validate | | public Calendar validate(String value, String pattern, Locale locale)(Code) | | Validate/convert a time 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 Calendar if valid or null if invalid. |
| validate | | public Calendar validate(String value, String pattern, Locale locale, TimeZone timeZone)(Code) | | Validate/convert a time using the specified pattern, 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 Calendar 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)
|
|
|