Class DayTimeDurationValue

    • Constructor Detail

      • DayTimeDurationValue

        public DayTimeDurationValue​(int sign,
                                    int days,
                                    int hours,
                                    int minutes,
                                    long seconds,
                                    int microseconds)
                             throws java.lang.IllegalArgumentException
        Create a dayTimeDuration given the number of days, hours, minutes, and seconds. This constructor performs no validation. The components (apart from sign) must all be non-negative integers; they need not be normalized (for example, 36 hours is acceptable)
        Parameters:
        sign - positive number for positive durations, negative for negative duratoins
        days - number of days
        hours - number of hours
        minutes - number of minutes
        seconds - number of seconds
        microseconds - number of microseconds
        Throws:
        java.lang.IllegalArgumentException - if the value is out of range; specifically, if the total number of seconds exceeds 2^63; or if any of the values is negative
    • Method Detail

      • makeDayTimeDurationValue

        public static ConversionResult makeDayTimeDurationValue​(java.lang.CharSequence s)
        Factory method: create a duration value from a supplied string, in ISO 8601 format [-]PnDTnHnMnS
        Parameters:
        s - the lexical representation of the xs:dayTimeDuration value
        Returns:
        a DayTimeDurationValue if the format is correct, or a ValidationErrorValue if not
      • copyAsSubType

        public AtomicValue copyAsSubType​(AtomicType typeLabel)
        Create a copy of this atomic value, with a different type label
        Overrides:
        copyAsSubType in class DurationValue
        Parameters:
        typeLabel - the type label of the new copy. The caller is responsible for checking that the value actually conforms to this type.
        Returns:
        the copied value
      • 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.
        Overrides:
        getPrimitiveType in class DurationValue
        Returns:
        the primitive type
      • getPrimitiveStringValue

        public java.lang.CharSequence getPrimitiveStringValue()
        Convert to string
        Overrides:
        getPrimitiveStringValue in class DurationValue
        Returns:
        ISO 8601 representation.
      • getLengthInSeconds

        public double getLengthInSeconds()
        Get length of duration in seconds
        Overrides:
        getLengthInSeconds in class DurationValue
        Returns:
        the duration in seconds, as a double
      • getLengthInMicroseconds

        public long getLengthInMicroseconds()
        Get length of duration in microseconds, as a long
        Returns:
        the length in microseconds
      • fromSeconds

        public static DayTimeDurationValue fromSeconds​(java.math.BigDecimal seconds)
        Construct a duration value as a number of seconds.
        Parameters:
        seconds - the number of seconds in the duration. May be negative
        Returns:
        the xs:dayTimeDuration value with the specified length
      • fromMilliseconds

        public static DayTimeDurationValue fromMilliseconds​(long milliseconds)
                                                     throws ValidationException
        Construct a duration value as a number of milliseconds.
        Parameters:
        milliseconds - the number of milliseconds in the duration (may be negative)
        Returns:
        the corresponding xs:dayTimeDuration value
        Throws:
        ValidationException - if implementation-defined limits are exceeded, specifically if the total number of seconds exceeds 2^63.
      • fromMicroseconds

        public static DayTimeDurationValue fromMicroseconds​(long microseconds)
                                                     throws java.lang.IllegalArgumentException
        Construct a duration value as a number of microseconds.
        Parameters:
        microseconds - the number of microseconds in the duration. The maximum and minimum limits are such that the number of days in the duration must fit in a 32-bit signed integer.
        Returns:
        the xs:dayTimeDuration represented by the given number of microseconds
        Throws:
        java.lang.IllegalArgumentException - if the value is out of range.
      • multiply

        public DurationValue multiply​(double n)
                               throws XPathException
        Multiply duration by a number. This is also used when dividing a duration by a number.
        Overrides:
        multiply in class DurationValue
        Parameters:
        n - the number to multiply by
        Returns:
        the result of the multiplication
        Throws:
        XPathException
      • negate

        public DurationValue negate()
                             throws java.lang.IllegalArgumentException
        Negate a duration (same as subtracting from zero, but it preserves the type of the original duration)
        Overrides:
        negate in class DurationValue
        Returns:
        the original duration with its sign reversed, retaining its type
        Throws:
        java.lang.IllegalArgumentException - in the extremely unlikely event that the duration is one that cannot be negated (because the limit for positive durations is one second off from the limit for negative durations)
      • compareTo

        public int compareTo​(java.lang.Object other)
        Compare the value to another duration value
        Specified by:
        compareTo in interface java.lang.Comparable
        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:
        java.lang.ClassCastException - if the other value is not a DateTimeValue (the parameter is declared as Object to satisfy the Comparable interface)
      • getXPathComparable

        public java.lang.Object getXPathComparable​(boolean ordered,
                                                   StringCollator collator,
                                                   XPathContext context)
        Get a Comparable value that implements the XPath ordering comparison semantics for this value. Returns null if the value is not comparable according to XPath rules. The default implementation returns the value itself. This is modified for types such as xs:duration which allow ordering comparisons in XML Schema, but not in XPath.
        Overrides:
        getXPathComparable in class DurationValue
        Parameters:
        ordered - true if an ordered comparable is needed
        collator - Collation used for string comparison
        context - XPath dynamic context
        Returns:
        an Object whose equals() and hashCode() methods implement the XPath comparison semantics with respect to this atomic value. If ordered is specified, the result will either be null if no ordering is defined, or will be a Comparable