| java.lang.Object
 org.joda.time.DurationField
All known Subclasses: org.joda.time.field.DelegatedDurationField, org.joda.time.field.UnsupportedDurationField, org.joda.time.field.MillisDurationField, org.joda.time.field.BaseDurationField,
| DurationField | | abstract public class DurationField implements Comparable(Code) | | Defines the calculation engine for duration fields.
The interface defines a set of methods that manipulate a millisecond duration
with regards to a single field, such as months or seconds.
This design is extensible so, if you wish, you can extract a different field from
the millisecond duration. A number of standard implementations are provided to assist.
author:
Stephen Colebourne
author:
Brian S O'Neill
since:
1.0 |
| Method Summary | |
| abstract public long | add(long instant, int value)
Adds a duration value (which may be negative) to the instant. | | abstract public long | add(long instant, long value)
Adds a duration value (which may be negative) to the instant. | | abstract public int | compareTo(Object durationField)
Compares this duration field with another duration field for ascending
unit millisecond order. | | abstract public int | getDifference(long minuendInstant, long subtrahendInstant)
Computes the difference between two instants, as measured in the units
of this field. | | abstract public long | getDifferenceAsLong(long minuendInstant, long subtrahendInstant)
Computes the difference between two instants, as measured in the units
of this field. | | abstract public long | getMillis(int value)
Get the millisecond duration of this field from its value, which is
approximate if this field is imprecise. | | abstract public long | getMillis(long value)
Get the millisecond duration of this field from its value, which is
approximate if this field is imprecise. | | abstract public long | getMillis(int value, long instant)
Get the millisecond duration of this field from its value relative to an
instant. | | abstract public long | getMillis(long value, long instant)
Get the millisecond duration of this field from its value relative to an
instant. | | abstract public String | getName()
Get the name of the field. | | abstract public DurationFieldType | getType()
Get the type of the field. | | abstract public long | getUnitMillis()
Returns the amount of milliseconds per unit value of this field. | | abstract public int | getValue(long duration)
Get the value of this field from the milliseconds, which is approximate
if this field is imprecise. | | abstract public int | getValue(long duration, long instant)
Get the value of this field from the milliseconds relative to an
instant. | | abstract public long | getValueAsLong(long duration)
Get the value of this field from the milliseconds, which is approximate
if this field is imprecise. | | abstract public long | getValueAsLong(long duration, long instant)
Get the value of this field from the milliseconds relative to an
instant. | | abstract public boolean | isPrecise()
Is this field precise. | | abstract public boolean | isSupported()
Returns true if this field is supported. | | public long | subtract(long instant, int value)
Subtracts a duration value (which may be negative) from the instant. | | public long | subtract(long instant, long value)
Subtracts a duration value (which may be negative) from the instant. | | abstract public String | toString()
Get a suitable debug string. |
| add | | abstract public long add(long instant, int value)(Code) | | Adds a duration value (which may be negative) to the instant.
Parameters:
instant - the milliseconds from 1970-01-01T00:00:00Z to add to
Parameters:
value - the value to add, in the units of the field the updated milliseconds |
| add | | abstract public long add(long instant, long value)(Code) | | Adds a duration value (which may be negative) to the instant.
Parameters:
instant - the milliseconds from 1970-01-01T00:00:00Z to add to
Parameters:
value - the value to add, in the units of the field the updated milliseconds |
| compareTo | | abstract public int compareTo(Object durationField)(Code) | | Compares this duration field with another duration field for ascending
unit millisecond order. This ordering is inconsistent with equals, as it
ignores name and precision.
Parameters:
durationField - a duration field to check against negative value if this is less, 0 if equal, or positive value if greater
throws:
NullPointerException - if the object is null
throws:
ClassCastException - if the object type is not supported |
| getDifference | | abstract public int getDifference(long minuendInstant, long subtrahendInstant)(Code) | | 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'.
Parameters:
minuendInstant - the milliseconds from 1970-01-01T00:00:00Z tosubtract from
Parameters:
subtrahendInstant - the milliseconds from 1970-01-01T00:00:00Z tosubtract off the minuend the difference in the units of this field |
| getDifferenceAsLong | | abstract public long getDifferenceAsLong(long minuendInstant, long subtrahendInstant)(Code) | | 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 = ...
long v = ...
long age = getDifferenceAsLong(add(instant, v), instant);
The value 'age' is the same as the value 'v'.
Parameters:
minuendInstant - the milliseconds from 1970-01-01T00:00:00Z tosubtract from
Parameters:
subtrahendInstant - the milliseconds from 1970-01-01T00:00:00Z tosubtract off the minuend the difference in the units of this field |
| getMillis | | abstract public long getMillis(int value)(Code) | | Get the millisecond duration of this field from its value, which is
approximate if this field is imprecise.
Parameters:
value - the value of the field, which may be negative the milliseconds that the field represents, which may benegative |
| getMillis | | abstract public long getMillis(long value)(Code) | | Get the millisecond duration of this field from its value, which is
approximate if this field is imprecise.
Parameters:
value - the value of the field, which may be negative the milliseconds that the field represents, which may benegative |
| getMillis | | abstract public long getMillis(int value, long instant)(Code) | | Get 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".
Parameters:
value - the value of the field, which may be negative
Parameters:
instant - the instant to calculate relative to the millisecond duration that the field represents, which may benegative |
| getMillis | | abstract public long getMillis(long value, long instant)(Code) | | Get 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".
Parameters:
value - the value of the field, which may be negative
Parameters:
instant - the instant to calculate relative to the millisecond duration that the field represents, which may benegative |
| getName | | abstract public String getName()(Code) | | Get the name of the field.
By convention, names are plural.
field name |
| getUnitMillis | | abstract public long getUnitMillis()(Code) | | Returns 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.
the unit size of this field, in milliseconds
See Also: DurationField.isPrecise() |
| getValue | | abstract public int getValue(long duration)(Code) | | Get the value of this field from the milliseconds, which is approximate
if this field is imprecise.
Parameters:
duration - the milliseconds to query, which may be negative the value of the field, in the units of the field, which may benegative
throws:
ArithmeticException - if the value is too large for an int |
| getValue | | abstract public int getValue(long duration, long instant)(Code) | | Get 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".
Parameters:
duration - the milliseconds to query, which may be negative
Parameters:
instant - the start instant to calculate relative to the value of the field, in the units of the field, which may benegative
throws:
ArithmeticException - if the value is too large for an int |
| getValueAsLong | | abstract public long getValueAsLong(long duration)(Code) | | Get the value of this field from the milliseconds, which is approximate
if this field is imprecise.
Parameters:
duration - the milliseconds to query, which may be negative the value of the field, in the units of the field, which may benegative |
| getValueAsLong | | abstract public long getValueAsLong(long duration, long instant)(Code) | | Get 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".
Parameters:
duration - the milliseconds to query, which may be negative
Parameters:
instant - the start instant to calculate relative to the value of the field, in the units of the field, which may benegative |
| isPrecise | | abstract public boolean isPrecise()(Code) | | Is 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.
true if precise
See Also: DurationField.getUnitMillis() |
| isSupported | | abstract public boolean isSupported()(Code) | | Returns true if this field is supported.
true if this field is supported |
| subtract | | public long subtract(long instant, int value)(Code) | | Subtracts a duration value (which may be negative) from the instant.
Parameters:
instant - the milliseconds from 1970-01-01T00:00:00Z to subtract from
Parameters:
value - the value to subtract, in the units of the field the updated milliseconds
since:
1.1 |
| subtract | | public long subtract(long instant, long value)(Code) | | Subtracts a duration value (which may be negative) from the instant.
Parameters:
instant - the milliseconds from 1970-01-01T00:00:00Z to subtract from
Parameters:
value - the value to subtract, in the units of the field the updated milliseconds
since:
1.1 |
| toString | | abstract public String toString()(Code) | | Get a suitable debug string.
debug string |
|
|