|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.joda.time.DurationField org.joda.time.field.BaseDurationField org.joda.time.field.DecoratedDurationField
public class DecoratedDurationField
DecoratedDurationField
extends BaseDurationField
,
implementing only the minimum required set of methods. These implemented
methods delegate to a wrapped field.
This design allows new DurationField types to be defined that piggyback on top of another, inheriting all the safe method implementations from BaseDurationField. Should any method require pure delegation to the wrapped field, simply override and use the provided getWrappedField method.
DecoratedDurationField is thread-safe and immutable, and its subclasses must be as well.
DelegatedDurationField
,
Serialized FormConstructor Summary | |
---|---|
DecoratedDurationField(DurationField field,
DurationFieldType type)
Constructor. |
Method Summary | |
---|---|
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. |
long |
getDifferenceAsLong(long minuendInstant,
long subtrahendInstant)
Computes the difference between two instants, as measured in the units of this field. |
long |
getMillis(int value,
long instant)
Get the millisecond duration of this field from its value relative to an instant. |
long |
getMillis(long value,
long instant)
Get the millisecond duration of this field from its value relative to an instant. |
long |
getUnitMillis()
Returns the amount of milliseconds per unit value of this field. |
long |
getValueAsLong(long duration,
long instant)
Get the value of this field from the milliseconds relative to an instant. |
DurationField |
getWrappedField()
Gets the wrapped duration field. |
boolean |
isPrecise()
Is this field precise. |
Methods inherited from class org.joda.time.field.BaseDurationField |
---|
compareTo, getDifference, getMillis, getMillis, getName, getType, getValue, getValue, getValueAsLong, isSupported, toString |
Methods inherited from class org.joda.time.DurationField |
---|
subtract, subtract |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DecoratedDurationField(DurationField field, DurationFieldType type)
field
- the base fieldtype
- the type to actually useMethod Detail |
---|
public final DurationField getWrappedField()
public boolean isPrecise()
DurationField
isPrecise
in class DurationField
DurationField.getUnitMillis()
public long getValueAsLong(long duration, long instant)
DurationField
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".
getValueAsLong
in class DurationField
duration
- the milliseconds to query, which may be negativeinstant
- the start instant to calculate relative to
public long getMillis(int value, long instant)
DurationField
If the value is positive, then the instant is treated as a "start instant". If negative, the instant is treated as an "end instant".
getMillis
in class DurationField
value
- the value of the field, which may be negativeinstant
- the instant to calculate relative to
public long getMillis(long value, long instant)
DurationField
If the value is positive, then the instant is treated as a "start instant". If negative, the instant is treated as an "end instant".
getMillis
in class DurationField
value
- the value of the field, which may be negativeinstant
- the instant to calculate relative to
public long add(long instant, int value)
DurationField
add
in class DurationField
instant
- the milliseconds from 1970-01-01T00:00:00Z to add tovalue
- the value to add, in the units of the field
public long add(long instant, long value)
DurationField
add
in class DurationField
instant
- the milliseconds from 1970-01-01T00:00:00Z to add tovalue
- the value to add, in the units of the field
public long getDifferenceAsLong(long minuendInstant, long subtrahendInstant)
DurationField
long instant = ... long v = ... long age = getDifferenceAsLong(add(instant, v), instant);The value 'age' is the same as the value 'v'.
getDifferenceAsLong
in class DurationField
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
public long getUnitMillis()
DurationField
For imprecise fields, the unit size is variable, and so this method returns a suitable average value.
getUnitMillis
in class DurationField
DurationField.isPrecise()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |