public class

DividedDateTimeField

extends DecoratedDateTimeField
java.lang.Object
   ↳ org.joda.time.DateTimeField
     ↳ org.joda.time.field.BaseDateTimeField
       ↳ org.joda.time.field.DecoratedDateTimeField
         ↳ org.joda.time.field.DividedDateTimeField

Class Overview

Divides a DateTimeField such that the retrieved values are reduced by a fixed divisor. The field's unit duration is scaled accordingly, but the range duration is unchanged.

DividedDateTimeField is thread-safe and immutable.

See Also

Summary

Public Constructors
DividedDateTimeField(DateTimeField field, DateTimeFieldType type, int divisor)
Constructor.
DividedDateTimeField(RemainderDateTimeField remainderField, DateTimeFieldType type)
Construct a DividedDateTimeField that compliments the given RemainderDateTimeField.
Public Methods
long add(long instant, long amount)
Add the specified amount of scaled units to the specified time instant.
long add(long instant, int amount)
Add the specified amount of scaled units to the specified time instant.
long addWrapField(long instant, int amount)
Add to the scaled component of the specified time instant, wrapping around within that component if necessary.
int get(long instant)
Get the amount of scaled units from the specified time instant.
int getDifference(long minuendInstant, long subtrahendInstant)
Computes the difference between two instants, as measured in the units of this field.
long getDifferenceAsLong(long minuendInstant, long subtrahendInstant)
Computes the difference between two instants, as measured in the units of this field.
int getDivisor()
Returns the divisor applied, in the field's units.
DurationField getDurationField()
Returns a scaled version of the wrapped field's unit duration field.
int getMaximumValue()
Get the maximum value for the field.
int getMinimumValue()
Get the minimum value for the field.
long remainder(long instant)
Returns the fractional duration milliseconds of this field.
long roundFloor(long instant)
Round to the lowest whole unit of this field.
long set(long instant, int value)
Set the specified amount of scaled units to the specified time instant.
[Expand]
Inherited Methods
From class org.joda.time.field.DecoratedDateTimeField
From class org.joda.time.field.BaseDateTimeField
From class org.joda.time.DateTimeField
From class java.lang.Object

Public Constructors

public DividedDateTimeField (DateTimeField field, DateTimeFieldType type, int divisor)

Constructor.

Parameters
field the field to wrap, like "year()".
type the field type this field will actually use
divisor divisor, such as 100 years in a century
Throws
IllegalArgumentException if divisor is less than two

public DividedDateTimeField (RemainderDateTimeField remainderField, DateTimeFieldType type)

Construct a DividedDateTimeField that compliments the given RemainderDateTimeField.

Parameters
remainderField complimentary remainder field, like "yearOfCentury()".
type the field type this field will actually use

Public Methods

public long add (long instant, long amount)

Add the specified amount of scaled units to the specified time instant. The amount added may be negative.

Parameters
instant the time instant in millis to update.
amount the amount of scaled units to add (can be negative).
Returns
  • the updated time instant.

public long add (long instant, int amount)

Add the specified amount of scaled units to the specified time instant. The amount added may be negative.

Parameters
instant the time instant in millis to update.
amount the amount of scaled units to add (can be negative).
Returns
  • the updated time instant.

public long addWrapField (long instant, int amount)

Add to the scaled component of the specified time instant, wrapping around within that component if necessary.

Parameters
instant the time instant in millis to update.
amount the amount of scaled units to add (can be negative).
Returns
  • the updated time instant.

public int get (long instant)

Get the amount of scaled units from the specified time instant.

Parameters
instant the time instant in millis to query.
Returns
  • the amount of scaled units extracted from the input.

public int getDifference (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 = ...
 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 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 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 int getDivisor ()

Returns the divisor applied, in the field's units.

Returns
  • the divisor

public DurationField getDurationField ()

Returns a scaled version of the wrapped field's unit duration field.

Returns
  • the duration of this field, or UnsupportedDurationField if field has no duration

public int getMaximumValue ()

Get the maximum value for the field.

Returns
  • the maximum value

public int getMinimumValue ()

Get the minimum value for the field.

Returns
  • the minimum value

public long remainder (long instant)

Returns the fractional duration milliseconds of this field. In other words, calling remainder returns the duration that roundFloor would subtract.

For example, on a datetime of 2002-11-02T23:34:56.789, the remainder by hour is 34 minutes and 56.789 seconds.

The default implementation computes instant - roundFloor(instant). Subclasses are encouraged to provide a more efficient implementation.

Parameters
instant the milliseconds from 1970-01-01T00:00:00Z to get the remainder
Returns
  • remainder duration, in milliseconds

public long roundFloor (long instant)

Round to the lowest whole unit of this field. After rounding, the value of this field and all fields of a higher magnitude are retained. The fractional millis that cannot be expressed in whole increments of this field are set to minimum.

For example, a datetime of 2002-11-02T23:34:56.789, rounded to the lowest whole hour is 2002-11-02T23:00:00.000.

Parameters
instant the milliseconds from 1970-01-01T00:00:00Z to round
Returns
  • rounded milliseconds

public long set (long instant, int value)

Set the specified amount of scaled units to the specified time instant.

Parameters
instant the time instant in millis to update.
value value of scaled units to set.
Returns
  • the updated time instant.
Throws
IllegalArgumentException if value is too large or too small.