Class FriendlyDateFormatter

  • public class FriendlyDateFormatter
    extends Object
    Formats a date in a relative, friendly way. For example, "2 minutes ago". A DateFormatter is used to format some dates according to the server's formats and the user's time zone. As such, you will need a new instance of this class for each user and "current time", typically one per request.

    It is recommended that you pass a "now" time to the constructor to ensure that times are formatted against a known standard point in time. The alternate constructor uses the time that this object is created, which is probably not very useful.

    This class is not thread-safe, primarily because it uses a DateFormatter class which is not thread-safe.

    • Constructor Detail

      • FriendlyDateFormatter

        public FriendlyDateFormatter​(DateFormatter dateFormatter)
      • FriendlyDateFormatter

        public FriendlyDateFormatter​(Date now,
                                     DateFormatter dateFormatter)
    • Method Detail

      • getFormatMessage

        public Message getFormatMessage​(Date date)
        Returns the i18n message to format the given date relative to the "now" time passed to the constructor.
        date - the date to format
        the i18n message which can be used to format the date relative to the "now" time