public final class

MillisDurationField

extends DurationField
implements Serializable
java.lang.Object
   ↳ org.joda.time.DurationField
     ↳ org.joda.time.field.MillisDurationField

Class Overview

Duration field class representing a field with a fixed unit length of one millisecond.

MillisDurationField is thread-safe and immutable.

Summary

Fields
public static final DurationField INSTANCE Singleton instance.
Public Methods
long add(long instant, long value)
Adds a duration value (which may be negative) to the instant.
long add(long instant, int value)
Adds a duration value (which may be negative) to the instant.
int compareTo(Object durationField)
Compares this duration field with another duration field for ascending unit millisecond order.
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(long value, long instant)
Get the millisecond duration of this field from its value relative to an instant.
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.
String getName()
Get the name of the field.
DurationFieldType getType()
Get the type of the field.
final long getUnitMillis()
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.
final boolean isPrecise()
Returns true as this field is precise.
boolean isSupported()
Returns true as this field is supported.
String toString()
Get a suitable debug string.
[Expand]
Inherited Methods
From class org.joda.time.DurationField
From class java.lang.Object
From interface java.lang.Comparable

Fields

public static final DurationField INSTANCE

Singleton instance.

Public Methods

public long add (long instant, long value)

Adds a duration value (which may be negative) to the instant.

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

public long add (long instant, int value)

Adds a duration value (which may be negative) to the instant.

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

public int compareTo (Object durationField)

Compares this duration field with another duration field for ascending unit millisecond order. This ordering is inconsistent with equals, as it ignores name and precision.

Parameters
durationField a duration field to check against
Returns
  • negative value if this is less, 0 if equal, or positive value if greater

public int getDifference (long minuendInstant, long subtrahendInstant)

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'.

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

public long getDifferenceAsLong (long minuendInstant, long subtrahendInstant)

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'.

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

public long getMillis (long value, long instant)

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".

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

public long getMillis (int value)

Get the millisecond duration of this field from its value, which is approximate if this field is imprecise.

Parameters
value the value of the field, which may be negative
Returns
  • the milliseconds that the field represents, which may be negative

public long getMillis (int value, long instant)

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".

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

public long getMillis (long value)

Get the millisecond duration of this field from its value, which is approximate if this field is imprecise.

Parameters
value the value of the field, which may be negative
Returns
  • the milliseconds that the field represents, which may be negative

public String getName ()

Get the name of the field.

By convention, names are plural.

Returns
  • field name

public DurationFieldType getType ()

Get the type of the field.

Returns
  • field type

public final long getUnitMillis ()

Returns the amount of milliseconds per unit value of this field.

Returns
  • one always

public int getValue (long duration)

Get the value of this field from the milliseconds, which is approximate if this field is imprecise.

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

public int getValue (long duration, long instant)

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".

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

public long getValueAsLong (long duration)

Get the value of this field from the milliseconds, which is approximate if this field is imprecise.

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

public long getValueAsLong (long duration, long instant)

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".

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

public final boolean isPrecise ()

Returns true as this field is precise.

Returns
  • true always

public boolean isSupported ()

Returns true as this field is supported.

Returns
  • true always

public String toString ()

Get a suitable debug string.

Returns
  • debug string