|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.joda.time.DateTimeField org.joda.time.field.BaseDateTimeField org.joda.time.field.DecoratedDateTimeField org.joda.time.field.OffsetDateTimeField
public class OffsetDateTimeField
Generic offset adjusting datetime field.
OffsetDateTimeField is thread-safe and immutable.
Constructor Summary | |
---|---|
OffsetDateTimeField(DateTimeField field,
DateTimeFieldType type,
int offset)
Constructor. |
|
OffsetDateTimeField(DateTimeField field,
DateTimeFieldType type,
int offset,
int minValue,
int maxValue)
Constructor. |
|
OffsetDateTimeField(DateTimeField field,
int offset)
Constructor. |
Method Summary | |
---|---|
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. |
Methods inherited from class org.joda.time.field.DecoratedDateTimeField |
---|
getDurationField, getRangeDurationField, getWrappedField, isLenient |
Methods inherited from class org.joda.time.field.BaseDateTimeField |
---|
add, addWrapField, addWrapPartial, convertText, getAsShortText, getAsShortText, getAsShortText, getAsShortText, getAsShortText, getAsText, getAsText, getAsText, getAsText, getAsText, getDifference, getDifferenceAsLong, getMaximumShortTextLength, getMaximumTextLength, getMaximumValue, getMaximumValue, getMaximumValue, getMinimumValue, getMinimumValue, getMinimumValue, getName, getType, isSupported, set, set, set, set, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public OffsetDateTimeField(DateTimeField field, int offset)
field
- the field to wrap, like "year()".offset
- offset to add to field values
IllegalArgumentException
- if offset is zeropublic OffsetDateTimeField(DateTimeField field, DateTimeFieldType type, int offset)
field
- the field to wrap, like "year()".type
- the field type this field actually usesoffset
- offset to add to field values
IllegalArgumentException
- if offset is zeropublic OffsetDateTimeField(DateTimeField field, DateTimeFieldType type, int offset, int minValue, int maxValue)
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
IllegalArgumentException
- if offset is zeroMethod Detail |
---|
public int get(long instant)
get
in class DecoratedDateTimeField
instant
- the time instant in millis to query.
public long add(long instant, int amount)
add
in class BaseDateTimeField
instant
- the time instant in millis to update.amount
- the amount of units to add (can be negative).
public long add(long instant, long amount)
add
in class BaseDateTimeField
instant
- the time instant in millis to update.amount
- the amount of units to add (can be negative).
BaseDateTimeField.add(long,int)
public long addWrapField(long instant, int amount)
addWrapField
in class BaseDateTimeField
instant
- the time instant in millis to update.amount
- the amount of units to add (can be negative).
public long set(long instant, int value)
set
in class DecoratedDateTimeField
instant
- the time instant in millis to update.value
- value of units to set.
IllegalArgumentException
- if value is too large or too small.public boolean isLeap(long instant)
BaseDateTimeField
For example, a leap year would return true, a non leap year would return false.
This implementation returns false.
isLeap
in class BaseDateTimeField
instant
- the instant to check for leap status
public int getLeapAmount(long instant)
BaseDateTimeField
For example, a leap year would return one, a non leap year would return zero.
This implementation returns zero.
getLeapAmount
in class BaseDateTimeField
instant
- the instant to check for leap status
public DurationField getLeapDurationField()
BaseDateTimeField
This implementation returns null.
getLeapDurationField
in class BaseDateTimeField
public int getMinimumValue()
getMinimumValue
in class DecoratedDateTimeField
public int getMaximumValue()
getMaximumValue
in class DecoratedDateTimeField
public long roundFloor(long instant)
BaseDateTimeField
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 class DecoratedDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to round
public long roundCeiling(long instant)
BaseDateTimeField
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 class BaseDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to round
public long roundHalfFloor(long instant)
BaseDateTimeField
roundHalfFloor
in class BaseDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to round
public long roundHalfCeiling(long instant)
BaseDateTimeField
roundHalfCeiling
in class BaseDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to round
public long roundHalfEven(long instant)
BaseDateTimeField
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 class BaseDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to round
public long remainder(long instant)
BaseDateTimeField
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 class BaseDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to get the
remainder
public int getOffset()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |