Class BasicDurationFormat

All Implemented Interfaces:
Serializable, Cloneable

public class BasicDurationFormat extends DurationFormat
See Also:
  • Field Details

  • Constructor Details

    • BasicDurationFormat

      public BasicDurationFormat()
    • BasicDurationFormat

      public BasicDurationFormat(ULocale locale)
  • Method Details

    • getInstance

      public static BasicDurationFormat getInstance(ULocale locale)
    • format

      public StringBuffer format(Object object, StringBuffer toAppend, FieldPosition pos)
      Description copied from class: DurationFormat
      Format an arbitrary object. Defaults to a call to formatDurationFromNow() for either Long or Date objects.
      Specified by:
      format in class DurationFormat
      Parameters:
      object - the object to format. Should be either a Long, Date, or javax.xml.datatype.Duration object.
      toAppend - the buffer to append to
      pos - the field position, may contain additional error messages.
      Returns:
      the toAppend buffer
    • formatDurationFrom

      public String formatDurationFrom(long duration, long referenceDate)
      Description copied from class: DurationFormat
      Formats a duration expressed in milliseconds from a reference date.

      The reference date allows formatters to use actual durations of variable-length periods (like months) if they wish.

      The duration is expressed as the number of milliseconds in the past (negative values) or future (positive values) with respect to a reference date (expressed as milliseconds in epoch).

      Specified by:
      formatDurationFrom in class DurationFormat
      Parameters:
      duration - the duration in milliseconds
      referenceDate - the date from which to compute the duration
      Returns:
      the formatted time
    • formatDurationFromNow

      public String formatDurationFromNow(long duration)
      Description copied from class: DurationFormat
      Formats a duration expressed in milliseconds.

      This is a convenience method that calls formatDurationFrom using the current system time as the reference date.

      Specified by:
      formatDurationFromNow in class DurationFormat
      Parameters:
      duration - the duration in milliseconds
      Returns:
      the formatted time
    • formatDurationFromNowTo

      public String formatDurationFromNowTo(Date targetDate)
      Description copied from class: DurationFormat
      Formats the duration between now and a target date.

      This is a convenience method that calls formatDurationFrom(long, long) using now as the reference date, and the difference between now and targetDate.getTime() as the duration.

      Specified by:
      formatDurationFromNowTo in class DurationFormat
      Parameters:
      targetDate - the ending date
      Returns:
      the formatted time
    • formatDuration

      public String formatDuration(Object obj)
      JDK 1.5+ only
      Parameters:
      obj - Object being passed.
      Returns:
      The PeriodFormatter object formatted to the object passed.
      See Also:
      • "http://java.sun.com/j2se/1.5.0/docs/api/javax/xml/datatype/Duration.html"