public abstract class BaseDateTimeField extends DateTimeField
This class should generally not be used directly by API users. The DateTimeField class should be used when different kinds of DateTimeField objects are to be referenced.
BaseDateTimeField is thread-safe and immutable, and its subclasses must be as well.
DecoratedDateTimeField
Modifier | Constructor and Description |
---|---|
protected |
BaseDateTimeField(DateTimeFieldType type)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
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.
|
int[] |
add(ReadablePartial instant,
int fieldIndex,
int[] values,
int valueToAdd)
Adds a value (which may be negative) to the partial instant,
throwing an exception if the maximum size of the instant is reached.
|
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[] |
addWrapPartial(ReadablePartial instant,
int fieldIndex,
int[] values,
int valueToAdd)
Adds a value (which may be negative) to the partial instant,
wrapping the whole partial if the maximum size of the partial is reached.
|
protected int |
convertText(String text,
Locale locale)
Convert the specified text and locale into a value.
|
abstract int |
get(long instant)
Get the value of this field from the milliseconds.
|
String |
getAsShortText(int fieldValue,
Locale locale)
Get the human-readable, short text value of this field from the field value.
|
String |
getAsShortText(long instant)
Get the human-readable, short text value of this field from the milliseconds.
|
String |
getAsShortText(long instant,
Locale locale)
Get the human-readable, short text value of this field from the milliseconds.
|
String |
getAsShortText(ReadablePartial partial,
int fieldValue,
Locale locale)
Get the human-readable, short text value of this field from a partial instant.
|
String |
getAsShortText(ReadablePartial partial,
Locale locale)
Get the human-readable, short text value of this field from a partial instant.
|
String |
getAsText(int fieldValue,
Locale locale)
Get the human-readable, text value of this field from the field value.
|
String |
getAsText(long instant)
Get the human-readable, text value of this field from the milliseconds.
|
String |
getAsText(long instant,
Locale locale)
Get the human-readable, text value of this field from the milliseconds.
|
String |
getAsText(ReadablePartial partial,
int fieldValue,
Locale locale)
Get the human-readable, text value of this field from a partial instant.
|
String |
getAsText(ReadablePartial partial,
Locale locale)
Get the human-readable, text value of this field from a partial 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.
|
abstract 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(Locale locale)
Get the maximum short text value for this field.
|
int |
getMaximumTextLength(Locale locale)
Get the maximum text value for this field.
|
abstract int |
getMaximumValue()
Get the maximum allowable value for this field.
|
int |
getMaximumValue(long instant)
Get the maximum value for this field evaluated at the specified time.
|
int |
getMaximumValue(ReadablePartial instant)
Get the maximum value for this field evaluated at the specified instant.
|
int |
getMaximumValue(ReadablePartial instant,
int[] values)
Get the maximum value for this field using the partial instant and
the specified values.
|
abstract int |
getMinimumValue()
Get the minimum allowable value for this field.
|
int |
getMinimumValue(long instant)
Get the minimum value for this field evaluated at the specified time.
|
int |
getMinimumValue(ReadablePartial instant)
Get the minimum value for this field evaluated at the specified instant.
|
int |
getMinimumValue(ReadablePartial instant,
int[] values)
Get the minimum value for this field using the partial instant and
the specified values.
|
String |
getName()
Get the name of the field.
|
abstract DurationField |
getRangeDurationField()
Returns the range duration of this field.
|
DateTimeFieldType |
getType()
Get the type of the field.
|
boolean |
isLeap(long instant)
Returns whether this field is 'leap' for the specified instant.
|
boolean |
isSupported()
Returns true if this field is supported.
|
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.
|
abstract 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.
|
abstract long |
set(long instant,
int value)
Sets a value in the milliseconds supplied.
|
long |
set(long instant,
String text)
Sets a value in the milliseconds supplied from a human-readable, text value.
|
long |
set(long instant,
String text,
Locale locale)
Sets a value in the milliseconds supplied from a human-readable, text value.
|
int[] |
set(ReadablePartial partial,
int fieldIndex,
int[] values,
int newValue)
Sets a value using the specified partial instant.
|
int[] |
set(ReadablePartial instant,
int fieldIndex,
int[] values,
String text,
Locale locale)
Sets a value in the milliseconds supplied from a human-readable, text value.
|
String |
toString()
Get a suitable debug string.
|
isLenient
protected BaseDateTimeField(DateTimeFieldType type)
public final DateTimeFieldType getType()
DateTimeField
getType
in class DateTimeField
public final String getName()
DateTimeField
By convention, names follow a pattern of "dddOfRrr", where "ddd" represents the (singular) duration unit field name and "Rrr" represents the (singular) duration range field name. If the range field is not applicable, then the name of the field is simply the (singular) duration field name.
getName
in class DateTimeField
public final boolean isSupported()
DateTimeField
isSupported
in class DateTimeField
public abstract int get(long instant)
get
in class DateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to querypublic String getAsText(long instant, Locale locale)
The default implementation returns getAsText(get(instant), locale).
getAsText
in class DateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to querylocale
- the locale to use for selecting a text symbol, null means defaultpublic final String getAsText(long instant)
The default implementation calls getAsText(long, Locale)
.
getAsText
in class DateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to querypublic String getAsText(ReadablePartial partial, int fieldValue, Locale locale)
The default implementation returns getAsText(fieldValue, locale).
getAsText
in class DateTimeField
partial
- the partial instant to queryfieldValue
- the field value of this field, provided for performancelocale
- the locale to use for selecting a text symbol, null for defaultpublic final String getAsText(ReadablePartial partial, Locale locale)
The default implementation calls ReadablePartial.get(DateTimeFieldType)
and getAsText(ReadablePartial, int, Locale)
.
getAsText
in class DateTimeField
partial
- the partial instant to querylocale
- the locale to use for selecting a text symbol, null for defaultpublic String getAsText(int fieldValue, Locale locale)
The default implementation returns Integer.toString(get(instant)).
Note: subclasses that override this method should also override getMaximumTextLength.
getAsText
in class DateTimeField
fieldValue
- the numeric value to convert to textlocale
- the locale to use for selecting a text symbol, null for defaultpublic String getAsShortText(long instant, Locale locale)
The default implementation returns getAsShortText(get(instant), locale).
getAsShortText
in class DateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to querylocale
- the locale to use for selecting a text symbol, null means defaultpublic final String getAsShortText(long instant)
The default implementation calls getAsShortText(long, Locale)
.
getAsShortText
in class DateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to querypublic String getAsShortText(ReadablePartial partial, int fieldValue, Locale locale)
The default implementation returns getAsShortText(fieldValue, locale).
getAsShortText
in class DateTimeField
partial
- the partial instant to queryfieldValue
- the field value of this field, provided for performancelocale
- the locale to use for selecting a text symbol, null for defaultpublic final String getAsShortText(ReadablePartial partial, Locale locale)
The default implementation calls ReadablePartial.get(DateTimeFieldType)
and getAsText(ReadablePartial, int, Locale)
.
getAsShortText
in class DateTimeField
partial
- the partial instant to querylocale
- the locale to use for selecting a text symbol, null for defaultpublic String getAsShortText(int fieldValue, Locale locale)
The default implementation returns getAsText(fieldValue, locale).
Note: subclasses that override this method should also override getMaximumShortTextLength.
getAsShortText
in class DateTimeField
fieldValue
- the numeric value to convert to textlocale
- the locale to use for selecting a text symbol, null for defaultpublic long add(long instant, int value)
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 DateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to add tovalue
- the value to add, in the units of the fieldpublic long add(long instant, long value)
add
in class DateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to add tovalue
- the long value to add, in the units of the fieldIllegalArgumentException
- if value is too largeadd(long,int)
public int[] add(ReadablePartial instant, int fieldIndex, int[] values, int valueToAdd)
The value will be added to this field, overflowing into larger fields if necessary. 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.
Partial instants only contain some fields. This may result in a maximum possible value, such as TimeOfDay being limited to 23:59:59:999. If this limit is breached by the add an exception is thrown.
For example, in the ISO chronology:
2000-08-20 add six months is 2000-02-20
2000-08-20 add twenty months is 2000-04-20
2000-08-20 add minus nine months is 2000-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 DateTimeField
instant
- the partial instantfieldIndex
- the index of this field in the partialvalues
- the values of the partial instant which should be updatedvalueToAdd
- the value to add, in the units of the fieldIllegalArgumentException
- if the value is invalid or the maximum instant is reachedpublic int[] addWrapPartial(ReadablePartial instant, int fieldIndex, int[] values, int valueToAdd)
The value will be added to this field, overflowing into larger fields if necessary. 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.
Partial instants only contain some fields. This may result in a maximum possible value, such as TimeOfDay normally being limited to 23:59:59:999. If ths limit is reached by the addition, this method will wrap back to 00:00:00.000. In fact, you would generally only use this method for classes that have a limitation such as this.
For example, in the ISO chronology:
10:20:30 add 20 minutes is 10:40:30
10:20:30 add 45 minutes is 11:05:30
10:20:30 add 16 hours is 02:20:30
addWrapPartial
in class DateTimeField
instant
- the partial instantfieldIndex
- the index of this field in the partialvalues
- the values of the partial instant which should be updatedvalueToAdd
- the value to add, in the units of the fieldIllegalArgumentException
- if the value is invalid or the maximum instant is reachedpublic long addWrapField(long instant, int value)
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 DateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to add tovalue
- the value to add, in the units of the fieldpublic int[] addWrapField(ReadablePartial instant, int fieldIndex, int[] values, int valueToAdd)
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 DateTimeField
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 fieldIllegalArgumentException
- if the value is invalidpublic int getDifference(long minuendInstant, long subtrahendInstant)
long instant = ... int v = ... int age = getDifference(add(instant, v), instant);The value 'age' is the same as the value 'v'.
getDifference
in class DateTimeField
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)
long instant = ... long v = ... long age = getDifferenceAsLong(add(instant, v), instant);The value 'age' is the same as the value 'v'.
getDifferenceAsLong
in class DateTimeField
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 abstract long set(long instant, int value)
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 DateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to set invalue
- the value to set, in the units of the fieldIllegalArgumentException
- if the value is invalidpublic int[] set(ReadablePartial partial, int fieldIndex, int[] values, int newValue)
The value of this field (specified by the index) 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 DateTimeField
partial
- the partial instantfieldIndex
- the index of this field in the instantvalues
- the values to updatenewValue
- the value to set, in the units of the fieldIllegalArgumentException
- if the value is invalidpublic long set(long instant, String text, Locale locale)
This implementation uses convertText(String, Locale)
and
set(long, int)
.
Note: subclasses that override this method should also override getAsText.
set
in class DateTimeField
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 defaultIllegalArgumentException
- if the text value is invalidpublic final long set(long instant, String text)
This implementation uses set(long, String, Locale)
.
Note: subclasses that override this method should also override getAsText.
set
in class DateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to set intext
- the text value to setIllegalArgumentException
- if the text value is invalidpublic int[] set(ReadablePartial instant, int fieldIndex, int[] values, String text, Locale locale)
This implementation uses convertText(String, Locale)
and
set(ReadablePartial, int, int[], int)
.
set
in class DateTimeField
instant
- the partial instantfieldIndex
- the index of this field in the instantvalues
- the values of the partial instant which should be updatedtext
- the text value to setlocale
- the locale to use for selecting a text symbol, null for defaultIllegalArgumentException
- if the text value is invalidprotected int convertText(String text, Locale locale)
text
- the text to convertlocale
- the locale to convert usingIllegalArgumentException
- if the text is invalidpublic abstract DurationField getDurationField()
getDurationField
in class DateTimeField
public abstract DurationField getRangeDurationField()
getRangeDurationField
in class DateTimeField
public boolean isLeap(long instant)
For example, a leap year would return true, a non leap year would return false.
This implementation returns false.
isLeap
in class DateTimeField
instant
- the instant to check for leap statuspublic int getLeapAmount(long instant)
For example, a leap year would return one, a non leap year would return zero.
This implementation returns zero.
getLeapAmount
in class DateTimeField
instant
- the instant to check for leap statuspublic DurationField getLeapDurationField()
This implementation returns null.
getLeapDurationField
in class DateTimeField
public abstract int getMinimumValue()
getMinimumValue
in class DateTimeField
public int getMinimumValue(long instant)
This implementation returns the same as getMinimumValue()
.
getMinimumValue
in class DateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to querypublic int getMinimumValue(ReadablePartial instant)
This implementation returns the same as getMinimumValue()
.
getMinimumValue
in class DateTimeField
instant
- the partial instant to querypublic int getMinimumValue(ReadablePartial instant, int[] values)
This implementation returns the same as getMinimumValue(ReadablePartial)
.
getMinimumValue
in class DateTimeField
instant
- the partial instant to queryvalues
- the values to usepublic abstract int getMaximumValue()
getMaximumValue
in class DateTimeField
public int getMaximumValue(long instant)
This implementation returns the same as getMaximumValue()
.
getMaximumValue
in class DateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to querypublic int getMaximumValue(ReadablePartial instant)
This implementation returns the same as getMaximumValue()
.
getMaximumValue
in class DateTimeField
instant
- the partial instant to querypublic int getMaximumValue(ReadablePartial instant, int[] values)
This implementation returns the same as getMaximumValue(ReadablePartial)
.
getMaximumValue
in class DateTimeField
instant
- the partial instant to queryvalues
- the values to usepublic int getMaximumTextLength(Locale locale)
getMaximumTextLength
in class DateTimeField
locale
- the locale to use for selecting a text symbolpublic int getMaximumShortTextLength(Locale locale)
getMaximumShortTextLength
in class DateTimeField
locale
- the locale to use for selecting a text symbolpublic abstract long roundFloor(long instant)
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 DateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to roundpublic long roundCeiling(long instant)
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 DateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to roundpublic long roundHalfFloor(long instant)
roundHalfFloor
in class DateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to roundpublic long roundHalfCeiling(long instant)
roundHalfCeiling
in class DateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to roundpublic long roundHalfEven(long instant)
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 DateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to roundpublic long remainder(long instant)
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 DateTimeField
instant
- the milliseconds from 1970-01-01T00:00:00Z to get the
remainderpublic String toString()
toString
in class DateTimeField
Copyright © 2012 JBoss by Red Hat. All Rights Reserved.