private class LimitChronology.LimitDateTimeField extends DecoratedDateTimeField
Modifier and Type | Field and Description |
---|---|
private DurationField |
iDurationField |
private DurationField |
iLeapDurationField |
private DurationField |
iRangeDurationField |
private static long |
serialVersionUID |
Constructor and Description |
---|
LimitDateTimeField(DateTimeField field,
DurationField durationField,
DurationField rangeDurationField,
DurationField leapDurationField) |
Modifier and Type | Method and Description |
---|---|
long |
add(long instant,
int amount)
Adds a value (which may be negative) to the instant value,
overflowing into larger fields if necessary.
|
long |
add(long instant,
long amount)
Adds a value (which may be negative) to the instant value,
overflowing into larger fields if necessary.
|
long |
addWrapField(long instant,
int amount)
Adds a value (which may be negative) to the instant value,
wrapping within this field.
|
int |
get(long instant)
Get the value of this field from the milliseconds.
|
java.lang.String |
getAsShortText(long instant,
java.util.Locale locale)
Get the human-readable, short text value of this field from the milliseconds.
|
java.lang.String |
getAsText(long instant,
java.util.Locale locale)
Get the human-readable, text 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.
|
DurationField |
getDurationField()
Returns the duration per unit value 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 |
getMaximumShortTextLength(java.util.Locale locale)
Get the maximum short text value for this field.
|
int |
getMaximumTextLength(java.util.Locale locale)
Get the maximum text value for this field.
|
int |
getMaximumValue(long instant)
Get the maximum value for this field evaluated at the specified time.
|
int |
getMinimumValue(long instant)
Get the minimum value for this field evaluated at the specified time.
|
DurationField |
getRangeDurationField()
Returns the range duration of this field.
|
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.
|
long |
set(long instant,
java.lang.String text,
java.util.Locale locale)
Sets a value in the milliseconds supplied from a human-readable, text value.
|
getMaximumValue, getMinimumValue, getWrappedField, isLenient
add, addWrapField, addWrapPartial, convertText, getAsShortText, getAsShortText, getAsShortText, getAsShortText, getAsText, getAsText, getAsText, getAsText, getMaximumValue, getMaximumValue, getMinimumValue, getMinimumValue, getName, getType, isSupported, set, set, set, toString
setExtended
private static final long serialVersionUID
private final DurationField iDurationField
private final DurationField iRangeDurationField
private final DurationField iLeapDurationField
LimitDateTimeField(DateTimeField field, DurationField durationField, DurationField rangeDurationField, DurationField leapDurationField)
public int get(long instant)
BaseDateTimeField
get
in class DecoratedDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to querypublic java.lang.String getAsText(long instant, java.util.Locale locale)
BaseDateTimeField
The default implementation returns getAsText(get(instant), locale).
getAsText
in class BaseDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to querylocale
- the locale to use for selecting a text symbol, null means defaultpublic java.lang.String getAsShortText(long instant, java.util.Locale locale)
BaseDateTimeField
The default implementation returns getAsShortText(get(instant), locale).
getAsShortText
in class BaseDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to querylocale
- the locale to use for selecting a text symbol, null means defaultpublic long add(long instant, int amount)
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 toamount
- the value to add, in the units of the fieldpublic long add(long instant, long amount)
BaseDateTimeField
add
in class BaseDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to add toamount
- the long value to add, in the units of the fieldBaseDateTimeField.add(long,int)
public long addWrapField(long instant, int amount)
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 toamount
- the value to add, in the units of the fieldpublic 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 minuendpublic 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 minuendpublic 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 fieldpublic long set(long instant, java.lang.String text, java.util.Locale locale)
BaseDateTimeField
This implementation uses convertText(String, Locale)
and
BaseDateTimeField.set(long, int)
.
Note: subclasses that override this method should also override getAsText.
set
in class BaseDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to set intext
- the text value to setlocale
- the locale to use for selecting a text symbol, null for defaultpublic final DurationField getDurationField()
BaseDateTimeField
getDurationField
in class DecoratedDateTimeField
public final DurationField getRangeDurationField()
BaseDateTimeField
getRangeDurationField
in class DecoratedDateTimeField
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 statuspublic 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 statuspublic final DurationField getLeapDurationField()
BaseDateTimeField
This implementation returns null.
getLeapDurationField
in class BaseDateTimeField
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 roundpublic 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 roundpublic long roundHalfFloor(long instant)
BaseDateTimeField
roundHalfFloor
in class BaseDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to roundpublic long roundHalfCeiling(long instant)
BaseDateTimeField
roundHalfCeiling
in class BaseDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to roundpublic 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 roundpublic 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
remainderpublic int getMinimumValue(long instant)
BaseDateTimeField
This implementation returns the same as BaseDateTimeField.getMinimumValue()
.
getMinimumValue
in class BaseDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to querypublic int getMaximumValue(long instant)
BaseDateTimeField
This implementation returns the same as BaseDateTimeField.getMaximumValue()
.
getMaximumValue
in class BaseDateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to querypublic int getMaximumTextLength(java.util.Locale locale)
BaseDateTimeField
getMaximumTextLength
in class BaseDateTimeField
locale
- the locale to use for selecting a text symbolpublic int getMaximumShortTextLength(java.util.Locale locale)
BaseDateTimeField
getMaximumShortTextLength
in class BaseDateTimeField
locale
- the locale to use for selecting a text symbol