Class TimeValidator
- All Implemented Interfaces:
Serializable
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
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 (that is, 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 successfully converted the following methods can be used to perform various time comparison checks:
compareTime()compares the hours, minutes, seconds and milliseconds of two calendars, returning 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, returning 0, -1 or +1 indicating whether the first is equal to, before or after the second.compareMinutes()compares the hours and minutes two times, returning 0, -1 or +1 indicating whether the first is equal to, before or after the second.compareHours()compares the hours of two times, returning 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:
- Since:
- 1.3.0
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs a strict instance with short time style.TimeValidator(boolean strict, int timeStyle) Constructs an instance with the specified strict and time style parameters. -
Method Summary
Modifier and TypeMethodDescriptionintcompareHours(Calendar value, Calendar compare) Compare Hours.intcompareMinutes(Calendar value, Calendar compare) Compare Minutes (hours and minutes).intcompareSeconds(Calendar value, Calendar compare) Compare Seconds (hours, minutes and seconds).intcompareTime(Calendar value, Calendar compare) Compare Times (hour, minute, second and millisecond - not date).static TimeValidatorGets the singleton instance of this validator.protected ObjectprocessParsedValue(Object value, Format formatter) Convert the parsedDateto aCalendar.Validate/convert a time using the defaultLocaleandTimeZone.Validate/convert a time using the specified pattern and defaultTimeZone.Validate/convert a time using the specified pattern andLocaleand the defaultTimeZone.Validate/convert a time using the specified pattern,LocaleandTimeZone.Validate/convert a time using the specified pattern andTimeZone.Validate/convert a time using the specifiedLocaledefaultTimeZone.Validate/convert a time using the specifiedLocaleandTimeZone.Validate/convert a time using the specifiedTimeZoneand defaultLocale.Methods inherited from class org.apache.commons.validator.routines.AbstractCalendarValidator
compare, compareQuarters, compareTime, format, format, format, format, format, format, getFormat, getFormat, isValid, parse
-
Constructor Details
-
TimeValidator
public TimeValidator()Constructs a strict instance with short time style. -
TimeValidator
Constructs an instance with the specified strict and time style parameters.- Parameters:
strict-trueif strictFormatparsing should be used.timeStyle- the time style to use for Locale validation.
-
-
Method Details
-
getInstance
Gets the singleton instance of this validator.- Returns:
- A singleton instance of the TimeValidator.
-
compareHours
Compare Hours.
-
compareMinutes
Compare Minutes (hours and minutes).
-
compareSeconds
Compare Seconds (hours, minutes and seconds).
-
compareTime
Compare Times (hour, minute, second and millisecond - not date).
-
processParsedValue
Convert the parsed
Dateto aCalendar.- Specified by:
processParsedValuein classAbstractCalendarValidator- Parameters:
value- The parsedDateobject created.formatter- The Format used to parse the value with.- Returns:
- The parsed value converted to a
Calendar.
-
validate
Validate/convert a time using the default
LocaleandTimeZone.- Parameters:
value- The value validation is being performed on.- Returns:
- The parsed
Calendarif valid ornullif invalid.
-
validate
Validate/convert a time using the specified
LocaledefaultTimeZone.- Parameters:
value- The value validation is being performed on.locale- The locale to use for the time format, system default if null.- Returns:
- The parsed
Calendarif valid ornullif invalid.
-
validate
Validate/convert a time using the specified
LocaleandTimeZone.- Parameters:
value- The value validation is being performed on.locale- The locale to use for the time format, system default if null.timeZone- The Time Zone used to parse the time, system default if null.- Returns:
- The parsed
Calendarif valid ornullif invalid.
-
validate
Validate/convert a time 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.- Returns:
- The parsed
Calendarif valid ornullif invalid.
-
validate
Validate/convert a time using the specified pattern and
Localeand the defaultTimeZone. -
validate
Validate/convert a time using the specified pattern,
LocaleandTimeZone.- Parameters:
value- The value validation is being performed on.pattern- The pattern used to validate the value against, or the default for theLocaleifnull.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
Calendarif valid ornullif invalid.
-
validate
Validate/convert a time using the specified pattern and
TimeZone.- Parameters:
value- The value validation is being performed on.pattern- The pattern used to validate the value against.timeZone- The Time Zone used to parse the time, system default if null.- Returns:
- The parsed
Calendarif valid ornullif invalid.
-
validate
Validate/convert a time using the specified
TimeZoneand defaultLocale.- Parameters:
value- The value validation is being performed on.timeZone- The Time Zone used to parse the time, system default if null.- Returns:
- The parsed
Calendarif valid ornullif invalid.
-