Class DelegatedDurationField
- All Implemented Interfaces:
Serializable,Comparable<DurationField>
DelegatedDurationField delegates each method call to the
duration field it wraps.
DelegatedDurationField is thread-safe and immutable, and its subclasses must be as well.
- Since:
- 1.0
- Author:
- Brian S O'Neill
- See Also:
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructor.protectedDelegatedDurationField(DurationField field, DurationFieldType type) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionlongadd(long instant, int value) Adds a duration value (which may be negative) to the instant.longadd(long instant, long value) Adds a duration value (which may be negative) to the instant.intcompareTo(DurationField durationField) booleanintgetDifference(long minuendInstant, long subtrahendInstant) Computes the difference between two instants, as measured in the units of this field.longgetDifferenceAsLong(long minuendInstant, long subtrahendInstant) Computes the difference between two instants, as measured in the units of this field.longgetMillis(int value) Get the millisecond duration of this field from its value, which is approximate if this field is imprecise.longgetMillis(int value, long instant) Get the millisecond duration of this field from its value relative to an instant.longgetMillis(long value) Get the millisecond duration of this field from its value, which is approximate if this field is imprecise.longgetMillis(long value, long instant) Get the millisecond duration of this field from its value relative to an instant.getName()Get the name of the field.getType()Get the type of the field.longReturns the amount of milliseconds per unit value of this field.intgetValue(long duration) Get the value of this field from the milliseconds, which is approximate if this field is imprecise.intgetValue(long duration, long instant) Get the value of this field from the milliseconds relative to an instant.longgetValueAsLong(long duration) Get the value of this field from the milliseconds, which is approximate if this field is imprecise.longgetValueAsLong(long duration, long instant) Get the value of this field from the milliseconds relative to an instant.final DurationFieldGets the wrapped duration field.inthashCode()booleanIs this field precise.booleanReturns true if this field is supported.toString()Get a suitable debug string.Methods inherited from class org.joda.time.DurationField
subtract, subtract
-
Constructor Details
-
DelegatedDurationField
Constructor.- Parameters:
field- the base field
-
DelegatedDurationField
Constructor.- Parameters:
field- the base fieldtype- the field type to use
-
-
Method Details
-
getWrappedField
Gets the wrapped duration field.- Returns:
- the wrapped DurationField
-
getType
Description copied from class:DurationFieldGet the type of the field.- Specified by:
getTypein classDurationField- Returns:
- field type
-
getName
Description copied from class:DurationFieldGet the name of the field.By convention, names are plural.
- Specified by:
getNamein classDurationField- Returns:
- field name
-
isSupported
public boolean isSupported()Returns true if this field is supported.- Specified by:
isSupportedin classDurationField- Returns:
- true if this field is supported
-
isPrecise
public boolean isPrecise()Description copied from class:DurationFieldIs this field precise. A precise field can calculate its value from milliseconds without needing a reference date. Put another way, a precise field's unit size is not variable.- Specified by:
isPrecisein classDurationField- Returns:
- true if precise
- See Also:
-
getValue
public int getValue(long duration) Description copied from class:DurationFieldGet the value of this field from the milliseconds, which is approximate if this field is imprecise.- Specified by:
getValuein 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) Description copied from class:DurationFieldGet the value of this field from the milliseconds, which is approximate if this field is imprecise.- Specified by:
getValueAsLongin 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) Description copied from class:DurationFieldGet 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".
- Specified by:
getValuein 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
-
getValueAsLong
public long getValueAsLong(long duration, long instant) Description copied from class:DurationFieldGet 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".
- Specified by:
getValueAsLongin 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) Description copied from class:DurationFieldGet the millisecond duration of this field from its value, which is approximate if this field is imprecise.- Specified by:
getMillisin 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) Description copied from class:DurationFieldGet the millisecond duration of this field from its value, which is approximate if this field is imprecise.- Specified by:
getMillisin 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(int value, long instant) Description copied from class:DurationFieldGet 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".
- Specified by:
getMillisin classDurationField- Parameters:
value- the value of the field, which may be negativeinstant- the instant to calculate relative to- Returns:
- the millisecond duration that the field represents, which may be negative
-
getMillis
public long getMillis(long value, long instant) Description copied from class:DurationFieldGet 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".
- Specified by:
getMillisin classDurationField- Parameters:
value- the value of the field, which may be negativeinstant- the instant to calculate relative to- Returns:
- the millisecond duration that the field represents, which may be negative
-
add
public long add(long instant, int value) Description copied from class:DurationFieldAdds a duration value (which may be negative) to the instant.- Specified by:
addin classDurationField- Parameters:
instant- the milliseconds from 1970-01-01T00:00:00Z to add tovalue- the value to add, in the units of the field- Returns:
- the updated milliseconds
-
add
public long add(long instant, long value) Description copied from class:DurationFieldAdds a duration value (which may be negative) to the instant.- Specified by:
addin classDurationField- Parameters:
instant- the milliseconds from 1970-01-01T00:00:00Z to add tovalue- the value to add, in the units of the field- Returns:
- the updated milliseconds
-
getDifference
public int getDifference(long minuendInstant, long subtrahendInstant) Description copied from class:DurationFieldComputes 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:
getDifferencein 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
-
getDifferenceAsLong
public long getDifferenceAsLong(long minuendInstant, long subtrahendInstant) Description copied from class:DurationFieldComputes 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'.- Specified by:
getDifferenceAsLongin 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
-
getUnitMillis
public long getUnitMillis()Description copied from class:DurationFieldReturns the amount of milliseconds per unit value of this field. For example, if this field represents "seconds", then this returns the milliseconds in one second.For imprecise fields, the unit size is variable, and so this method returns a suitable average value.
- Specified by:
getUnitMillisin classDurationField- Returns:
- the unit size of this field, in milliseconds
- See Also:
-
compareTo
- Specified by:
compareToin interfaceComparable<DurationField>
-
equals
-
hashCode
public int hashCode() -
toString
Description copied from class:DurationFieldGet a suitable debug string.- Specified by:
toStringin classDurationField- Returns:
- debug string
-