public class TimeValidator extends AbstractCalendarValidator
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:
Locale
Locale
Locale
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 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:
Locale
Locale
Constructor and Description |
---|
TimeValidator()
Construct a strict instance with short
time style.
|
TimeValidator(boolean strict,
int timeStyle)
Construct an instance with the specified strict
and time style parameters.
|
Modifier and Type | Method and Description |
---|---|
int |
compareHours(Calendar value,
Calendar compare)
Compare Hours.
|
int |
compareMinutes(Calendar value,
Calendar compare)
Compare Minutes (hours and minutes).
|
int |
compareSeconds(Calendar value,
Calendar compare)
Compare Seconds (hours, minutes and seconds).
|
int |
compareTime(Calendar value,
Calendar compare)
Compare Times (hour, minute, second and millisecond - not date).
|
static TimeValidator |
getInstance()
Return a singleton instance of this validator.
|
protected Object |
processParsedValue(Object value,
Format formatter)
Convert the parsed
Date to a Calendar . |
Calendar |
validate(String value)
Validate/convert a time using the default
Locale
and TimeZone . |
Calendar |
validate(String value,
Locale locale)
Validate/convert a time using the specified
Locale
default TimeZone . |
Calendar |
validate(String value,
Locale locale,
TimeZone timeZone)
Validate/convert a time using the specified specified
Locale
and TimeZone . |
Calendar |
validate(String value,
String pattern)
Validate/convert a time using the specified pattern and
default
TimeZone . |
Calendar |
validate(String value,
String pattern,
Locale locale)
Validate/convert a time using the specified pattern and
Locale
and the default TimeZone . |
Calendar |
validate(String value,
String pattern,
Locale locale,
TimeZone timeZone)
Validate/convert a time using the specified pattern,
Locale
and TimeZone . |
Calendar |
validate(String value,
String pattern,
TimeZone timeZone)
Validate/convert a time using the specified pattern
and
TimeZone . |
Calendar |
validate(String value,
TimeZone timeZone)
Validate/convert a time using the specified
TimeZone
and default Locale . |
compare, compareQuarters, compareTime, format, format, format, format, format, format, getFormat, getFormat, isValid, parse
public TimeValidator()
public TimeValidator(boolean strict, int timeStyle)
strict
- true
if strict
Format
parsing should be used.timeStyle
- the time style to use for Locale validation.public static TimeValidator getInstance()
public Calendar validate(String value)
Validate/convert a time using the default Locale
and TimeZone
.
value
- The value validation is being performed on.Calendar
if valid or null
if invalid.public Calendar validate(String value, TimeZone timeZone)
Validate/convert a time using the specified TimeZone
and default Locale
.
value
- The value validation is being performed on.timeZone
- The Time Zone used to parse the time, system default if null.Calendar
if valid or null
if invalid.public Calendar validate(String value, String pattern)
Validate/convert a time using the specified pattern and
default TimeZone
.
value
- The value validation is being performed on.pattern
- The pattern used to validate the value against.Calendar
if valid or null
if invalid.public Calendar validate(String value, String pattern, TimeZone timeZone)
Validate/convert a time using the specified pattern
and TimeZone
.
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.Calendar
if valid or null
if invalid.public Calendar validate(String value, Locale locale)
Validate/convert a time using the specified Locale
default TimeZone
.
value
- The value validation is being performed on.locale
- The locale to use for the time format, system default if null.Calendar
if valid or null
if invalid.public Calendar validate(String value, Locale locale, TimeZone timeZone)
Validate/convert a time using the specified specified Locale
and TimeZone
.
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.Calendar
if valid or null
if invalid.public Calendar validate(String value, String pattern, Locale locale)
Validate/convert a time using the specified pattern and Locale
and the default TimeZone
.
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.Calendar
if valid or null
if invalid.public Calendar validate(String value, String pattern, Locale locale, TimeZone timeZone)
Validate/convert a time using the specified pattern, Locale
and TimeZone
.
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.Calendar
if valid or null
if invalid.public int compareTime(Calendar value, Calendar compare)
Compare Times (hour, minute, second and millisecond - not date).
value
- The Calendar
value to check.compare
- The Calendar
to compare the value to.public int compareSeconds(Calendar value, Calendar compare)
Compare Seconds (hours, minutes and seconds).
value
- The Calendar
value to check.compare
- The Calendar
to compare the value to.public int compareMinutes(Calendar value, Calendar compare)
Compare Minutes (hours and minutes).
value
- The Calendar
value to check.compare
- The Calendar
to compare the value to.public int compareHours(Calendar value, Calendar compare)
Compare Hours.
value
- The Calendar
value to check.compare
- The Calendar
to compare the value to.protected Object processParsedValue(Object value, Format formatter)
Convert the parsed Date
to a Calendar
.
processParsedValue
in class AbstractCalendarValidator
value
- The parsed Date
object created.formatter
- The Format used to parse the value with.Calendar
.Copyright © 2002–2017 The Apache Software Foundation. All rights reserved.