public abstract class

BaseDurationField

extends DurationField
implements Serializable
java.lang.Object
   ↳ org.joda.time.DurationField
     ↳ org.joda.time.field.BaseDurationField
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

BaseDurationField provides the common behaviour for DurationField implementations.

This class should generally not be used directly by API users. The DurationField class should be used when different kinds of DurationField objects are to be referenced.

BaseDurationField is thread-safe and immutable, and its subclasses must be as well.

See Also

Summary

Protected Constructors
BaseDurationField(DurationFieldType type)
Public Methods
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 getMillis(int value)
Get the millisecond duration of this field from its value, which is approximate if this field is imprecise.
long getMillis(long value)
Get the millisecond duration of this field from its value, which is approximate if this field is imprecise.
final String getName()
Get the name of the field.
final DurationFieldType getType()
Get the type of the field.
int getValue(long duration, long instant)
Get the value of this field from the milliseconds relative to an instant.
int getValue(long duration)
Get the value of this field from the milliseconds, which is approximate if this field is imprecise.
long getValueAsLong(long duration)
Get the value of this field from the milliseconds, which is approximate if this field is imprecise.
final boolean isSupported()
Returns true if 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

Protected Constructors

protected BaseDurationField (DurationFieldType type)

Public Methods

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 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 (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 final String getName ()

Get the name of the field.

By convention, names are plural.

Returns
  • field name

public final DurationFieldType getType ()

Get the type of the field.

Returns
  • field type

public int getValue (long duration, long instant)

Get the value of this field from the milliseconds relative to an instant.

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

The default implementation returns Utils.safeToInt(getAsLong(millisDuration, 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 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 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 final boolean isSupported ()

Returns true if this field is supported.

Returns
  • true always

public String toString ()

Get a suitable debug string.

Returns
  • debug string