Class RelativeDateFormat

    • Constructor Detail

      • RelativeDateFormat

        public RelativeDateFormat()
        Creates a new instance with base milliseconds set to zero.
      • RelativeDateFormat

        public RelativeDateFormat​(Date time)
        Creates a new instance.
        Parameters:
        time - the date/time (null not permitted).
      • RelativeDateFormat

        public RelativeDateFormat​(long baseMillis)
        Creates a new instance.
        Parameters:
        baseMillis - the time zone (null not permitted).
    • Method Detail

      • getBaseMillis

        public long getBaseMillis()
        Returns the base date/time used to calculate the elapsed time for display.
        Returns:
        The base date/time in milliseconds since 1-Jan-1970.
        See Also:
        setBaseMillis(long)
      • setBaseMillis

        public void setBaseMillis​(long baseMillis)
        Sets the base date/time used to calculate the elapsed time for display. This should be specified in milliseconds using the same encoding as java.util.Date.
        Parameters:
        baseMillis - the base date/time in milliseconds.
        See Also:
        getBaseMillis()
      • getShowZeroDays

        public boolean getShowZeroDays()
        Returns the flag that controls whether or not zero day counts are shown in the formatted output.
        Returns:
        The flag.
        See Also:
        setShowZeroDays(boolean)
      • setShowZeroDays

        public void setShowZeroDays​(boolean show)
        Sets the flag that controls whether or not zero day counts are shown in the formatted output.
        Parameters:
        show - the flag.
        See Also:
        getShowZeroDays()
      • getShowZeroHours

        public boolean getShowZeroHours()
        Returns the flag that controls whether or not zero hour counts are shown in the formatted output.
        Returns:
        The flag.
        Since:
        1.0.10
        See Also:
        setShowZeroHours(boolean)
      • setShowZeroHours

        public void setShowZeroHours​(boolean show)
        Sets the flag that controls whether or not zero hour counts are shown in the formatted output.
        Parameters:
        show - the flag.
        Since:
        1.0.10
        See Also:
        getShowZeroHours()
      • getPositivePrefix

        public String getPositivePrefix()
        Returns the string that is prepended to the format if the relative time is positive.
        Returns:
        The string (never null).
        Since:
        1.0.10
        See Also:
        setPositivePrefix(String)
      • setPositivePrefix

        public void setPositivePrefix​(String prefix)
        Sets the string that is prepended to the format if the relative time is positive.
        Parameters:
        prefix - the prefix (null not permitted).
        Since:
        1.0.10
        See Also:
        getPositivePrefix()
      • setDayFormatter

        public void setDayFormatter​(NumberFormat formatter)
        Sets the formatter for the days.
        Parameters:
        formatter - the formatter (null not permitted).
        Since:
        1.0.11
      • getDaySuffix

        public String getDaySuffix()
        Returns the string that is appended to the day count.
        Returns:
        The string.
        See Also:
        setDaySuffix(String)
      • setDaySuffix

        public void setDaySuffix​(String suffix)
        Sets the string that is appended to the day count.
        Parameters:
        suffix - the suffix (null not permitted).
        See Also:
        getDaySuffix()
      • setHourFormatter

        public void setHourFormatter​(NumberFormat formatter)
        Sets the formatter for the hours.
        Parameters:
        formatter - the formatter (null not permitted).
        Since:
        1.0.11
      • getHourSuffix

        public String getHourSuffix()
        Returns the string that is appended to the hour count.
        Returns:
        The string.
        See Also:
        setHourSuffix(String)
      • setHourSuffix

        public void setHourSuffix​(String suffix)
        Sets the string that is appended to the hour count.
        Parameters:
        suffix - the suffix (null not permitted).
        See Also:
        getHourSuffix()
      • setMinuteFormatter

        public void setMinuteFormatter​(NumberFormat formatter)
        Sets the formatter for the minutes.
        Parameters:
        formatter - the formatter (null not permitted).
        Since:
        1.0.11
      • getMinuteSuffix

        public String getMinuteSuffix()
        Returns the string that is appended to the minute count.
        Returns:
        The string.
        See Also:
        setMinuteSuffix(String)
      • setMinuteSuffix

        public void setMinuteSuffix​(String suffix)
        Sets the string that is appended to the minute count.
        Parameters:
        suffix - the suffix (null not permitted).
        See Also:
        getMinuteSuffix()
      • getSecondSuffix

        public String getSecondSuffix()
        Returns the string that is appended to the second count.
        Returns:
        The string.
        See Also:
        setSecondSuffix(String)
      • setSecondSuffix

        public void setSecondSuffix​(String suffix)
        Sets the string that is appended to the second count.
        Parameters:
        suffix - the suffix (null not permitted).
        See Also:
        getSecondSuffix()
      • setSecondFormatter

        public void setSecondFormatter​(NumberFormat formatter)
        Sets the formatter for the seconds and milliseconds.
        Parameters:
        formatter - the formatter (null not permitted).
      • format

        public StringBuffer format​(Date date,
                                   StringBuffer toAppendTo,
                                   FieldPosition fieldPosition)
        Formats the given date as the amount of elapsed time (relative to the base date specified in the constructor).
        Specified by:
        format in class DateFormat
        Parameters:
        date - the date.
        toAppendTo - the string buffer.
        fieldPosition - the field position.
        Returns:
        The formatted date.
      • parse

        public Date parse​(String source,
                          ParsePosition pos)
        Parses the given string (not implemented).
        Specified by:
        parse in class DateFormat
        Parameters:
        source - the date string.
        pos - the parse position.
        Returns:
        null, as this method has not been implemented.
      • equals

        public boolean equals​(Object obj)
        Tests this formatter for equality with an arbitrary object.
        Overrides:
        equals in class DateFormat
        Parameters:
        obj - the object (null permitted).
        Returns:
        A boolean.
      • hashCode

        public int hashCode()
        Returns a hash code for this instance.
        Overrides:
        hashCode in class DateFormat
        Returns:
        A hash code.
      • clone

        public Object clone()
        Returns a clone of this instance.
        Overrides:
        clone in class DateFormat
        Returns:
        A clone.