Class MillisDurationField

java.lang.Object
org.joda.time.DurationField
org.joda.time.field.MillisDurationField
All Implemented Interfaces:
Serializable, Comparable<DurationField>

public final class MillisDurationField extends DurationField implements Serializable
Duration field class representing a field with a fixed unit length of one millisecond.

MillisDurationField is thread-safe and immutable.

Since:
1.0
Author:
Brian S O'Neill
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final DurationField
    Singleton instance.
  • Method Summary

    Modifier and Type
    Method
    Description
    long
    add(long instant, int value)
    Adds a duration value (which may be negative) to the instant.
    long
    add(long instant, long value)
    Adds a duration value (which may be negative) to the instant.
    int
     
    boolean
     
    int
    getDifference(long minuendInstant, long subtrahendInstant)
    Computes the difference between two instants, as measured in the units of this field.
    long
    getDifferenceAsLong(long minuendInstant, long subtrahendInstant)
    Computes the difference between two instants, as measured in the units of this field.
    long
    getMillis(int value)
    Get the millisecond duration of this field from its value, which is approximate if this field is imprecise.
    long
    getMillis(int value, long instant)
    Get the millisecond duration of this field from its value relative to an instant.
    long
    getMillis(long value)
    Get the millisecond duration of this field from its value, which is approximate if this field is imprecise.
    long
    getMillis(long value, long instant)
    Get the millisecond duration of this field from its value relative to an instant.
    Get the name of the field.
    Get the type of the field.
    final long
    Returns the amount of milliseconds per unit value of this field.
    int
    getValue(long duration)
    Get the value of this field from the milliseconds, which is approximate if this field is imprecise.
    int
    getValue(long duration, long instant)
    Get the value of this field from the milliseconds relative to an instant.
    long
    getValueAsLong(long duration)
    Get the value of this field from the milliseconds, which is approximate if this field is imprecise.
    long
    getValueAsLong(long duration, long instant)
    Get the value of this field from the milliseconds relative to an instant.
    int
     
    final boolean
    Returns true as this field is precise.
    boolean
    Returns true as this field is supported.
    Get a suitable debug string.

    Methods inherited from class org.joda.time.DurationField

    subtract, subtract

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

    • INSTANCE

      public static final DurationField INSTANCE
      Singleton instance.
  • Method Details

    • getType

      public DurationFieldType getType()
      Description copied from class: DurationField
      Get the type of the field.
      Specified by:
      getType in class DurationField
      Returns:
      field type
    • getName

      public String getName()
      Description copied from class: DurationField
      Get the name of the field.

      By convention, names are plural.

      Specified by:
      getName in class DurationField
      Returns:
      field name
    • isSupported

      public boolean isSupported()
      Returns true as this field is supported.
      Specified by:
      isSupported in class DurationField
      Returns:
      true always
    • isPrecise

      public final boolean isPrecise()
      Returns true as this field is precise.
      Specified by:
      isPrecise in class DurationField
      Returns:
      true always
      See Also:
    • getUnitMillis

      public final long getUnitMillis()
      Returns the amount of milliseconds per unit value of this field.
      Specified by:
      getUnitMillis in class DurationField
      Returns:
      one always
      See Also:
    • getValue

      public int getValue(long duration)
      Description copied from class: DurationField
      Get the value of this field from the milliseconds, which is approximate if this field is imprecise.
      Specified by:
      getValue in class DurationField
      Parameters:
      duration - the milliseconds to query, which may be negative
      Returns:
      the value of the field, in the units of the field, which may be negative
    • getValueAsLong

      public long getValueAsLong(long duration)
      Description copied from class: DurationField
      Get the value of this field from the milliseconds, which is approximate if this field is imprecise.
      Specified by:
      getValueAsLong in class DurationField
      Parameters:
      duration - the milliseconds to query, which may be negative
      Returns:
      the value of the field, in the units of the field, which may be negative
    • getValue

      public int getValue(long duration, long instant)
      Description copied from class: DurationField
      Get the value of this field from the milliseconds relative to an instant. For precise fields this method produces the same result as for the single argument get method.

      If the millisecond duration is positive, then the instant is treated as a "start instant". If negative, the instant is treated as an "end instant".

      Specified by:
      getValue in class DurationField
      Parameters:
      duration - the milliseconds to query, which may be negative
      instant - the start instant to calculate relative to
      Returns:
      the value of the field, in the units of the field, which may be negative
    • getValueAsLong

      public long getValueAsLong(long duration, long instant)
      Description copied from class: DurationField
      Get the value of this field from the milliseconds relative to an instant. For precise fields this method produces the same result as for the single argument get method.

      If the millisecond duration is positive, then the instant is treated as a "start instant". If negative, the instant is treated as an "end instant".

      Specified by:
      getValueAsLong in class DurationField
      Parameters:
      duration - the milliseconds to query, which may be negative
      instant - the start instant to calculate relative to
      Returns:
      the value of the field, in the units of the field, which may be negative
    • getMillis

      public long getMillis(int value)
      Description copied from class: DurationField
      Get the millisecond duration of this field from its value, which is approximate if this field is imprecise.
      Specified by:
      getMillis in class DurationField
      Parameters:
      value - the value of the field, which may be negative
      Returns:
      the milliseconds that the field represents, which may be negative
    • getMillis

      public long getMillis(long value)
      Description copied from class: DurationField
      Get the millisecond duration of this field from its value, which is approximate if this field is imprecise.
      Specified by:
      getMillis in class DurationField
      Parameters:
      value - the value of the field, which may be negative
      Returns:
      the milliseconds that the field represents, which may be negative
    • getMillis

      public long getMillis(int value, long instant)
      Description copied from class: DurationField
      Get the millisecond duration of this field from its value relative to an instant. For precise fields this method produces the same result as for the single argument getMillis method.

      If the value is positive, then the instant is treated as a "start instant". If negative, the instant is treated as an "end instant".

      Specified by:
      getMillis in class DurationField
      Parameters:
      value - the value of the field, which may be negative
      instant - the instant to calculate relative to
      Returns:
      the millisecond duration that the field represents, which may be negative
    • getMillis

      public long getMillis(long value, long instant)
      Description copied from class: DurationField
      Get the millisecond duration of this field from its value relative to an instant. For precise fields this method produces the same result as for the single argument getMillis method.

      If the value is positive, then the instant is treated as a "start instant". If negative, the instant is treated as an "end instant".

      Specified by:
      getMillis in class DurationField
      Parameters:
      value - the value of the field, which may be negative
      instant - the instant to calculate relative to
      Returns:
      the millisecond duration that the field represents, which may be negative
    • add

      public long add(long instant, int value)
      Description copied from class: DurationField
      Adds a duration value (which may be negative) to the instant.
      Specified by:
      add in class DurationField
      Parameters:
      instant - the milliseconds from 1970-01-01T00:00:00Z to add to
      value - the value to add, in the units of the field
      Returns:
      the updated milliseconds
    • add

      public long add(long instant, long value)
      Description copied from class: DurationField
      Adds a duration value (which may be negative) to the instant.
      Specified by:
      add in class DurationField
      Parameters:
      instant - the milliseconds from 1970-01-01T00:00:00Z to add to
      value - the value to add, in the units of the field
      Returns:
      the updated milliseconds
    • getDifference

      public int getDifference(long minuendInstant, long subtrahendInstant)
      Description copied from class: DurationField
      Computes the difference between two instants, as measured in the units of this field. Any fractional units are dropped from the result. Calling getDifference reverses the effect of calling add. In the following code:
       long instant = ...
       int v = ...
       int age = getDifference(add(instant, v), instant);
       
      The value 'age' is the same as the value 'v'.
      Specified by:
      getDifference in class DurationField
      Parameters:
      minuendInstant - the milliseconds from 1970-01-01T00:00:00Z to subtract from
      subtrahendInstant - the milliseconds from 1970-01-01T00:00:00Z to subtract off the minuend
      Returns:
      the difference in the units of this field
    • getDifferenceAsLong

      public long getDifferenceAsLong(long minuendInstant, long subtrahendInstant)
      Description copied from class: DurationField
      Computes the difference between two instants, as measured in the units of this field. Any fractional units are dropped from the result. Calling getDifference reverses the effect of calling add. In the following code:
       long instant = ...
       long v = ...
       long age = getDifferenceAsLong(add(instant, v), instant);
       
      The value 'age' is the same as the value 'v'.
      Specified by:
      getDifferenceAsLong in class DurationField
      Parameters:
      minuendInstant - the milliseconds from 1970-01-01T00:00:00Z to subtract from
      subtrahendInstant - the milliseconds from 1970-01-01T00:00:00Z to subtract off the minuend
      Returns:
      the difference in the units of this field
    • compareTo

      public int compareTo(DurationField otherField)
      Specified by:
      compareTo in interface Comparable<DurationField>
    • equals

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

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

      public String toString()
      Get a suitable debug string.
      Specified by:
      toString in class DurationField
      Returns:
      debug string