public class

PreciseDurationField

extends BaseDurationField
java.lang.Object
   ↳ org.joda.time.DurationField
     ↳ org.joda.time.field.BaseDurationField
       ↳ org.joda.time.field.PreciseDurationField

Class Overview

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

PreciseDurationField is thread-safe and immutable.

Summary

Public Constructors
PreciseDurationField(DurationFieldType type, long unitMillis)
Constructor.
Public Methods
long add(long instant, long value)
Adds a duration value (which may be negative) to the instant.
long add(long instant, int 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.
final 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.
final boolean isPrecise()
This field is precise.
[Expand]
Inherited Methods
From class org.joda.time.field.BaseDurationField
From class org.joda.time.DurationField
From class java.lang.Object
From interface java.lang.Comparable

Public Constructors

public PreciseDurationField (DurationFieldType type, long unitMillis)

Constructor.

Parameters
type the field type
unitMillis the unit milliseconds

Public Methods

public long add (long instant, long value)

Adds a duration value (which may be negative) to the instant.

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

public long add (long instant, int value)

Adds a duration value (which may be negative) to the instant.

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

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

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'.

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

public long getMillis (int value, long instant)

Get the millisecond duration of this field from its value.

Parameters
value the value of the field, which may be negative
instant ignored
Returns
  • the milliseconds that the field represents, which may be negative

public long getMillis (long value, long instant)

Get the millisecond duration of this field from its value.

Parameters
value the value of the field, which may be negative
instant ignored
Returns
  • the milliseconds that the field represents, which may be negative

public final long getUnitMillis ()

Returns the amount of milliseconds per unit value of this field.

Returns
  • the unit size of this field, in milliseconds

public long getValueAsLong (long duration, long instant)

Get the value of this field from the milliseconds.

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

public int hashCode ()

Gets a hash code for this instance.

Returns
  • a suitable hashcode

public final boolean isPrecise ()

This field is precise.

Returns
  • true always