org.joda.time.field
Class DividedDateTimeField
public class DividedDateTimeField
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.
- Stephen Colebourne
- Brian S O'Neill
long | add(long instant, int amount) - Add the specified amount of scaled units to the specified time
instant.
|
long | add(long instant, long 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.
|
add , add , add , addWrapField , addWrapField , addWrapPartial , convertText , get , getAsShortText , getAsShortText , getAsShortText , getAsShortText , getAsShortText , getAsText , getAsText , getAsText , getAsText , getAsText , getDifference , getDifferenceAsLong , getDurationField , getLeapAmount , getLeapDurationField , getMaximumShortTextLength , getMaximumTextLength , getMaximumValue , getMaximumValue , getMaximumValue , getMaximumValue , getMinimumValue , getMinimumValue , getMinimumValue , getMinimumValue , getName , getRangeDurationField , getType , isLeap , isSupported , remainder , roundCeiling , roundFloor , roundHalfCeiling , roundHalfEven , roundHalfFloor , set , set , set , set , set , toString |
add , add , add , addWrapField , addWrapField , addWrapPartial , get , getAsShortText , getAsShortText , getAsShortText , getAsShortText , getAsShortText , getAsText , getAsText , getAsText , getAsText , getAsText , getDifference , getDifferenceAsLong , getDurationField , getLeapAmount , getLeapDurationField , getMaximumShortTextLength , getMaximumTextLength , getMaximumValue , getMaximumValue , getMaximumValue , getMaximumValue , getMinimumValue , getMinimumValue , getMinimumValue , getMinimumValue , getName , getRangeDurationField , getType , isLeap , isLenient , isSupported , remainder , roundCeiling , roundFloor , roundHalfCeiling , roundHalfEven , roundHalfFloor , set , set , set , set , set , toString |
DividedDateTimeField
public DividedDateTimeField(DateTimeField field,
DateTimeFieldType type,
int divisor)
Constructor.
field
- the field to wrap, like "year()".type
- the field type this field will actually usedivisor
- divisor, such as 100 years in a century
DividedDateTimeField
public DividedDateTimeField(RemainderDateTimeField remainderField,
DateTimeFieldType type)
Construct a DividedDateTimeField that compliments the given
RemainderDateTimeField.
remainderField
- complimentary remainder field, like "yearOfCentury()".type
- the field type this field will actually use
add
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.
- add in interface BaseDateTimeField
instant
- the time instant in millis to update.amount
- the amount of scaled units to add (can be negative).
- the updated time instant.
add
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.
- add in interface BaseDateTimeField
instant
- the time instant in millis to update.amount
- the amount of scaled units to add (can be negative).
- the updated time instant.
addWrapField
public long addWrapField(long instant,
int amount)
Add to the scaled component of the specified time instant,
wrapping around within that component if necessary.
- addWrapField in interface BaseDateTimeField
instant
- the time instant in millis to update.amount
- the amount of scaled units to add (can be negative).
- the updated time instant.
get
public int get(long instant)
Get the amount of scaled units from the specified time instant.
- get in interface DecoratedDateTimeField
instant
- the time instant in millis to query.
- the amount of scaled units extracted from the input.
getDifference
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'.
- getDifference in interface BaseDateTimeField
minuendInstant
- the milliseconds from 1970-01-01T00:00:00Z to
subtract fromsubtrahendInstant
- the milliseconds from 1970-01-01T00:00:00Z to
subtract off the minuend
- the difference in the units of this field
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'.
- getDifferenceAsLong in interface BaseDateTimeField
minuendInstant
- the milliseconds from 1970-01-01T00:00:00Z to
subtract fromsubtrahendInstant
- the milliseconds from 1970-01-01T00:00:00Z to
subtract off the minuend
- the difference in the units of this field
getDivisor
public int getDivisor()
Returns the divisor applied, in the field's units.
remainder
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.
- remainder in interface BaseDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to get the
remainder
- remainder duration, in milliseconds
roundFloor
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.
- roundFloor in interface DecoratedDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to round
set
public long set(long instant,
int value)
Set the specified amount of scaled units to the specified time instant.
- set in interface DecoratedDateTimeField
instant
- the time instant in millis to update.value
- value of scaled units to set.
- the updated time instant.
Copyright (c) 2001-2006 - Joda.org