|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.joda.time.DateTimeField
public abstract class DateTimeField
Defines the calculation engine for date and time fields. The interface defines a set of methods that manipulate a millisecond datetime with regards to a single field, such as monthOfYear or secondOfMinute.
This design is extensible so, if you wish, you can extract a different field from the milliseconds. A number of standard implementations are provided to assist.
Constructor Summary | |
---|---|
DateTimeField()
|
Method Summary | |
---|---|
abstract long |
add(long instant,
int value)
Adds a value (which may be negative) to the millis value, overflowing into larger fields if necessary. |
abstract long |
add(long instant,
long value)
Adds a value (which may be negative) to the millis value, overflowing into larger fields if necessary. |
abstract 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. |
abstract long |
addWrapField(long instant,
int value)
Adds a value (which may be negative) to the millis value, wrapping within this field. |
abstract 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. |
abstract 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. |
abstract int |
get(long instant)
Get the value of this field from the milliseconds. |
abstract String |
getAsShortText(int fieldValue,
Locale locale)
Get the human-readable, short text value of this field from the field value. |
abstract String |
getAsShortText(long instant)
Get the human-readable, short text value of this field from the milliseconds. |
abstract String |
getAsShortText(long instant,
Locale locale)
Get the human-readable, short text value of this field from the milliseconds. |
abstract String |
getAsShortText(ReadablePartial partial,
int fieldValue,
Locale locale)
Get the human-readable, short text value of this field from a partial instant. |
abstract String |
getAsShortText(ReadablePartial partial,
Locale locale)
Get the human-readable, short text value of this field from a partial instant. |
abstract String |
getAsText(int fieldValue,
Locale locale)
Get the human-readable, text value of this field from the field value. |
abstract String |
getAsText(long instant)
Get the human-readable, text value of this field from the milliseconds. |
abstract String |
getAsText(long instant,
Locale locale)
Get the human-readable, text value of this field from the milliseconds. |
abstract String |
getAsText(ReadablePartial partial,
int fieldValue,
Locale locale)
Get the human-readable, text value of this field from a partial instant. |
abstract String |
getAsText(ReadablePartial partial,
Locale locale)
Get the human-readable, text value of this field from a partial instant. |
abstract int |
getDifference(long minuendInstant,
long subtrahendInstant)
Computes the difference between two instants, as measured in the units of this field. |
abstract 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. |
abstract int |
getLeapAmount(long instant)
Gets the amount by which this field is 'leap' for the specified instant. |
abstract DurationField |
getLeapDurationField()
If this field were to leap, then it would be in units described by the returned duration. |
abstract int |
getMaximumShortTextLength(Locale locale)
Get the maximum short text value for this field. |
abstract int |
getMaximumTextLength(Locale locale)
Get the maximum text value for this field. |
abstract int |
getMaximumValue()
Get the maximum allowable value for this field. |
abstract int |
getMaximumValue(long instant)
Get the maximum value for this field evaluated at the specified time. |
abstract int |
getMaximumValue(ReadablePartial instant)
Get the maximum value for this field evaluated at the specified time. |
abstract 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. |
abstract int |
getMinimumValue(long instant)
Get the minimum value for this field evaluated at the specified time. |
abstract int |
getMinimumValue(ReadablePartial instant)
Get the minimum value for this field evaluated at the specified time. |
abstract int |
getMinimumValue(ReadablePartial instant,
int[] values)
Get the minimum value for this field using the partial instant and the specified values. |
abstract String |
getName()
Get the name of the field. |
abstract DurationField |
getRangeDurationField()
Returns the range duration of this field. |
abstract DateTimeFieldType |
getType()
Get the type of the field. |
abstract boolean |
isLeap(long instant)
Returns whether this field is 'leap' for the specified instant. |
abstract boolean |
isLenient()
Returns true if the set method is lenient. |
abstract boolean |
isSupported()
Returns true if this field is supported. |
abstract long |
remainder(long instant)
Returns the fractional duration milliseconds of this field. |
abstract 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. |
abstract long |
roundHalfCeiling(long instant)
Round to the nearest whole unit of this field. |
abstract long |
roundHalfEven(long instant)
Round to the nearest whole unit of this field. |
abstract 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. |
abstract long |
set(long instant,
String text)
Sets a value in the milliseconds supplied from a human-readable, text value. |
abstract long |
set(long instant,
String text,
Locale locale)
Sets a value in the milliseconds supplied from a human-readable, text value. |
abstract int[] |
set(ReadablePartial instant,
int fieldIndex,
int[] values,
int newValue)
Sets a value using the specified partial instant. |
abstract 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. |
abstract String |
toString()
Get a suitable debug string. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DateTimeField()
Method Detail |
---|
public abstract DateTimeFieldType getType()
public abstract String getName()
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.
public abstract boolean isSupported()
public abstract boolean isLenient()
public abstract int get(long instant)
instant
- the milliseconds from 1970-01-01T00:00:00Z to query
public abstract String getAsText(long instant, Locale locale)
instant
- the milliseconds from 1970-01-01T00:00:00Z to querylocale
- the locale to use for selecting a text symbol, null for default
public abstract String getAsText(long instant)
instant
- the milliseconds from 1970-01-01T00:00:00Z to query
public abstract String getAsText(ReadablePartial partial, int fieldValue, Locale locale)
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 default
public abstract String getAsText(ReadablePartial partial, Locale locale)
partial
- the partial instant to querylocale
- the locale to use for selecting a text symbol, null for default
public abstract String getAsText(int fieldValue, Locale locale)
fieldValue
- the numeric value to convert to textlocale
- the locale to use for selecting a text symbol, null for default
public abstract String getAsShortText(long instant, Locale locale)
instant
- the milliseconds from 1970-01-01T00:00:00Z to querylocale
- the locale to use for selecting a text symbol, null for default
public abstract String getAsShortText(long instant)
instant
- the milliseconds from 1970-01-01T00:00:00Z to query
public abstract String getAsShortText(ReadablePartial partial, int fieldValue, Locale locale)
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 default
public abstract String getAsShortText(ReadablePartial partial, Locale locale)
partial
- the partial instant to querylocale
- the locale to use for selecting a text symbol, null for default
public abstract String getAsShortText(int fieldValue, Locale locale)
fieldValue
- the numeric value to convert to textlocale
- the locale to use for selecting a text symbol, null for default
public abstract 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
instant
- the milliseconds from 1970-01-01T00:00:00Z to add tovalue
- the value to add, in the units of the field
public abstract long add(long instant, long value)
instant
- the milliseconds from 1970-01-01T00:00:00Z to add tovalue
- the long value to add, in the units of the field
IllegalArgumentException
- if value is too largeadd(long,int)
public abstract 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
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
IllegalArgumentException
- if the value is invalid or the maximum instant is reachedpublic abstract 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
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 field
IllegalArgumentException
- if the value is invalid or the maximum instant is reachedpublic abstract 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
instant
- the milliseconds from 1970-01-01T00:00:00Z to add tovalue
- the value to add, in the units of the field
public abstract 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
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
IllegalArgumentException
- if the value is invalidpublic abstract 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'.
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 abstract 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'.
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 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.
instant
- the milliseconds from 1970-01-01T00:00:00Z to set invalue
- the value to set, in the units of the field
IllegalArgumentException
- if the value is invalidpublic abstract int[] set(ReadablePartial instant, 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.
instant
- the partial instantfieldIndex
- the index of this field in the instantvalues
- the values of the partial instant which should be updatednewValue
- the value to set, in the units of the field
IllegalArgumentException
- if the value is invalidpublic abstract long set(long instant, String text, Locale locale)
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.
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 default
IllegalArgumentException
- if the text value is invalidpublic abstract long set(long instant, String text)
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.
instant
- the milliseconds from 1970-01-01T00:00:00Z to set intext
- the text value to set
IllegalArgumentException
- if the text value is invalidpublic abstract int[] set(ReadablePartial instant, int fieldIndex, int[] values, String text, Locale locale)
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.
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 default
IllegalArgumentException
- if the text value is invalidpublic abstract DurationField getDurationField()
public abstract DurationField getRangeDurationField()
public abstract boolean isLeap(long instant)
For example, a leap year would return true, a non leap year would return false.
instant
- the instant to check for leap status
public abstract int getLeapAmount(long instant)
For example, a leap year would return one, a non leap year would return zero.
instant
- the instant to check for leap status
public abstract DurationField getLeapDurationField()
public abstract int getMinimumValue()
public abstract int getMinimumValue(long instant)
instant
- the milliseconds from 1970-01-01T00:00:00Z to query
public abstract int getMinimumValue(ReadablePartial instant)
instant
- the partial instant to query
public abstract int getMinimumValue(ReadablePartial instant, int[] values)
instant
- the partial instant to queryvalues
- the values to use
public abstract int getMaximumValue()
public abstract int getMaximumValue(long instant)
instant
- the milliseconds from 1970-01-01T00:00:00Z to query
public abstract int getMaximumValue(ReadablePartial instant)
instant
- the partial instant to query
public abstract int getMaximumValue(ReadablePartial instant, int[] values)
instant
- the partial instant to queryvalues
- the values to use
public abstract int getMaximumTextLength(Locale locale)
locale
- the locale to use for selecting a text symbol
public abstract int getMaximumShortTextLength(Locale locale)
locale
- the locale to use for selecting a text symbol
public 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.
instant
- the milliseconds from 1970-01-01T00:00:00Z to round
public abstract 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.
instant
- the milliseconds from 1970-01-01T00:00:00Z to round
public abstract long roundHalfFloor(long instant)
instant
- the milliseconds from 1970-01-01T00:00:00Z to round
public abstract long roundHalfCeiling(long instant)
instant
- the milliseconds from 1970-01-01T00:00:00Z to round
public abstract 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.
instant
- the milliseconds from 1970-01-01T00:00:00Z to round
public abstract 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.
instant
- the milliseconds from 1970-01-01T00:00:00Z to get the
remainder
public abstract String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |