public class

DecoratedDurationField

extends BaseDurationField
java.lang.Object
   ↳ org.joda.time.DurationField
     ↳ org.joda.time.field.BaseDurationField
       ↳ org.joda.time.field.DecoratedDurationField
Known Direct Subclasses

Class Overview

DecoratedDurationField extends BaseDurationField, implementing only the minimum required set of methods. These implemented methods delegate to a wrapped field.

This design allows new DurationField types to be defined that piggyback on top of another, inheriting all the safe method implementations from BaseDurationField. Should any method require pure delegation to the wrapped field, simply override and use the provided getWrappedField method.

DecoratedDurationField is thread-safe and immutable, and its subclasses must be as well.

See Also

Summary

Public Constructors
DecoratedDurationField(DurationField field, DurationFieldType type)
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.
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 relative to an instant.
long getMillis(long value, long instant)
Get the millisecond duration of this field from its value relative to an instant.
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 relative to an instant.
final DurationField getWrappedField()
Gets the wrapped duration field.
boolean isPrecise()
Is this field 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 DecoratedDurationField (DurationField field, DurationFieldType type)

Constructor.

Parameters
field the base field
type the type to actually use

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 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 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
instant the instant to calculate relative to
Returns
  • the millisecond duration 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 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
instant the instant to calculate relative to
Returns
  • the millisecond duration that the field represents, which may be negative

public long getUnitMillis ()

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.

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 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
instant the start instant to calculate relative to
Returns
  • the value of the field, in the units of the field, which may be negative

public final DurationField getWrappedField ()

Gets the wrapped duration field.

Returns
  • the wrapped DurationField

public boolean isPrecise ()

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.

Returns
  • true if precise