|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.joda.time.DurationField
org.joda.time.field.DelegatedDurationField
public class DelegatedDurationField
DelegatedDurationField delegates each method call to the
duration field it wraps.
DelegatedDurationField is thread-safe and immutable, and its subclasses must be as well.
DecoratedDurationField,
Serialized Form| Constructor Summary | |
|---|---|
protected |
DelegatedDurationField(DurationField field)
Constructor. |
protected |
DelegatedDurationField(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. |
int |
compareTo(DurationField durationField)
|
boolean |
equals(Object obj)
|
int |
getDifference(long minuendInstant,
long subtrahendInstant)
Computes the difference between two instants, as measured in the units of this field. |
long |
getDifferenceAsLong(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(int value,
long instant)
Get the millisecond duration of this field from its value relative to an instant. |
long |
getMillis(long value)
Get the millisecond duration of this field from its value, which is approximate if this field is imprecise. |
long |
getMillis(long value,
long instant)
Get the millisecond duration of this field from its value relative to an instant. |
String |
getName()
Get the name of the field. |
DurationFieldType |
getType()
Get the type of the field. |
long |
getUnitMillis()
Returns the amount of milliseconds per unit value of this 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. |
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. |
int |
hashCode()
|
boolean |
isPrecise()
Is this field precise. |
boolean |
isSupported()
Returns true if this field is supported. |
String |
toString()
Get a suitable debug string. |
| Methods inherited from class org.joda.time.DurationField |
|---|
subtract, subtract |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
protected DelegatedDurationField(DurationField field)
field - the base field
protected DelegatedDurationField(DurationField field,
DurationFieldType type)
field - the base fieldtype - the field type to use| Method Detail |
|---|
public final DurationField getWrappedField()
public DurationFieldType getType()
DurationField
getType in class DurationFieldpublic String getName()
DurationFieldBy convention, names are plural.
getName in class DurationFieldpublic boolean isSupported()
isSupported in class DurationFieldpublic boolean isPrecise()
DurationField
isPrecise in class DurationFieldDurationField.getUnitMillis()public int getValue(long duration)
DurationField
getValue in class DurationFieldduration - the milliseconds to query, which may be negative
public long getValueAsLong(long duration)
DurationField
getValueAsLong in class DurationFieldduration - the milliseconds to query, which may be negative
public int getValue(long duration,
long instant)
DurationFieldIf the millisecond duration is positive, then the instant is treated as a "start instant". If negative, the instant is treated as an "end instant".
getValue in class DurationFieldduration - the milliseconds to query, which may be negativeinstant - the start instant to calculate relative to
public long getValueAsLong(long duration,
long instant)
DurationFieldIf 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 DurationFieldduration - the milliseconds to query, which may be negativeinstant - the start instant to calculate relative to
public long getMillis(int value)
DurationField
getMillis in class DurationFieldvalue - the value of the field, which may be negative
public long getMillis(long value)
DurationField
getMillis in class DurationFieldvalue - the value of the field, which may be negative
public long getMillis(int value,
long instant)
DurationFieldIf 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 DurationFieldvalue - the value of the field, which may be negativeinstant - the instant to calculate relative to
public long getMillis(long value,
long instant)
DurationFieldIf 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 DurationFieldvalue - 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 DurationFieldinstant - 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 DurationFieldinstant - the milliseconds from 1970-01-01T00:00:00Z to add tovalue - the value to add, in the units of the field
public 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 minuend
public long getDifferenceAsLong(long minuendInstant,
long subtrahendInstant)
DurationFieldlong instant = ... long v = ... long age = getDifferenceAsLong(add(instant, v), instant);The value 'age' is the same as the value 'v'.
getDifferenceAsLong 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 minuend
public long getUnitMillis()
DurationFieldFor imprecise fields, the unit size is variable, and so this method returns a suitable average value.
getUnitMillis in class DurationFieldDurationField.isPrecise()public int compareTo(DurationField durationField)
compareTo in interface Comparable<DurationField>public boolean equals(Object obj)
equals in class Objectpublic int hashCode()
hashCode in class Objectpublic String toString()
DurationField
toString in class DurationField
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||