Class ResourcesTimeUnit

java.lang.Object
org.ocpsoft.prettytime.impl.ResourcesTimeUnit
All Implemented Interfaces:
TimeUnit
Direct Known Subclasses:
Century, Day, Decade, Hour, JustNow, Millennium, Millisecond, Minute, Month, Second, Week, Year

public abstract class ResourcesTimeUnit extends Object implements TimeUnit
Author:
Lincoln Baxter, III
  • Constructor Details

    • ResourcesTimeUnit

      public ResourcesTimeUnit()
  • Method Details

    • getResourceKeyPrefix

      protected abstract String getResourceKeyPrefix()
      Return the time-unit prefix to specify which value to load from the bundle.
    • getResourceBundleName

      protected final String getResourceBundleName()
      Return the name of the resource bundle from which this unit's format should be loaded.
    • getMaxQuantity

      public long getMaxQuantity()
      Description copied from interface: TimeUnit
      The maximum quantity of this Unit to be used as a threshold for the next largest Unit (e.g. if one Second represents 1000ms, and Second has a maxQuantity of 5, then if the difference between compared timestamps is larger than 5000ms, PrettyTime will move on to the next smallest TimeUnit for calculation; Minute, by default)

      millisPerUnit * maxQuantity = maxAllowedMs

      If maxQuantity is zero, it will be equal to the next highest TimeUnit.getMillisPerUnit() / this.getMillisPerUnit() or infinity if there are no greater TimeUnits

      Specified by:
      getMaxQuantity in interface TimeUnit
    • setMaxQuantity

      public void setMaxQuantity(long maxQuantity)
    • getMillisPerUnit

      public long getMillisPerUnit()
      Description copied from interface: TimeUnit
      The number of milliseconds represented by each instance of this TimeUnit. Must be a positive number greater than zero.
      Specified by:
      getMillisPerUnit in interface TimeUnit
    • setMillisPerUnit

      public void setMillisPerUnit(long millisPerUnit)
    • isPrecise

      public boolean isPrecise()
      Description copied from interface: TimeUnit
      Whether or not this TimeUnit represents a price measurement of time, or a general concept of time. E.g: "minute" as opposed to "moment".
      Specified by:
      isPrecise in interface TimeUnit
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object