net.sf.saxon.value
public final class TimeValue extends CalendarValue implements Comparable
Constructor Summary | |
---|---|
TimeValue(byte hour, byte minute, byte second, int microsecond, int tz)
Construct a time value given the hour, minute, second, and microsecond components.
| |
TimeValue(GregorianCalendar calendar, int tz)
Constructor: create a time value given a Java calendar object
|
Method Summary | |
---|---|
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(Object other)
Compare the value to another dateTime value
|
int | compareTo(CalendarValue other, XPathContext context)
Compare the value to another dateTime value
|
ConversionResult | convertPrimitive(BuiltInAtomicType requiredType, boolean validate, XPathContext context)
Convert to target data type
|
AtomicValue | copyAsSubType(AtomicType typeLabel)
Make a copy of this time value,
but with a different type label
|
boolean | equals(Object other) |
GregorianCalendar | getCalendar()
Get a Java Calendar object corresponding to this time, on a reference date |
CharSequence | getCanonicalLexicalRepresentation()
Get the canonical lexical representation as defined in XML Schema. |
ComparisonKey | getComparisonKey(XPathContext context)
Get a comparison key for this value. |
AtomicValue | getComponent(int component)
Get a component of the value. |
byte | getHour()
Get the hour component, 0-23
|
int | getMicrosecond()
Get the microsecond component, 0-999999
|
byte | getMinute()
Get the minute component, 0-59
|
CharSequence | getPrimitiveStringValue()
Convert to string
|
BuiltInAtomicType | getPrimitiveType()
Determine the primitive type of the value. |
Comparable | getSchemaComparable() |
byte | getSecond()
Get the second component, 0-59
|
int | hashCode() |
static ConversionResult | makeTimeValue(CharSequence s)
Static factory method: create a time value from a supplied string, in
ISO 8601 format
|
DayTimeDurationValue | subtract(CalendarValue other, XPathContext context)
Determine the difference between two points in time, as a duration
|
DateTimeValue | toDateTime()
Convert to a DateTime value. |
Parameters: hour the hour value, 0-23 minute the minutes value, 0-59 second the seconds value, 0-59 microsecond the number of microseconds, 0-999999 tz the timezone displacement in minutes from UTC. Supply the value NO_TIMEZONE if there is no timezone component.
Parameters: calendar holds the date and time tz the timezone offset in minutes, or NO_TIMEZONE indicating that there is no timezone
Parameters: duration the duration to be added (may be negative)
Returns: the new date
Throws: net.sf.saxon.trans.XPathException if the duration is an xs:duration, as distinct from a subclass thereof
Parameters: timezone the new timezone offset, in minutes
Returns: the time in the new timezone. This will be a new TimeValue unless no change was required to the original value
Parameters: other The other dateTime value
Returns: negative value if this one is the earler, 0 if they are chronologically equal, positive value if this one is the later. For this purpose, dateTime values with an unknown timezone are considered to be UTC values (the Comparable interface requires a total ordering).
Throws: ClassCastException if the other value is not a TimeValue (the parameter is declared as Object to satisfy the Comparable interface)
Parameters: other The other dateTime value context the XPath dynamic evaluation context
Returns: negative value if this one is the earler, 0 if they are chronologically equal, positive value if this one is the later. For this purpose, dateTime values with an unknown timezone are considered to be UTC values (the Comparable interface requires a total ordering).
Throws: ClassCastException if the other value is not a DateTimeValue (the parameter is declared as Object to satisfy the Comparable interface) NoDynamicContextException if the implicit timezone is required and is not available (because the function is called at compile time)
Parameters: requiredType an integer identifying the required atomic type context XPath dynamic evaluation context
Returns: an AtomicValue, a value of the required type; or an ErrorValue
Parameters: typeLabel the new type label. This must be a subtype of xs:time.
Returns: the canonical lexical representation if defined in XML Schema
Parameters: context XPath dynamic context
Throws: NoDynamicContextException if the implicit timezone is required and is not available
Returns: the hour
Returns: the microseconds
Returns: the minute
Returns: ISO 8601 representation, in the localized timezone (the timezone held within the value).
Returns: the second
Parameters: s the time in the lexical format hh:mm:ss[.ffffff] followed optionally by timezone in the form [+-]hh:mm or Z
Returns: either a TimeValue corresponding to the xs:time, or a ValidationFailure if the supplied value was invalid
Parameters: other the other point in time context XPath dynamic evaluation context
Returns: the duration as an xs:dayTimeDuration
Throws: XPathException for example if one value is a date and the other is a time