org.joda.time.field

Class PreciseDurationField

Implemented Interfaces:
Comparable, Serializable

public class PreciseDurationField
extends BaseDurationField

Duration field class representing a field with a fixed unit length.

PreciseDurationField is thread-safe and immutable.

Authors:
Stephen Colebourne
Brian S O'Neill
Since:
1.0

Constructor Summary

PreciseDurationField(DurationFieldType type, long unitMillis)
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.
boolean
equals(Object obj)
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.
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.
int
hashCode()
Gets a hash code for this instance.
boolean
isPrecise()
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

add, add, compareTo, getDifference, getDifferenceAsLong, getMillis, getMillis, getMillis, getMillis, getName, getType, getUnitMillis, getValue, getValue, getValueAsLong, getValueAsLong, isPrecise, isSupported, subtract, subtract, toString

Constructor Details

PreciseDurationField

public PreciseDurationField(DurationFieldType type,
                            long unitMillis)
Constructor.
Parameters:
type - the field type
unitMillis - the unit milliseconds

Method Details

add

public long add(long instant,
                int value)
Adds a duration value (which may be negative) to the instant.
Overrides:
add in interface DurationField
Parameters:
instant - the milliseconds from 1970-01-01T00:00:00Z to add to
value - the value to add, in the units of the field
Returns:
the updated milliseconds

add

public long add(long instant,
                long value)
Adds a duration value (which may be negative) to the instant.
Overrides:
add in interface DurationField
Parameters:
instant - the milliseconds from 1970-01-01T00:00:00Z to add to
value - the value to add, in the units of the field
Returns:
the updated milliseconds

equals

public boolean equals(Object obj)
Compares this duration field to another. Two fields are equal if of the same type and duration.
Parameters:
obj - the object to compare to
Returns:
if equal

getDifferenceAsLong

public long getDifferenceAsLong(long minuendInstant,
                                long subtrahendInstant)
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'.
Overrides:
getDifferenceAsLong in interface DurationField
Parameters:
minuendInstant - the milliseconds from 1970-01-01T00:00:00Z to subtract from
subtrahendInstant - the milliseconds from 1970-01-01T00:00:00Z to subtract off the minuend
Returns:
the difference in the units of this field

getMillis

public long getMillis(int value,
                      long instant)
Get the millisecond duration of this field from its value.
Overrides:
getMillis in interface DurationField
Parameters:
value - the value of the field, which may be negative
instant - 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.
Overrides:
getMillis in interface DurationField
Parameters:
value - the value of the field, which may be negative
instant - ignored
Returns:
the milliseconds that the field represents, which may be negative

getUnitMillis

public final long getUnitMillis()
Returns the amount of milliseconds per unit value of this field.
Overrides:
getUnitMillis in interface DurationField
Returns:
the unit size of this field, in milliseconds

getValueAsLong

public long getValueAsLong(long duration,
                           long instant)
Get the value of this field from the milliseconds.
Overrides:
getValueAsLong in interface DurationField
Parameters:
duration - the milliseconds to query, which may be negative
instant - ignored
Returns:
the value of the field, in the units of the field, which may be negative

hashCode

public int hashCode()
Gets a hash code for this instance.
Returns:
a suitable hashcode

isPrecise

public final boolean isPrecise()
This field is precise.
Overrides:
isPrecise in interface DurationField
Returns:
true always

Copyright (c) 2001-2006 - Joda.org