Package org.joda.time.field
Class PreciseDurationField
java.lang.Object
org.joda.time.DurationField
org.joda.time.field.BaseDurationField
org.joda.time.field.PreciseDurationField
- All Implemented Interfaces:
Serializable
,Comparable<DurationField>
Duration field class representing a field with a fixed unit length.
PreciseDurationField is thread-safe and immutable.
- Since:
- 1.0
- Author:
- Stephen Colebourne, Brian S O'Neill
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionlong
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.boolean
Compares this duration field to another.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.long
getMillis
(long value, long instant) Get the millisecond duration of this field from its value.final long
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.int
hashCode()
Gets a hash code for this instance.final boolean
This field is 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
-
Constructor Details
-
PreciseDurationField
Constructor.- Parameters:
type
- the field typeunitMillis
- the unit milliseconds
-
-
Method Details
-
isPrecise
public final boolean isPrecise()This field is precise.- Specified by:
isPrecise
in classDurationField
- Returns:
- true always
- See Also:
-
getUnitMillis
public final long getUnitMillis()Returns the amount of milliseconds per unit value of this field.- Specified by:
getUnitMillis
in classDurationField
- Returns:
- the unit size of this field, in milliseconds
- See Also:
-
getValueAsLong
public long getValueAsLong(long duration, long instant) Get the value of this field from the milliseconds.- Specified by:
getValueAsLong
in classDurationField
- Parameters:
duration
- the milliseconds to query, which may be negativeinstant
- ignored- Returns:
- the value of the field, in the units of the field, which may be negative
-
getMillis
public long getMillis(int value, long instant) Get the millisecond duration of this field from its value.- Specified by:
getMillis
in classDurationField
- Parameters:
value
- the value of the field, which may be negativeinstant
- ignored- Returns:
- the milliseconds that the field represents, which may be negative
-
getMillis
public long getMillis(long value, long instant) Get the millisecond duration of this field from its value.- Specified by:
getMillis
in classDurationField
- Parameters:
value
- the value of the field, which may be negativeinstant
- ignored- Returns:
- the milliseconds that the field represents, which may be negative
-
add
public long add(long instant, int value) Description copied from class:DurationField
Adds a duration value (which may be negative) to the instant.- Specified by:
add
in 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:DurationField
Adds a duration value (which may be negative) to the instant.- Specified by:
add
in 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
-
getDifferenceAsLong
public long getDifferenceAsLong(long minuendInstant, long subtrahendInstant) Description copied from class:DurationField
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'.- Specified by:
getDifferenceAsLong
in 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
-
equals
Compares this duration field to another. Two fields are equal if of the same type and duration. -
hashCode
public int hashCode()Gets a hash code for this instance.
-