Class TimeValue

    • Constructor Detail

      • TimeValue

        public TimeValue​(byte hour,
                         byte minute,
                         byte second,
                         int microsecond,
                         int tz)
        Construct a time value given the hour, minute, second, and microsecond components. This constructor performs no validation.
        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 CalendarValue.NO_TIMEZONE if there is no timezone component.
      • TimeValue

        public TimeValue​(java.util.GregorianCalendar calendar,
                         int tz)
        Constructor: create a time value given a Java calendar object
        Parameters:
        calendar - holds the date and time
        tz - the timezone offset in minutes, or NO_TIMEZONE indicating that there is no timezone
      • TimeValue

        public TimeValue​(java.lang.CharSequence s)
                  throws XPathException
        Constructor: create a dateTime value from a supplied string, in ISO 8601 format
        Throws:
        XPathException
    • Method Detail

      • convertPrimitive

        public AtomicValue convertPrimitive​(BuiltInAtomicType requiredType,
                                            boolean validate,
                                            XPathContext context)
        Convert to target data type
        Specified by:
        convertPrimitive in class AtomicValue
        Parameters:
        requiredType - an integer identifying the required atomic type
        context -
        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.
        Returns:
        an AtomicValue, a value of the required type; or an ErrorValue
      • toDateTime

        public DateTimeValue toDateTime()
        Convert to a DateTime value. The date components represent a reference date, as defined in the spec for comparing times.
        Specified by:
        toDateTime in class CalendarValue
      • getCalendar

        public java.util.GregorianCalendar getCalendar()
        Get a Java Calendar object corresponding to this time, on a reference date
        Specified by:
        getCalendar in class CalendarValue
        Returns:
        A Calendar object representing the date and time. Note that Java can only represent the time to millisecond precision, and that it does not support the full range of timezones required by XPath (-14:00 to +14:00)
      • adjustTimezone

        public CalendarValue adjustTimezone​(int timezone)
        Return a new time with the same normalized value, but in a different timezone. This is called only for a TimeValue that has an explicit timezone
        Specified by:
        adjustTimezone in class CalendarValue
        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
      • compareTo

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

        public int compareTo​(CalendarValue other,
                             Configuration config)
        Compare the value to another dateTime value
        Specified by:
        compareTo in class CalendarValue
        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)
      • equals

        public boolean equals​(java.lang.Object other)
        Description copied from class: Value
        Compare two (sequence) values for equality. This supports identity constraints in XML Schema, which allow list-valued elements and attributes to participate in key and uniqueness constraints. This method returns false if any error occurs during the comparison, or if any of the items in either sequence is a node rather than an atomic value.
        Overrides:
        equals in class Value
      • hashCode

        public int hashCode()
        Description copied from class: Value
        Return a hash code to support the equals() function
        Overrides:
        hashCode in class Value