Package org.joda.time.field
Class BaseDurationField
java.lang.Object
org.joda.time.DurationField
org.joda.time.field.BaseDurationField
- All Implemented Interfaces:
Serializable
,Comparable<DurationField>
- Direct Known Subclasses:
DecoratedDurationField
,PreciseDurationField
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.
- Since:
- 1.0
- Author:
- Brian S O'Neill
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
compareTo
(DurationField otherField) 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) 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.final boolean
Returns true if this field is supported.toString()
Get a suitable debug string.Methods inherited from class org.joda.time.DurationField
add, add, getDifferenceAsLong, getMillis, getMillis, getUnitMillis, getValueAsLong, isPrecise, subtract, subtract
-
Constructor Details
-
BaseDurationField
-
-
Method Details
-
getType
Description copied from class:DurationField
Get the type of the field.- Specified by:
getType
in classDurationField
- Returns:
- field type
-
getName
Description copied from class:DurationField
Get the name of the field.By convention, names are plural.
- Specified by:
getName
in classDurationField
- Returns:
- field name
-
isSupported
public final boolean isSupported()Description copied from class:DurationField
Returns true if this field is supported.- Specified by:
isSupported
in classDurationField
- Returns:
- true always
-
getValue
public int getValue(long duration) Get the value of this field from the milliseconds, which is approximate if this field is imprecise.- Specified by:
getValue
in classDurationField
- 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) Get the value of this field from the milliseconds, which is approximate if this field is imprecise.- Specified by:
getValueAsLong
in classDurationField
- 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) 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))
.- Specified by:
getValue
in classDurationField
- Parameters:
duration
- the milliseconds to query, which may be negativeinstant
- 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) Get the millisecond duration of this field from its value, which is approximate if this field is imprecise.- Specified by:
getMillis
in classDurationField
- 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) Get the millisecond duration of this field from its value, which is approximate if this field is imprecise.- Specified by:
getMillis
in classDurationField
- Parameters:
value
- the value of the field, which may be negative- Returns:
- the milliseconds that the field represents, which may be negative
-
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 classDurationField
- Parameters:
minuendInstant
- the milliseconds from 1970-01-01T00:00:00Z to subtract fromsubtrahendInstant
- the milliseconds from 1970-01-01T00:00:00Z to subtract off the minuend- Returns:
- the difference in the units of this field
-
compareTo
- Specified by:
compareTo
in interfaceComparable<DurationField>
-
toString
Get a suitable debug string.- Specified by:
toString
in classDurationField
- Returns:
- debug string
-