Package org.joda.time

Class DurationFieldType

java.lang.Object
org.joda.time.DurationFieldType
All Implemented Interfaces:
Serializable

public abstract class DurationFieldType extends Object implements Serializable
Identifies a duration field, such as years or minutes, in a chronology-neutral way.

A duration field type defines the type of the field, such as hours. If does not directly enable any calculations, however it does provide a getField(Chronology) method that returns the actual calculation engine for a particular chronology.

Instances of DurationFieldType are singletons. They can be compared using ==.

If required, you can create your own field, for example a quarters. You must create a subclass of DurationFieldType that defines the field type. This class returns the actual calculation engine from getField(Chronology).

Since:
1.0
Author:
Stephen Colebourne, Brian S O'Neill
See Also:
  • Constructor Details

    • DurationFieldType

      protected DurationFieldType(String name)
      Constructor.
      Parameters:
      name - the name to use, which by convention, are plural.
  • Method Details

    • millis

      public static DurationFieldType millis()
      Get the millis field type.
      Returns:
      the DurationFieldType constant
    • seconds

      public static DurationFieldType seconds()
      Get the seconds field type.
      Returns:
      the DurationFieldType constant
    • minutes

      public static DurationFieldType minutes()
      Get the minutes field type.
      Returns:
      the DurationFieldType constant
    • hours

      public static DurationFieldType hours()
      Get the hours field type.
      Returns:
      the DurationFieldType constant
    • halfdays

      public static DurationFieldType halfdays()
      Get the halfdays field type.
      Returns:
      the DurationFieldType constant
    • days

      public static DurationFieldType days()
      Get the days field type.
      Returns:
      the DurationFieldType constant
    • weeks

      public static DurationFieldType weeks()
      Get the weeks field type.
      Returns:
      the DurationFieldType constant
    • weekyears

      public static DurationFieldType weekyears()
      Get the weekyears field type.
      Returns:
      the DurationFieldType constant
    • months

      public static DurationFieldType months()
      Get the months field type.
      Returns:
      the DurationFieldType constant
    • years

      public static DurationFieldType years()
      Get the years field type.
      Returns:
      the DurationFieldType constant
    • centuries

      public static DurationFieldType centuries()
      Get the centuries field type.
      Returns:
      the DurationFieldType constant
    • eras

      public static DurationFieldType eras()
      Get the eras field type.
      Returns:
      the DurationFieldType constant
    • getName

      public String getName()
      Get the name of the field. By convention, names are plural.
      Returns:
      field name
    • getField

      public abstract DurationField getField(Chronology chronology)
      Gets a suitable field for this type from the given Chronology.
      Parameters:
      chronology - the chronology to use, null means ISOChronology in default zone
      Returns:
      a suitable field
    • isSupported

      public boolean isSupported(Chronology chronology)
      Checks whether this field supported in the given Chronology.
      Parameters:
      chronology - the chronology to use, null means ISOChronology in default zone
      Returns:
      true if supported
    • toString

      public String toString()
      Get a suitable debug string.
      Overrides:
      toString in class Object
      Returns:
      debug string