|
||||||||||
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.ZeroIsMaxDateTimeField
public final class ZeroIsMaxDateTimeField
Wraps another field such that zero values are replaced with one more than it's maximum. This is particularly useful for implementing an clockhourOfDay field, where the midnight value of 0 is replaced with 24.
ZeroIsMaxDateTimeField is thread-safe and immutable.
Constructor Summary | |
---|---|
ZeroIsMaxDateTimeField(DateTimeField field,
DateTimeFieldType type)
Constructor. |
Method Summary | |
---|---|
long |
add(long instant,
int value)
Adds a value (which may be negative) to the instant value, overflowing into larger fields if necessary. |
long |
add(long instant,
long value)
Adds a value (which may be negative) to the instant value, overflowing into larger fields if necessary. |
long |
addWrapField(long instant,
int value)
Adds a value (which may be negative) to the instant value, wrapping within this field. |
int[] |
addWrapField(ReadablePartial instant,
int fieldIndex,
int[] values,
int valueToAdd)
Adds a value (which may be negative) to the partial instant, wrapping within this field. |
int |
get(long instant)
Get the value of this field from the milliseconds. |
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 |
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, which is one more than the wrapped field's maximum value. |
int |
getMaximumValue(long instant)
Get the maximum value for the field, which is one more than the wrapped field's maximum value. |
int |
getMaximumValue(ReadablePartial instant)
Get the maximum value for the field, which is one more than the wrapped field's maximum value. |
int |
getMaximumValue(ReadablePartial instant,
int[] values)
Get the maximum value for the field, which is one more than the wrapped field's maximum value. |
int |
getMinimumValue()
Always returns 1. |
int |
getMinimumValue(long instant)
Always returns 1. |
int |
getMinimumValue(ReadablePartial instant)
Always returns 1. |
int |
getMinimumValue(ReadablePartial instant,
int[] values)
Always returns 1. |
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)
Sets a value in the milliseconds supplied. |
Methods inherited from class org.joda.time.field.DecoratedDateTimeField |
---|
getDurationField, getRangeDurationField, getWrappedField, isLenient |
Methods inherited from class org.joda.time.field.BaseDateTimeField |
---|
add, addWrapPartial, convertText, getAsShortText, getAsShortText, getAsShortText, getAsShortText, getAsShortText, getAsText, getAsText, getAsText, getAsText, getAsText, getMaximumShortTextLength, getMaximumTextLength, 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 ZeroIsMaxDateTimeField(DateTimeField field, DateTimeFieldType type)
field
- the base fieldtype
- the field type this field will actually use
IllegalArgumentException
- if wrapped field's minimum value is not zeroMethod Detail |
---|
public int get(long instant)
BaseDateTimeField
get
in class DecoratedDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to query
public long add(long instant, int value)
BaseDateTimeField
The value will be added to this field. If the value is too large to be added solely to this field, larger fields will increase as required. Smaller fields should be unaffected, except where the result would be an invalid value for a smaller field. In this case the smaller field is adjusted to be in range.
For example, in the ISO chronology:
2000-08-20 add six months is 2001-02-20
2000-08-20 add twenty months is 2002-04-20
2000-08-20 add minus nine months is 1999-11-20
2001-01-31 add one month is 2001-02-28
2001-01-31 add two months is 2001-03-31
add
in class BaseDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to add tovalue
- the value to add, in the units of the field
public long add(long instant, long value)
BaseDateTimeField
add
in class BaseDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to add tovalue
- the long value to add, in the units of the field
BaseDateTimeField.add(long,int)
public long addWrapField(long instant, int value)
BaseDateTimeField
The value will be added to this field. If the value is too large to be added solely to this field then it wraps. Larger fields are always unaffected. Smaller fields should be unaffected, except where the result would be an invalid value for a smaller field. In this case the smaller field is adjusted to be in range.
For example, in the ISO chronology:
2000-08-20 addWrapField six months is 2000-02-20
2000-08-20 addWrapField twenty months is 2000-04-20
2000-08-20 addWrapField minus nine months is 2000-11-20
2001-01-31 addWrapField one month is 2001-02-28
2001-01-31 addWrapField two months is 2001-03-31
The default implementation internally calls set. Subclasses are encouraged to provide a more efficient implementation.
addWrapField
in class BaseDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to add tovalue
- the value to add, in the units of the field
public int[] addWrapField(ReadablePartial instant, int fieldIndex, int[] values, int valueToAdd)
BaseDateTimeField
The value will be added to this field. If the value is too large to be added solely to this field then it wraps. Larger fields are always unaffected. Smaller fields should be unaffected, except where the result would be an invalid value for a smaller field. In this case the smaller field is adjusted to be in range.
For example, in the ISO chronology:
2000-08-20 addWrapField six months is 2000-02-20
2000-08-20 addWrapField twenty months is 2000-04-20
2000-08-20 addWrapField minus nine months is 2000-11-20
2001-01-31 addWrapField one month is 2001-02-28
2001-01-31 addWrapField two months is 2001-03-31
The default implementation internally calls set. Subclasses are encouraged to provide a more efficient implementation.
addWrapField
in class BaseDateTimeField
instant
- the partial instantfieldIndex
- the index of this field in the instantvalues
- the values of the partial instant which should be updatedvalueToAdd
- the value to add, in the units of the field
public int getDifference(long minuendInstant, long subtrahendInstant)
BaseDateTimeField
long instant = ... int v = ... int age = getDifference(add(instant, v), instant);The value 'age' is the same as the value 'v'.
getDifference
in class 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
public long getDifferenceAsLong(long minuendInstant, long subtrahendInstant)
BaseDateTimeField
long instant = ... long v = ... long age = getDifferenceAsLong(add(instant, v), instant);The value 'age' is the same as the value 'v'.
getDifferenceAsLong
in class 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
public long set(long instant, int value)
BaseDateTimeField
The value of this field will be set. If the value is invalid, an exception if thrown.
If setting this field would make other fields invalid, then those fields may be changed. For example if the current date is the 31st January, and the month is set to February, the day would be invalid. Instead, the day would be changed to the closest value - the 28th/29th February as appropriate.
set
in class DecoratedDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to set invalue
- the value to set, in the units of the field
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 getMinimumValue(long instant)
getMinimumValue
in class BaseDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to query
public int getMinimumValue(ReadablePartial instant)
getMinimumValue
in class BaseDateTimeField
instant
- the partial instant to query
public int getMinimumValue(ReadablePartial instant, int[] values)
getMinimumValue
in class BaseDateTimeField
instant
- the partial instant to queryvalues
- the values to use
public int getMaximumValue()
getMaximumValue
in class DecoratedDateTimeField
public int getMaximumValue(long instant)
getMaximumValue
in class BaseDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to query
public int getMaximumValue(ReadablePartial instant)
getMaximumValue
in class BaseDateTimeField
instant
- the partial instant to query
public int getMaximumValue(ReadablePartial instant, int[] values)
getMaximumValue
in class BaseDateTimeField
instant
- the partial instant to queryvalues
- the values to use
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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |