public class

RemainderDateTimeField

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

Class Overview

Counterpart remainder datetime field to DividedDateTimeField. The field's unit duration is unchanged, but the range duration is scaled accordingly.

RemainderDateTimeField is thread-safe and immutable.

See Also

Summary

Public Constructors
RemainderDateTimeField(DateTimeField field, DateTimeFieldType type, int divisor)
Constructor.
RemainderDateTimeField(DividedDateTimeField dividedField)
Construct a RemainderDateTimeField that compliments the given DividedDateTimeField.
RemainderDateTimeField(DividedDateTimeField dividedField, DateTimeFieldType type)
Construct a RemainderDateTimeField that compliments the given DividedDateTimeField.
Public Methods
long addWrapField(long instant, int amount)
Add the specified amount to the specified time instant, wrapping around within the remainder range if necessary.
int get(long instant)
Get the remainder from the specified time instant.
int getDivisor()
Returns the divisor applied, in the field's units.
int getMaximumValue()
Get the maximum value for the field, which is always one less than the divisor.
int getMinimumValue()
Get the minimum value for the field, which is always zero.
DurationField getRangeDurationField()
Returns a scaled version of the wrapped field's unit duration field.
long remainder(long instant)
Returns the fractional duration milliseconds of this field.
long roundCeiling(long instant)
Round to the highest whole unit of this field.
long roundFloor(long instant)
Round to the lowest whole unit of this field.
long roundHalfCeiling(long instant)
Round to the nearest whole unit of this field.
long roundHalfEven(long instant)
Round to the nearest whole unit of this field.
long roundHalfFloor(long instant)
Round to the nearest whole unit of this field.
long set(long instant, int value)
Set the specified amount of remainder 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 RemainderDateTimeField (DateTimeField field, DateTimeFieldType type, int divisor)

Constructor.

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

public RemainderDateTimeField (DividedDateTimeField dividedField)

Construct a RemainderDateTimeField that compliments the given DividedDateTimeField.

Parameters
dividedField complimentary divided field, like "century()".

public RemainderDateTimeField (DividedDateTimeField dividedField, DateTimeFieldType type)

Construct a RemainderDateTimeField that compliments the given DividedDateTimeField.

Parameters
dividedField complimentary divided field, like "century()".
type the field type this field actually uses

Public Methods

public long addWrapField (long instant, int amount)

Add the specified amount to the specified time instant, wrapping around within the remainder range if necessary. The amount added may be negative.

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

public int get (long instant)

Get the remainder from the specified time instant.

Parameters
instant the time instant in millis to query.
Returns
  • the remainder extracted from the input.

public int getDivisor ()

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

Returns
  • the divisor

public int getMaximumValue ()

Get the maximum value for the field, which is always one less than the divisor.

Returns
  • the maximum value

public int getMinimumValue ()

Get the minimum value for the field, which is always zero.

Returns
  • the minimum value of zero.

public DurationField getRangeDurationField ()

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

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

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 roundCeiling (long instant)

Round to the highest whole unit of this field. The value of this field and all fields of a higher magnitude may be incremented in order to achieve this result. 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 highest whole hour is 2002-11-03T00:00:00.000.

The default implementation calls roundFloor, and if the instant is modified as a result, adds one field unit. Subclasses are encouraged to provide a more efficient implementation.

Parameters
instant the milliseconds from 1970-01-01T00:00:00Z to round
Returns
  • rounded 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 roundHalfCeiling (long instant)

Round to the nearest whole unit of this field. If the given millisecond value is closer to the floor, this function behaves like roundFloor. If the millisecond value is closer to the ceiling or is exactly halfway, this function behaves like roundCeiling.

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

public long roundHalfEven (long instant)

Round to the nearest whole unit of this field. If the given millisecond value is closer to the floor, this function behaves like roundFloor. If the millisecond value is closer to the ceiling, this function behaves like roundCeiling.

If the millisecond value is exactly halfway between the floor and ceiling, the ceiling is chosen over the floor only if it makes this field's value even.

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

public long roundHalfFloor (long instant)

Round to the nearest whole unit of this field. If the given millisecond value is closer to the floor or is exactly halfway, this function behaves like roundFloor. If the millisecond value is closer to the ceiling, this function behaves like roundCeiling.

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 remainder units to the specified time instant.

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