java.io.Serializable, java.lang.Comparable<DurationField>DecoratedDurationField, PreciseDurationFieldpublic abstract class BaseDurationField extends DurationField implements java.io.Serializable
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.
DecoratedDurationField,
Serialized Form| Modifier | Constructor | Description |
|---|---|---|
protected |
BaseDurationField(DurationFieldType type) |
| Modifier and Type | Method | Description |
|---|---|---|
int |
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.
|
java.lang.String |
getName() |
Get the name of the field.
|
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.
|
boolean |
isSupported() |
Returns true if this field is supported.
|
java.lang.String |
toString() |
Get a suitable debug string.
|
add, add, getDifferenceAsLong, getMillis, getMillis, getUnitMillis, getValueAsLong, isPrecise, subtract, subtractprotected BaseDurationField(DurationFieldType type)
public final DurationFieldType getType()
DurationFieldgetType in class DurationFieldpublic final java.lang.String getName()
DurationFieldBy convention, names are plural.
getName in class DurationFieldpublic final boolean isSupported()
DurationFieldisSupported in class DurationFieldpublic int getValue(long duration)
getValue in class DurationFieldduration - the milliseconds to query, which may be negativepublic long getValueAsLong(long duration)
getValueAsLong in class DurationFieldduration - the milliseconds to query, which may be negativepublic int getValue(long duration,
long 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)).
getValue in class DurationFieldduration - the milliseconds to query, which may be negativeinstant - the start instant to calculate relative topublic long getMillis(int value)
getMillis in class DurationFieldvalue - the value of the field, which may be negativepublic long getMillis(long value)
getMillis in class DurationFieldvalue - the value of the field, which may be negativepublic int getDifference(long minuendInstant,
long subtrahendInstant)
DurationFieldlong instant = ... int v = ... int age = getDifference(add(instant, v), instant);The value 'age' is the same as the value 'v'.
getDifference in class DurationFieldminuendInstant - the milliseconds from 1970-01-01T00:00:00Z to
subtract fromsubtrahendInstant - the milliseconds from 1970-01-01T00:00:00Z to
subtract off the minuendpublic int compareTo(DurationField otherField)
compareTo in interface java.lang.Comparable<DurationField>public java.lang.String toString()
toString in class DurationField