java.io.Serializable
, java.lang.Comparable
, Expression
, Item
, ValueRepresentation
public final class TimeValue extends CalendarValue
NO_TIMEZONE
EVALUATE_METHOD, ITERATE_METHOD, PROCESS_METHOD
EMPTY_CLASS_ARRAY
EMPTY_VALUE_ARRAY
Constructor | Description |
---|---|
TimeValue(byte hour,
byte minute,
byte second,
int microsecond,
int tz) |
Construct a time value given the hour, minute, second, and microsecond components.
|
TimeValue(java.lang.CharSequence s) |
Constructor: create a dateTime value from a supplied string, in
ISO 8601 format
|
TimeValue(java.util.GregorianCalendar calendar,
int tz) |
Constructor: create a time value given a Java calendar object
|
Modifier and Type | Method | Description |
---|---|---|
CalendarValue |
add(DurationValue duration) |
Add a duration to a dateTime
|
CalendarValue |
adjustTimezone(int timezone) |
Return a new time with the same normalized value, but
in a different timezone.
|
int |
compareTo(java.lang.Object other) |
Compare the value to another dateTime value
|
int |
compareTo(CalendarValue other,
Configuration config) |
Compare the value to another dateTime value
|
AtomicValue |
convertPrimitive(BuiltInAtomicType requiredType,
boolean validate,
XPathContext context) |
Convert to target data type
|
java.lang.Object |
convertToJava(java.lang.Class target,
XPathContext context) |
Convert to Java object (for passing to external functions)
|
CalendarValue |
copy() |
Make a copy of this date, time, or dateTime value
|
boolean |
equals(java.lang.Object other) |
Compare two (sequence) values for equality.
|
java.util.GregorianCalendar |
getCalendar() |
Get a Java Calendar object corresponding to this time, on a reference date
|
ComparisonKey |
getComparisonKey(Configuration config) |
Get a comparison key for this value.
|
AtomicValue |
getComponent(int component) |
Get a component of the value.
|
ItemType |
getItemType(TypeHierarchy th) |
Determine the data type of the expression
|
java.lang.CharSequence |
getStringValueCS() |
Convert to string
|
int |
hashCode() |
Return a hash code to support the equals() function
|
SecondsDurationValue |
subtract(CalendarValue other,
XPathContext context) |
Determine the difference between two points in time, as a duration
|
DateTimeValue |
toDateTime() |
Convert to a DateTime value.
|
checkPermittedContents, convert, convert, display, effectiveBooleanValue, evaluateAsString, evaluateItem, getCardinality, getImplementationMethod, getLength, getPrimitiveValue, getTypedValue, hasBuiltInType, iterate, process, toString
appendString, appendTimezone, appendTimezone, appendTwoDigits, getStringValue, getTimezoneInMinutes, hasTimezone, removeTimezone, setTimezoneInMinutes
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
asItem, asIterator, asValue, convert, convertJavaObjectToXPath, getDependencies, getIterator, getParentExpression, getSpecialProperties, itemAt, iterateSubExpressions, makeQNameValue, optimize, promote, reduce, simplify, stringToNumber, typeCheck
public TimeValue(byte hour, byte minute, byte second, int microsecond, int tz)
hour
- the hour value, 0-23minute
- the minutes value, 0-59second
- the seconds value, 0-59microsecond
- the number of microseconds, 0-999999tz
- the timezone displacement in minutes from UTC. Supply the value
CalendarValue.NO_TIMEZONE
if there is no timezone component.public TimeValue(java.util.GregorianCalendar calendar, int tz)
calendar
- holds the date and timetz
- the timezone offset in minutes, or NO_TIMEZONE indicating that there is no timezonepublic TimeValue(java.lang.CharSequence s) throws XPathException
XPathException
public AtomicValue convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
convertPrimitive
in class AtomicValue
requiredType
- an integer identifying the required atomic typecontext
- validate
- true if validation is required. If set to false, the caller guarantees that
the value is valid for the target data type, and that further validation is therefore not required.
Note that a validation failure may be reported even if validation was not requested.public java.lang.CharSequence getStringValueCS()
getStringValueCS
in interface Item
getStringValueCS
in interface ValueRepresentation
getStringValueCS
in class AtomicValue
Item.getStringValue()
public DateTimeValue toDateTime()
toDateTime
in class CalendarValue
public java.util.GregorianCalendar getCalendar()
getCalendar
in class CalendarValue
public ItemType getItemType(TypeHierarchy th)
getItemType
in interface Expression
getItemType
in class Value
th
- public CalendarValue copy()
copy
in class CalendarValue
public CalendarValue adjustTimezone(int timezone)
adjustTimezone
in class CalendarValue
timezone
- the new timezone offset, in minutespublic java.lang.Object convertToJava(java.lang.Class target, XPathContext context) throws XPathException
convertToJava
in class Value
XPathException
public AtomicValue getComponent(int component) throws XPathException
getComponent
in class AtomicValue
XPathException
public int compareTo(java.lang.Object other)
other
- The other dateTime valuejava.lang.ClassCastException
- if the other value is not a DateTimeValue (the parameter
is declared as Object to satisfy the Comparable interface)public int compareTo(CalendarValue other, Configuration config)
compareTo
in class CalendarValue
other
- The other dateTime valuejava.lang.ClassCastException
- if the other value is not a DateTimeValue (the parameter
is declared as Object to satisfy the Comparable interface)public ComparisonKey getComparisonKey(Configuration config)
getComparisonKey
in class CalendarValue
public boolean equals(java.lang.Object other)
Value
public int hashCode()
Value
public CalendarValue add(DurationValue duration) throws XPathException
add
in class CalendarValue
duration
- the duration to be added (may be negative)XPathException
- if the duration is an xs:duration, as distinct from
a subclass thereofpublic SecondsDurationValue subtract(CalendarValue other, XPathContext context) throws XPathException
subtract
in class CalendarValue
other
- the other point in timecontext
- XPathException
- for example if one value is a date and the other is a time