org.joda.time.field
Class OffsetDateTimeField
public class OffsetDateTimeField
Generic offset adjusting datetime field.
OffsetDateTimeField is thread-safe and immutable.
long | add(long instant, int amount) - Add the specified amount of offset units to the specified time
instant.
|
long | add(long instant, long amount) - Add the specified amount of offset units to the specified time
instant.
|
long | addWrapField(long instant, int amount) - Add to the offset component of the specified time instant,
wrapping around within that component if necessary.
|
int | get(long instant) - Get the amount of offset units from the specified time instant.
|
int | getLeapAmount(long instant) - Gets the amount by which this field is 'leap' for the specified instant.
|
DurationField | getLeapDurationField() - If this field were to leap, then it would be in units described by the
returned duration.
|
int | getMaximumValue() - Get the maximum value for the field.
|
int | getMinimumValue() - Get the minimum value for the field.
|
int | getOffset() - Returns the offset added to the field values.
|
boolean | isLeap(long instant) - Returns whether this field is 'leap' for the specified instant.
|
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 offset 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 |
OffsetDateTimeField
public OffsetDateTimeField(DateTimeField field,
int offset)
Constructor.
field
- the field to wrap, like "year()".offset
- offset to add to field values
OffsetDateTimeField
public OffsetDateTimeField(DateTimeField field,
DateTimeFieldType type,
int offset)
Constructor.
field
- the field to wrap, like "year()".type
- the field type this field actually usesoffset
- offset to add to field values
OffsetDateTimeField
public OffsetDateTimeField(DateTimeField field,
DateTimeFieldType type,
int offset,
int minValue,
int maxValue)
Constructor.
field
- the field to wrap, like "year()".type
- the field type this field actually usesoffset
- offset to add to field valuesminValue
- minimum allowed valuemaxValue
- maximum allowed value
add
public long add(long instant,
int amount)
Add the specified amount of offset 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 units to add (can be negative).
- the updated time instant.
add
public long add(long instant,
long amount)
Add the specified amount of offset 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 units to add (can be negative).
- the updated time instant.
addWrapField
public long addWrapField(long instant,
int amount)
Add to the offset 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 units to add (can be negative).
- the updated time instant.
get
public int get(long instant)
Get the amount of offset units from the specified time instant.
- get in interface DecoratedDateTimeField
instant
- the time instant in millis to query.
- the amount of units extracted from the input.
getLeapAmount
public int getLeapAmount(long instant)
Gets the amount by which this field is 'leap' for the specified instant.
For example, a leap year would return one, a non leap year would return
zero.
This implementation returns zero.
- getLeapAmount in interface BaseDateTimeField
getLeapDurationField
public DurationField getLeapDurationField()
If this field were to leap, then it would be in units described by the
returned duration. If this field doesn't ever leap, null is returned.
This implementation returns null.
- getLeapDurationField in interface BaseDateTimeField
getOffset
public int getOffset()
Returns the offset added to the field values.
isLeap
public boolean isLeap(long instant)
Returns whether this field is 'leap' for the specified instant.
For example, a leap year would return true, a non leap year would return
false.
This implementation returns false.
- isLeap in interface BaseDateTimeField
- true if the field is 'leap'
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
roundCeiling
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.
- roundCeiling in interface BaseDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to round
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
roundHalfCeiling
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.
- roundHalfCeiling in interface BaseDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to round
roundHalfEven
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.
- roundHalfEven in interface BaseDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to round
roundHalfFloor
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.
- roundHalfFloor in interface BaseDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to round
set
public long set(long instant,
int value)
Set the specified amount of offset units to the specified time instant.
- set in interface DecoratedDateTimeField
instant
- the time instant in millis to update.value
- value of units to set.
- the updated time instant.
Copyright (c) 2001-2006 - Joda.org