Class DateTimeValue
- java.lang.Object
-
- net.sf.saxon.value.AtomicValue
-
- net.sf.saxon.value.CalendarValue
-
- net.sf.saxon.value.DateTimeValue
-
- All Implemented Interfaces:
java.lang.Comparable,java.lang.Iterable<AtomicValue>,java.time.temporal.TemporalAccessor,AtomicMatchKey,AtomicSequence,GroundedValue,IdentityComparable,Item,Sequence,ConversionResult
public final class DateTimeValue extends CalendarValue implements java.lang.Comparable, java.time.temporal.TemporalAccessor
A value of typexs:dateTime. This contains integer fields year, month, day, hour, minute, second, and nanosecond. All these fields except year must be non-negative. In the internal representation, the sequence of years runs -2, -1, 0, +1, +2: that is, the year before year 1 is year 0.The value also contains a boolean flag
hasNoYearZero. When this flag is set, accessor methods that expose the year value subtract one if it is non-positive: that is, year 0 is displayed as -1, year -1 as -2, and so on. Constructor methods, unless otherwise specified, do not set this flag.From Saxon 9.9, this class implements the Java 8 interface
TemporalAccessorwhich enables it to interoperate with Java 8 temporal classes such asInstantandZonedDateTime.
-
-
Field Summary
Fields Modifier and Type Field Description static DateTimeValueEPOCHFixed date/time used by Java (and Unix) as the origin of the universe: 1970-01-01T00:00:00Z-
Fields inherited from class net.sf.saxon.value.CalendarValue
MISSING_TIMEZONE, NO_TIMEZONE
-
Fields inherited from class net.sf.saxon.value.AtomicValue
typeLabel
-
Fields inherited from interface net.sf.saxon.expr.sort.AtomicMatchKey
NaN_MATCH_KEY
-
-
Constructor Summary
Constructors Constructor Description DateTimeValue(int year, byte month, byte day, byte hour, byte minute, byte second, int nanosecond, int tz)Constructor: construct a DateTimeValue from its components.DateTimeValue(int year, byte month, byte day, byte hour, byte minute, byte second, int microsecond, int tz, boolean hasNoYearZero)Constructor: construct a DateTimeValue from its components.DateTimeValue(java.util.Calendar calendar, boolean tzSpecified)Constructor: create a dateTime value given a Java calendar object.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description DateTimeValueadd(DurationValue duration)Add a duration to a dateTimeDateTimeValueadjustTimezone(int timezone)Return a new dateTime with the same normalized value, but in a different timezone.DateTimeValueadjustToUTC(int implicitTimezone)Normalize the date and time to be in timezone Z.voidcheckValidInJavascript()Check that the value can be handled in Saxon-JSintcompareTo(java.lang.Object v2)Context-free comparison of two DateTimeValue values.intcompareTo(CalendarValue other, int implicitTimezone)Compare the value to another dateTime value, following the XPath comparison semanticsDateTimeValuecopyAsSubType(AtomicType typeLabel)Make a copy of this date, time, or dateTime value, but with a new type labelbooleanequals(java.lang.Object o)Context-free comparison of two dateTime valuesstatic DateTimeValuefromJavaDate(java.util.Date suppliedDate)Factory method: create a dateTime value given a Java Date object.static DateTimeValuefromJavaInstant(long seconds, int nano)Factory method: create a dateTime value given the components of a Java Instant.static DateTimeValuefromJavaInstant(java.time.Instant instant)Factory method: create a dateTime value given a JavaInstant.static DateTimeValuefromJavaTime(long time)Factory method: create a dateTime value given a Java time, expressed in milliseconds since 1970.static DateTimeValuefromJulianInstant(java.math.BigDecimal instant)Get the DateTimeValue corresponding to a given Julian instantstatic DateTimeValuefromLocalDateTime(java.time.LocalDateTime localDateTime)Factory method: create a dateTime value given a JavaLocalDateTime.static DateTimeValuefromOffsetDateTime(java.time.OffsetDateTime offsetDateTime)Factory method: create a dateTime value given a JavaOffsetDateTime.static DateTimeValuefromZonedDateTime(java.time.ZonedDateTime zonedDateTime)Factory method: create a dateTime value given a JavaZonedDateTime.java.util.GregorianCalendargetCalendar()Get a Java Calendar object representing the value of this DateTime.java.lang.CharSequencegetCanonicalLexicalRepresentation()Get the canonical lexical representation as defined in XML Schema.AtomicValuegetComponent(AccessorFn.Component component)Get a component of the value.static DateTimeValuegetCurrentDateTime(XPathContext context)Get the dateTime value representing the nominal date/time of this transformation run.bytegetDay()Get the day component, 1-31bytegetHour()Get the hour component, 0-23longgetLong(java.time.temporal.TemporalField field)Gets the value of the specified field as along.intgetMicrosecond()Get the microsecond component, 0-999999bytegetMinute()Get the minute component, 0-59bytegetMonth()Get the month component, 1-12intgetNanosecond()Get the nanosecond component, 0-999999java.lang.CharSequencegetPrimitiveStringValue()Convert to stringBuiltInAtomicTypegetPrimitiveType()Determine the primitive type of the value.java.lang.ComparablegetSchemaComparable()Get a Comparable value that implements the XML Schema ordering comparison semantics for this value.bytegetSecond()Get the second component, 0-59intgetYear()Get the year component, in its internal form (which allows a year zero)inthashCode()Hash code for context-free comparison of date time values.booleanisSupported(java.time.temporal.TemporalField field)booleanisXsd10Rules()Ask whether this value uses the XSD 1.0 rules (which don't allow year zero) or the XSD 1.1 rules (which do).static ConversionResultmakeDateTimeValue(java.lang.CharSequence s, ConversionRules rules)Factory method: create a dateTime value from a supplied string, in ISO 8601 format.static DateTimeValuemakeDateTimeValue(DateValue date, TimeValue time)Factory method: create a dateTime value given a date and a time.static DateTimeValuenow()Get the dateTime value representing the moment of invocation of this method, in the default timezone set for the platform on which the application is running.static DateTimeValueparse(java.lang.CharSequence s)Factory method: create a dateTime value from a supplied string, in ISO 8601 format, allowing a year value of 0 to represent the year before year 1 (that is, following the XSD 1.1 rules).java.math.BigDecimalsecondsSinceEpoch()DayTimeDurationValuesubtract(CalendarValue other, XPathContext context)Determine the difference between two points in time, as a durationDateTimeValuetoDateTime()Convert the value to an xs:dateTime, retaining all the components that are actually present, and substituting conventional values for components that are missing.DateValuetoDateValue()Extract the Date partjava.time.InstanttoJavaInstant()Get a Java 8Instantcorresponding to this date and time.java.math.BigDecimaltoJulianInstant()Get the Julian instant: a decimal value whose integer part is the Julian day number multiplied by the number of seconds per day, and whose fractional part is the fraction of the second.java.time.LocalDateTimetoLocalDateTime()Get a Java 8LocalDateTimecorresponding to this date and time.java.time.OffsetDateTimetoOffsetDateTime()Get a Java 8OffsetDateTimecorresponding to this date and time.TimeValuetoTimeValue()Extract the Time partjava.time.ZonedDateTimetoZonedDateTime()Get a Java 8ZonedDateTimecorresponding to this date and time.-
Methods inherited from class net.sf.saxon.value.CalendarValue
adjustTimezone, appendTimezone, appendTimezone, asMapKey, getComparisonKey, getTimezoneInMinutes, getXMLGregorianCalendar, getXPathComparable, hasTimezone, identityHashCode, isIdentical, makeCalendarValue, removeTimezone, setTimezoneInMinutes
-
Methods inherited from class net.sf.saxon.value.AtomicValue
asAtomic, atomize, checkPermittedContents, effectiveBooleanValue, getCardinality, getGenre, getItemType, getLength, getStringValue, getStringValueCS, getUType, head, isIdentical, isNaN, itemAt, iterate, iterator, setTypeLabel, toString
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface net.sf.saxon.expr.sort.AtomicMatchKey
asAtomic
-
Methods inherited from interface net.sf.saxon.om.GroundedValue
asIterable, concatenate, containsNode, materialize
-
Methods inherited from interface net.sf.saxon.om.Item
isStreamed, reduce, subsequence, toShortString
-
Methods inherited from interface net.sf.saxon.om.Sequence
makeRepeatable
-
-
-
-
Field Detail
-
EPOCH
public static final DateTimeValue EPOCH
Fixed date/time used by Java (and Unix) as the origin of the universe: 1970-01-01T00:00:00Z
-
-
Constructor Detail
-
DateTimeValue
public DateTimeValue(java.util.Calendar calendar, boolean tzSpecified)Constructor: create a dateTime value given a Java calendar object. The#hasNoYearZeroflag is set totrue.- Parameters:
calendar- holds the date and timetzSpecified- indicates whether the timezone is specified
-
DateTimeValue
public DateTimeValue(int year, byte month, byte day, byte hour, byte minute, byte second, int nanosecond, int tz)Constructor: construct a DateTimeValue from its components. This constructor performs no validation.Note: this constructor accepts the fractional seconds value to nanosecond precision. It creates a DateTimeValue that follows XSD 1.1 conventions: that is, there is a year zero. This can be changed by setting the
hasNoYearZeroproperty.- Parameters:
year- The year (the year before year 1 is year 0)month- The month, 1-12day- The day 1-31hour- the hour value, 0-23minute- the minutes value, 0-59second- the seconds value, 0-59nanosecond- the number of nanoseconds, 0-999_999_999tz- the timezone displacement in minutes from UTC. Supply the valueCalendarValue.NO_TIMEZONEif there is no timezone component.
-
DateTimeValue
public DateTimeValue(int year, byte month, byte day, byte hour, byte minute, byte second, int microsecond, int tz, boolean hasNoYearZero)Constructor: construct a DateTimeValue from its components. This constructor performs no validation.Note: for historic reasons, this constructor accepts the fractional seconds value only to microsecond precision. To get nanosecond precision, use the 8-argument constructor and set the XSD 1.0 option separately
- Parameters:
year- The year as held internally (so the year before year 1 is year 0)month- The month, 1-12day- The day 1-31hour- 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 valueCalendarValue.NO_TIMEZONEif there is no timezone component.hasNoYearZero- true if the dateTime value should behave under XSD 1.0 rules, that is, negative dates assume there is no year zero. Note that regardless of this setting, the year argument is set on the basis that the year before +1 is supplied as zero; but if the hasNoYearZero flag is set, this value will be displayed with a year of -1, andwill return -1
-
-
Method Detail
-
getCurrentDateTime
public static DateTimeValue getCurrentDateTime(XPathContext context)
Get the dateTime value representing the nominal date/time of this transformation run. Two calls within the same query or transformation will always return the same answer.- Parameters:
context- the XPath dynamic context. May be null, in which case the current date and time are taken directly from the system clock- Returns:
- the current xs:dateTime
-
now
public static DateTimeValue now()
Get the dateTime value representing the moment of invocation of this method, in the default timezone set for the platform on which the application is running.- Returns:
- the current dateTime, in the local timezone for the platform.
-
fromJavaDate
public static DateTimeValue fromJavaDate(java.util.Date suppliedDate) throws XPathException
Factory method: create a dateTime value given a Java Date object. The returned dateTime value will always have a timezone, which will always be UTC.- Parameters:
suppliedDate- holds the date and time- Returns:
- the corresponding xs:dateTime value
- Throws:
XPathException- if a dynamic error occurs
-
fromJavaTime
public static DateTimeValue fromJavaTime(long time) throws XPathException
Factory method: create a dateTime value given a Java time, expressed in milliseconds since 1970. The returned dateTime value will always have a timezone, which will always be UTC.- Parameters:
time- the time in milliseconds since the epoch- Returns:
- the corresponding xs:dateTime value
- Throws:
XPathException- if a dynamic error occurs
-
fromJavaInstant
public static DateTimeValue fromJavaInstant(long seconds, int nano) throws XPathException
Factory method: create a dateTime value given the components of a Java Instant. The java.time.Instant class is new in JDK 8, and this method was introduced under older JDKs, so this method takes two arguments, the seconds and nano-seconds values, which can be obtained from a Java Instant using the methods getEpochSecond() and getNano() respectively- Parameters:
seconds- the time in seconds since the epochnano- the additional nanoseconds- Returns:
- the corresponding xs:dateTime value, which will have timezone Z (UTC)
- Throws:
XPathException- if a dynamic error occurs (typically due to overflow)
-
fromJavaInstant
public static DateTimeValue fromJavaInstant(java.time.Instant instant)
Factory method: create a dateTime value given a JavaInstant. Thejava.time.Instantclass is new in JDK 8.- Parameters:
instant- the point in time- Returns:
- the corresponding xs:dateTime value, which will have timezone Z (UTC)
- Since:
- 9.9
-
fromZonedDateTime
public static DateTimeValue fromZonedDateTime(java.time.ZonedDateTime zonedDateTime)
Factory method: create a dateTime value given a JavaZonedDateTime. Thejava.time.ZonedDateTimeclass is new in JDK 8.- Parameters:
zonedDateTime- the supplied zonedDateTime value- Returns:
- the corresponding xs:dateTime value, which will have the same timezone offset as the supplied ZonedDateTime;
the actual (civil) timezone information is lost. The returned value will be an instance of the built-in
subtype
xs:dateTimeStamp - Since:
- 9.9. Changed in 10.0 to retain nanosecond precision.
-
fromOffsetDateTime
public static DateTimeValue fromOffsetDateTime(java.time.OffsetDateTime offsetDateTime)
Factory method: create a dateTime value given a JavaOffsetDateTime. Thejava.time.OffsetDateTimeclass is new in JDK 8.- Parameters:
offsetDateTime- the supplied zonedDateTime value- Returns:
- the corresponding xs:dateTime value, which will have the same timezone offset as the supplied OffsetDateTime.
The returned value will be an instance of the built-in subtype
xs:dateTimeStamp - Since:
- 10.0.
-
fromLocalDateTime
public static DateTimeValue fromLocalDateTime(java.time.LocalDateTime localDateTime)
Factory method: create a dateTime value given a JavaLocalDateTime. Thejava.time.LocalDateTimeclass is new in JDK 8.- Parameters:
localDateTime- the supplied localDateTime value- Returns:
- the corresponding xs:dateTime value, which will have no timezone.
- Since:
- 9.9. Changed in 10.0 to retain nanosecond precision.
-
makeDateTimeValue
public static DateTimeValue makeDateTimeValue(DateValue date, TimeValue time) throws XPathException
Factory method: create a dateTime value given a date and a time.- Parameters:
date- the datetime- the time- Returns:
- the dateTime with the given components. If either component is null, returns null. The returned
DateTimeValuewill have the#hasNoYearZeroproperty if and only if the supplied date has this property. - Throws:
XPathException- if the timezones are both present and inconsistent
-
makeDateTimeValue
public static ConversionResult makeDateTimeValue(java.lang.CharSequence s, ConversionRules rules)
Factory method: create a dateTime value from a supplied string, in ISO 8601 format.If the supplied
ConversionRulesobject hasConversionRules.isAllowYearZero()returning true, then (a) a year value of zero is allowed in the supplied string, and (b) thehasNoYearZeroproperty in the result is set to false. IfConversionRules.isAllowYearZero()returns false, the (a) the year value in the supplied string must not be zero, (b) a year value of -1 in the supplied string is interpreted as representing the year before year 1, and (c) thehasNoYearZeroproperty in the result is set to true.- Parameters:
s- a string in the lexical space of xs:dateTimerules- the conversion rules to be used (determining whether year zero is allowed)- Returns:
- either a DateTimeValue representing the xs:dateTime supplied, or a ValidationFailure if the lexical value was invalid
-
parse
public static DateTimeValue parse(java.lang.CharSequence s) throws java.time.format.DateTimeParseException
Factory method: create a dateTime value from a supplied string, in ISO 8601 format, allowing a year value of 0 to represent the year before year 1 (that is, following the XSD 1.1 rules).The
hasNoYearZeroproperty in the result is set to false.- Parameters:
s- a string in the lexical space of xs:dateTime- Returns:
- a DateTimeValue representing the xs:dateTime supplied, including a timezone offset if present in the lexical representation
- Throws:
java.time.format.DateTimeParseException- if the format of the supplied string is invalid.- Since:
- 9.9
-
getPrimitiveType
public BuiltInAtomicType getPrimitiveType()
Determine the primitive type of the value. This delivers the same answer as getItemType().getPrimitiveItemType(). The primitive types are the 19 primitive types of XML Schema, plus xs:integer, xs:dayTimeDuration and xs:yearMonthDuration, and xs:untypedAtomic. For external objects, the result is AnyAtomicType.- Specified by:
getPrimitiveTypein classAtomicValue- Returns:
- the primitive type
-
getYear
public int getYear()
Get the year component, in its internal form (which allows a year zero)- Returns:
- the year component
-
getMonth
public byte getMonth()
Get the month component, 1-12- Returns:
- the month component
-
getDay
public byte getDay()
Get the day component, 1-31- Returns:
- the day component
-
getHour
public byte getHour()
Get the hour component, 0-23- Returns:
- the hour component (never 24, even if the input was specified as 24:00:00)
-
getMinute
public byte getMinute()
Get the minute component, 0-59- Returns:
- the minute component
-
getSecond
public byte getSecond()
Get the second component, 0-59- Returns:
- the second component
-
getMicrosecond
public int getMicrosecond()
Get the microsecond component, 0-999999- Returns:
- the nanosecond component divided by 1000, rounded towards zero
-
getNanosecond
public int getNanosecond()
Get the nanosecond component, 0-999999- Returns:
- the nanosecond component
-
toDateTime
public DateTimeValue toDateTime()
Convert the value to an xs:dateTime, retaining all the components that are actually present, and substituting conventional values for components that are missing. (This method does nothing in the case of xs:dateTime, but is there to implement a method in theCalendarValueinterface).- Specified by:
toDateTimein classCalendarValue- Returns:
- the value as an xs:dateTime
-
isXsd10Rules
public boolean isXsd10Rules()
Ask whether this value uses the XSD 1.0 rules (which don't allow year zero) or the XSD 1.1 rules (which do).- Returns:
- true if the value uses the XSD 1.0 rules
-
checkValidInJavascript
public void checkValidInJavascript() throws XPathExceptionCheck that the value can be handled in Saxon-JS- Overrides:
checkValidInJavascriptin classAtomicValue- Throws:
XPathException- if it can't be handled in Saxon-JS
-
adjustToUTC
public DateTimeValue adjustToUTC(int implicitTimezone) throws NoDynamicContextException
Normalize the date and time to be in timezone Z.- Parameters:
implicitTimezone- used to supply the implicit timezone, used when the value has no explicit timezone- Returns:
- in general, a new DateTimeValue in timezone Z, representing the same instant in time. Returns the original DateTimeValue if this is already in timezone Z.
- Throws:
NoDynamicContextException- if the implicit timezone is needed and is CalendarValue.MISSING_TIMEZONE or CalendarValue.NO_TIMEZONE
-
toJulianInstant
public java.math.BigDecimal toJulianInstant()
Get the Julian instant: a decimal value whose integer part is the Julian day number multiplied by the number of seconds per day, and whose fractional part is the fraction of the second. This method operates on the local time, ignoring the timezone. The caller should call normalize() before calling this method to get a normalized time.- Returns:
- the Julian instant corresponding to this xs:dateTime value
-
fromJulianInstant
public static DateTimeValue fromJulianInstant(java.math.BigDecimal instant)
Get the DateTimeValue corresponding to a given Julian instant- Parameters:
instant- the Julian instant: a decimal value whose integer part is the Julian day number multiplied by the number of seconds per day, and whose fractional part is the fraction of the second.- Returns:
- the xs:dateTime value corresponding to the Julian instant. This will always be in timezone Z.
-
getCalendar
public java.util.GregorianCalendar getCalendar()
Get a Java Calendar object representing the value of this DateTime. This will respect the timezone if there is one (provided the timezone is within the range supported by theGregorianCalendarclass, which in practice means that it is not -14:00). If there is no timezone or if the timezone is out of range, the result will be in GMT.- Specified by:
getCalendarin classCalendarValue- Returns:
- a Java GregorianCalendar object representing the value of this xs:dateTime value.
-
toJavaInstant
public java.time.Instant toJavaInstant()
Get a Java 8Instantcorresponding to this date and time. The value will respect the time zone offset if present, or will assume UTC otherwise.
-
toZonedDateTime
public java.time.ZonedDateTime toZonedDateTime()
Get a Java 8ZonedDateTimecorresponding to this date and time. The value will respect the time zone offset if present, or will assume UTC otherwise.- Returns:
- a
ZonedDateTimerepresenting this date and time, including its timezone if present, or interpreted as a UTC date/time otherwise. - Since:
- 9.9
-
toOffsetDateTime
public java.time.OffsetDateTime toOffsetDateTime()
Get a Java 8OffsetDateTimecorresponding to this date and time. The value will respect the time zone offset if present, or will assume UTC otherwise.- Returns:
- a
OffsetDateTimerepresenting this date and time, including its timezone if present, or interpreted as a UTC date/time otherwise. - Since:
- 9.9
-
toLocalDateTime
public java.time.LocalDateTime toLocalDateTime()
Get a Java 8LocalDateTimecorresponding to this date and time. The value will ignore any timezone offset present in this value.- Returns:
- a
LocalDateTimeequivalent to this date and time, discarding any time zone offset if present. - Since:
- 9.9
-
getPrimitiveStringValue
public java.lang.CharSequence getPrimitiveStringValue()
Convert to string- Specified by:
getPrimitiveStringValuein classAtomicValue- Returns:
- ISO 8601 representation. The value returned is the localized representation:
that is it uses the timezone contained within the value itself. In the case
of a year earlier than year 1, the value output is the internally-held year,
unless the
hasNoYearZeroflag is set, in which case it is the internal year minus one.
-
toDateValue
public DateValue toDateValue()
Extract the Date part- Returns:
- a DateValue representing the date part of the dateTime, retaining the timezone or its absence
-
toTimeValue
public TimeValue toTimeValue()
Extract the Time part- Returns:
- a TimeValue representing the date part of the dateTime, retaining the timezone or its absence
-
getCanonicalLexicalRepresentation
public java.lang.CharSequence getCanonicalLexicalRepresentation()
Get the canonical lexical representation as defined in XML Schema. This is not always the same as the result of casting to a string according to the XPath rules. For an xs:dateTime it is the date/time adjusted to UTC.- Specified by:
getCanonicalLexicalRepresentationin interfaceAtomicSequence- Overrides:
getCanonicalLexicalRepresentationin classAtomicValue- Returns:
- the canonical lexical representation as defined in XML Schema
-
copyAsSubType
public DateTimeValue copyAsSubType(AtomicType typeLabel)
Make a copy of this date, time, or dateTime value, but with a new type label- Specified by:
copyAsSubTypein classAtomicValue- Parameters:
typeLabel- the type label to be attached to the new copy. It is the caller's responsibility to ensure that the value actually conforms to the rules for this type.- Returns:
- the copied value
-
adjustTimezone
public DateTimeValue adjustTimezone(int timezone)
Return a new dateTime with the same normalized value, but in a different timezone.- Specified by:
adjustTimezonein classCalendarValue- Parameters:
timezone- the new timezone offset, in minutes- Returns:
- the date/time in the new timezone. This will be a new DateTimeValue unless no change was required to the original value
-
add
public DateTimeValue add(DurationValue duration) throws XPathException
Add a duration to a dateTime- Specified by:
addin classCalendarValue- Parameters:
duration- the duration to be added (may be negative)- Returns:
- the new date
- Throws:
XPathException- if the duration is an xs:duration, as distinct from a subclass thereof
-
subtract
public DayTimeDurationValue subtract(CalendarValue other, XPathContext context) throws XPathException
Determine the difference between two points in time, as a duration- Overrides:
subtractin classCalendarValue- Parameters:
other- the other point in timecontext- the XPath dynamic context- Returns:
- the duration as an xs:dayTimeDuration
- Throws:
XPathException- for example if one value is a date and the other is a time
-
secondsSinceEpoch
public java.math.BigDecimal secondsSinceEpoch()
-
getComponent
public AtomicValue getComponent(AccessorFn.Component component) throws XPathException
Get a component of the value. Returns null if the timezone component is requested and is not present.- Overrides:
getComponentin classAtomicValue- Parameters:
component- identifies the required component- Returns:
- the value of the requested component of this value
- Throws:
XPathException- if a dynamic error occurs
-
isSupported
public boolean isSupported(java.time.temporal.TemporalField field)
- Specified by:
isSupportedin interfacejava.time.temporal.TemporalAccessor
-
getLong
public long getLong(java.time.temporal.TemporalField field)
Gets the value of the specified field as along.This queries the date-time for the value of the specified field. The returned value may be outside the valid range of values for the field. If the date-time cannot return the value, because the field is unsupported or for some other reason, an exception will be thrown.
The specification requires some fields (for example
ChronoField.EPOCH_DAYto reflect the local time. The Saxon implementation does not have access to the local time, so it adjusts to UTC instead.- Specified by:
getLongin interfacejava.time.temporal.TemporalAccessor- Parameters:
field- the field to get, not null- Returns:
- the value for the field
- Throws:
java.time.DateTimeException- if a value for the field cannot be obtainedjava.time.temporal.UnsupportedTemporalTypeException- if the field is not supportedjava.lang.ArithmeticException- if numeric overflow occursNote: Implementations must check and handle all fields defined in
ChronoField. If the field is supported, then the value of the field must be returned. If unsupported, then anUnsupportedTemporalTypeExceptionmust be thrown.If the field is not a
ChronoField, then the result of this method is obtained by invokingTemporalField.getFrom(TemporalAccessor)passingthisas the argument.Implementations must ensure that no observable state is altered when this read-only method is invoked.
-
compareTo
public int compareTo(CalendarValue other, int implicitTimezone) throws NoDynamicContextException
Compare the value to another dateTime value, following the XPath comparison semantics- Specified by:
compareToin classCalendarValue- Parameters:
other- The other dateTime valueimplicitTimezone- The implicit timezone to be used for a value with no timezone- 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 values in the implicit timezone (the Comparable interface requires a total ordering).
- Throws:
java.lang.ClassCastException- if the other value is not a DateTimeValue (the parameter is declared as CalendarValue to satisfy the interface)NoDynamicContextException- if the implicit timezone is needed and is not available
-
compareTo
public int compareTo(java.lang.Object v2)
Context-free comparison of two DateTimeValue values. For this to work, the two values must either both have a timezone or both have none.- Specified by:
compareToin interfacejava.lang.Comparable- Parameters:
v2- the other value- Returns:
- the result of the comparison: -1 if the first is earlier, 0 if they are equal, +1 if the first is later
- Throws:
java.lang.ClassCastException- if the values are not comparable (which might be because no timezone is available)
-
getSchemaComparable
public java.lang.Comparable getSchemaComparable()
Description copied from class:AtomicValueGet a Comparable value that implements the XML Schema ordering comparison semantics for this value. An implementation must be provided for all atomic types.In the case of data types that are partially ordered, the returned Comparable extends the standard semantics of the compareTo() method by returning the value
SequenceTool.INDETERMINATE_ORDERINGwhen there is no defined order relationship between two given values. This value is also returned when two values of different types are compared.- Specified by:
getSchemaComparablein interfaceAtomicSequence- Specified by:
getSchemaComparablein classAtomicValue- Returns:
- a Comparable that follows XML Schema comparison rules
-
equals
public boolean equals(java.lang.Object o)
Context-free comparison of two dateTime values- Specified by:
equalsin classAtomicValue- Parameters:
o- the other date time value- Returns:
- true if the two values represent the same instant in time. Return false if one value has a timezone and the other does not (this is the result needed when using keys in a map)
-
hashCode
public int hashCode()
Hash code for context-free comparison of date time values. Note that equality testing and therefore hashCode() works only for values with a timezone- Overrides:
hashCodein classjava.lang.Object- Returns:
- a hash code
-
-