Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.joda.time.DateTimeField
org.joda.time.field.BaseDateTimeField
public abstract class BaseDateTimeField
extends DateTimeField
DecoratedDateTimeField
Constructor Summary | |
|
Method Summary | |
long |
|
long |
|
int[] |
|
long |
|
int[] |
|
int[] |
|
protected int |
|
abstract int |
|
String |
|
String |
|
String |
|
String |
|
String |
|
String |
|
String |
|
String |
|
String |
|
String |
|
int |
|
long |
|
abstract DurationField |
|
int |
|
DurationField |
|
int |
|
int |
|
abstract int |
|
int |
|
int |
|
int |
|
abstract int |
|
int |
|
int |
|
int |
|
String |
|
abstract DurationField |
|
DateTimeFieldType |
|
boolean |
|
boolean | |
long |
|
long |
|
abstract long |
|
long |
|
long |
|
long |
|
long |
|
long |
|
abstract long |
|
int[] |
|
int[] |
|
String |
|
public long add(long instant, int value)
Adds a value (which may be negative) to the instant value, overflowing into larger fields if necessary. 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
- Overrides:
- add in interface DateTimeField
- Parameters:
instant
- the milliseconds from 1970-01-01T00:00:00Z to add tovalue
- the value to add, in the units of the field
- Returns:
- the updated milliseconds
public long add(long instant, long value)
Adds a value (which may be negative) to the instant value, overflowing into larger fields if necessary.
- Overrides:
- add in interface DateTimeField
- Parameters:
instant
- the milliseconds from 1970-01-01T00:00:00Z to add tovalue
- the long value to add, in the units of the field
- Returns:
- the updated milliseconds
- See Also:
add(long,int)
public 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. 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
- Overrides:
- add in interface DateTimeField
- Parameters:
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
- Returns:
- the passed in values
public long addWrapField(long instant, int value)
Adds a value (which may be negative) to the instant value, wrapping within this field. 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.
- Overrides:
- addWrapField in interface DateTimeField
- Parameters:
instant
- the milliseconds from 1970-01-01T00:00:00Z to add tovalue
- the value to add, in the units of the field
- Returns:
- the updated milliseconds
public 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. 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.
- Overrides:
- addWrapField in interface DateTimeField
- Parameters:
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
- Returns:
- the passed in values
public 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. 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
- Overrides:
- addWrapPartial in interface DateTimeField
- Parameters:
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
- Returns:
- the passed in values
protected int convertText(String text, Locale locale)
Convert the specified text and locale into a value.
- Parameters:
text
- the text to convertlocale
- the locale to convert using
- Returns:
- the value extracted from the text
public abstract int get(long instant)
Get the value of this field from the milliseconds.
- Overrides:
- get in interface DateTimeField
- Parameters:
instant
- the milliseconds from 1970-01-01T00:00:00Z to query
- Returns:
- the value of the field, in the units of the field
public String getAsShortText(int fieldValue, Locale locale)
Get the human-readable, short text value of this field from the field value. If the specified locale is null, the default locale is used. The default implementation returns getAsText(fieldValue, locale). Note: subclasses that override this method should also override getMaximumShortTextLength.
- Overrides:
- getAsShortText in interface DateTimeField
- Parameters:
fieldValue
- the numeric value to convert to textlocale
- the locale to use for selecting a text symbol, null for default
- Returns:
- the text value of the field
public final String getAsShortText(long instant)
Get the human-readable, short text value of this field from the milliseconds. The default implementation callsgetAsShortText(long,Locale)
.
- Overrides:
- getAsShortText in interface DateTimeField
- Parameters:
instant
- the milliseconds from 1970-01-01T00:00:00Z to query
- Returns:
- the text value of the field
public String getAsShortText(long instant, Locale locale)
Get the human-readable, short text value of this field from the milliseconds. If the specified locale is null, the default locale is used. The default implementation returns getAsShortText(get(instant), locale).
- Overrides:
- getAsShortText in interface DateTimeField
- Parameters:
instant
- the milliseconds from 1970-01-01T00:00:00Z to querylocale
- the locale to use for selecting a text symbol, null means default
- Returns:
- the text value of the field
public final String getAsShortText(ReadablePartial partial, Locale locale)
Get the human-readable, short text value of this field from a partial instant. If the specified locale is null, the default locale is used. The default implementation callsReadablePartial.get(DateTimeFieldType)
andgetAsText(ReadablePartial,int,Locale)
.
- Overrides:
- getAsShortText in interface DateTimeField
- Parameters:
partial
- the partial instant to querylocale
- the locale to use for selecting a text symbol, null for default
- Returns:
- the text value of the field
public String getAsShortText(ReadablePartial partial, int fieldValue, Locale locale)
Get the human-readable, short text value of this field from a partial instant. If the specified locale is null, the default locale is used. The default implementation returns getAsShortText(fieldValue, locale).
- Overrides:
- getAsShortText in interface DateTimeField
- Parameters:
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
- Returns:
- the text value of the field
public String getAsText(int fieldValue, Locale locale)
Get the human-readable, text value of this field from the field value. If the specified locale is null, the default locale is used. The default implementation returns Integer.toString(get(instant)). Note: subclasses that override this method should also override getMaximumTextLength.
- Overrides:
- getAsText in interface DateTimeField
- Parameters:
fieldValue
- the numeric value to convert to textlocale
- the locale to use for selecting a text symbol, null for default
- Returns:
- the text value of the field
public final String getAsText(long instant)
Get the human-readable, text value of this field from the milliseconds. The default implementation callsgetAsText(long,Locale)
.
- Overrides:
- getAsText in interface DateTimeField
- Parameters:
instant
- the milliseconds from 1970-01-01T00:00:00Z to query
- Returns:
- the text value of the field
public String getAsText(long instant, Locale locale)
Get the human-readable, text value of this field from the milliseconds. If the specified locale is null, the default locale is used. The default implementation returns getAsText(get(instant), locale).
- Overrides:
- getAsText in interface DateTimeField
- Parameters:
instant
- the milliseconds from 1970-01-01T00:00:00Z to querylocale
- the locale to use for selecting a text symbol, null means default
- Returns:
- the text value of the field
public final String getAsText(ReadablePartial partial, Locale locale)
Get the human-readable, text value of this field from a partial instant. If the specified locale is null, the default locale is used. The default implementation callsReadablePartial.get(DateTimeFieldType)
andgetAsText(ReadablePartial,int,Locale)
.
- Overrides:
- getAsText in interface DateTimeField
- Parameters:
partial
- the partial instant to querylocale
- the locale to use for selecting a text symbol, null for default
- Returns:
- the text value of the field
public String getAsText(ReadablePartial partial, int fieldValue, Locale locale)
Get the human-readable, text value of this field from a partial instant. If the specified locale is null, the default locale is used. The default implementation returns getAsText(fieldValue, locale).
- Overrides:
- getAsText in interface DateTimeField
- Parameters:
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
- Returns:
- the text value of the field
public int getDifference(long minuendInstant, long subtrahendInstant)
Computes the difference between two instants, as measured in the units of this field. Any fractional units are dropped from the result. Calling getDifference reverses the effect of calling add. In the following code:long instant = ... int v = ... int age = getDifference(add(instant, v), instant);The value 'age' is the same as the value 'v'.
- Overrides:
- getDifference in interface DateTimeField
- Parameters:
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
- Returns:
- the difference in the units of this field
public long getDifferenceAsLong(long minuendInstant, long subtrahendInstant)
Computes the difference between two instants, as measured in the units of this field. Any fractional units are dropped from the result. Calling getDifference reverses the effect of calling add. In the following code:long instant = ... long v = ... long age = getDifferenceAsLong(add(instant, v), instant);The value 'age' is the same as the value 'v'.
- Overrides:
- getDifferenceAsLong in interface DateTimeField
- Parameters:
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
- Returns:
- the difference in the units of this field
public abstract DurationField getDurationField()
Returns the duration per unit value of this field. For example, if this field represents "hour of day", then the unit duration is an hour.
- Overrides:
- getDurationField in interface DateTimeField
- Returns:
- the duration of this field, or UnsupportedDurationField if field has no duration
public int getLeapAmount(long instant)
Gets the amount by which this field is 'leap' for the specified instant. For example, a leap year would return one, a non leap year would return zero. This implementation returns zero.
- Overrides:
- getLeapAmount in interface DateTimeField
public DurationField getLeapDurationField()
If this field were to leap, then it would be in units described by the returned duration. If this field doesn't ever leap, null is returned. This implementation returns null.
- Overrides:
- getLeapDurationField in interface DateTimeField
public int getMaximumShortTextLength(Locale locale)
Get the maximum short text value for this field. The default implementation returns getMaximumTextLength().
- Overrides:
- getMaximumShortTextLength in interface DateTimeField
- Parameters:
locale
- the locale to use for selecting a text symbol
- Returns:
- the maximum short text length
public int getMaximumTextLength(Locale locale)
Get the maximum text value for this field. The default implementation returns the equivalent of Integer.toString(getMaximumValue()).length().
- Overrides:
- getMaximumTextLength in interface DateTimeField
- Parameters:
locale
- the locale to use for selecting a text symbol
- Returns:
- the maximum text length
public abstract int getMaximumValue()
Get the maximum allowable value for this field.
- Overrides:
- getMaximumValue in interface DateTimeField
- Returns:
- the maximum valid value for this field, in the units of the field
public int getMaximumValue(long instant)
Get the maximum value for this field evaluated at the specified time. This implementation returns the same asgetMaximumValue()
.
- Overrides:
- getMaximumValue in interface DateTimeField
- Parameters:
instant
- the milliseconds from 1970-01-01T00:00:00Z to query
- Returns:
- the maximum value for this field, in the units of the field
public int getMaximumValue(ReadablePartial instant)
Get the maximum value for this field evaluated at the specified instant. This implementation returns the same asgetMaximumValue()
.
- Overrides:
- getMaximumValue in interface DateTimeField
- Parameters:
instant
- the partial instant to query
- Returns:
- the maximum value for this field, in the units of the field
public int getMaximumValue(ReadablePartial instant, int[] values)
Get the maximum value for this field using the partial instant and the specified values. This implementation returns the same asgetMaximumValue(ReadablePartial)
.
- Overrides:
- getMaximumValue in interface DateTimeField
- Parameters:
instant
- the partial instant to queryvalues
- the values to use
- Returns:
- the maximum value for this field, in the units of the field
public abstract int getMinimumValue()
Get the minimum allowable value for this field.
- Overrides:
- getMinimumValue in interface DateTimeField
- Returns:
- the minimum valid value for this field, in the units of the field
public int getMinimumValue(long instant)
Get the minimum value for this field evaluated at the specified time. This implementation returns the same asgetMinimumValue()
.
- Overrides:
- getMinimumValue in interface DateTimeField
- Parameters:
instant
- the milliseconds from 1970-01-01T00:00:00Z to query
- Returns:
- the minimum value for this field, in the units of the field
public int getMinimumValue(ReadablePartial instant)
Get the minimum value for this field evaluated at the specified instant. This implementation returns the same asgetMinimumValue()
.
- Overrides:
- getMinimumValue in interface DateTimeField
- Parameters:
instant
- the partial instant to query
- Returns:
- the minimum value for this field, in the units of the field
public int getMinimumValue(ReadablePartial instant, int[] values)
Get the minimum value for this field using the partial instant and the specified values. This implementation returns the same asgetMinimumValue(ReadablePartial)
.
- Overrides:
- getMinimumValue in interface DateTimeField
- Parameters:
instant
- the partial instant to queryvalues
- the values to use
- Returns:
- the minimum value for this field, in the units of the field
public abstract DurationField getRangeDurationField()
Returns the range duration of this field. For example, if this field represents "hour of day", then the range duration is a day.
- Overrides:
- getRangeDurationField in interface DateTimeField
- Returns:
- the range duration of this field, or null if field has no range
public boolean isLeap(long instant)
Returns whether this field is 'leap' for the specified instant. For example, a leap year would return true, a non leap year would return false. This implementation returns false.
- Overrides:
- isLeap in interface DateTimeField
- Returns:
- true if the field is 'leap'
public final boolean isSupported()
- Overrides:
- isSupported in interface DateTimeField
- Returns:
- true always
public long remainder(long instant)
Returns the fractional duration milliseconds of this field. In other words, calling remainder returns the duration that roundFloor would subtract. 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 computesinstant - roundFloor(instant)
. Subclasses are encouraged to provide a more efficient implementation.
- Overrides:
- remainder in interface DateTimeField
- Parameters:
instant
- the milliseconds from 1970-01-01T00:00:00Z to get the remainder
- Returns:
- remainder duration, in milliseconds
public long roundCeiling(long instant)
Round to the highest whole unit of this field. The value of this field and all fields of a higher magnitude may be incremented in order to achieve this result. The fractional millis that cannot be expressed in whole increments of this field are set to minimum. 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.
- Overrides:
- roundCeiling in interface DateTimeField
- Parameters:
instant
- the milliseconds from 1970-01-01T00:00:00Z to round
- Returns:
- rounded milliseconds
public abstract long roundFloor(long instant)
Round to the lowest whole unit of this field. After rounding, the value of this field and all fields of a higher magnitude are retained. The fractional millis that cannot be expressed in whole increments of this field are set to minimum. For example, a datetime of 2002-11-02T23:34:56.789, rounded to the lowest whole hour is 2002-11-02T23:00:00.000.
- Overrides:
- roundFloor in interface DateTimeField
- Parameters:
instant
- the milliseconds from 1970-01-01T00:00:00Z to round
- Returns:
- rounded milliseconds
public long roundHalfCeiling(long instant)
Round to the nearest whole unit of this field. If the given millisecond value is closer to the floor, this function behaves like roundFloor. If the millisecond value is closer to the ceiling or is exactly halfway, this function behaves like roundCeiling.
- Overrides:
- roundHalfCeiling in interface DateTimeField
- Parameters:
instant
- the milliseconds from 1970-01-01T00:00:00Z to round
- Returns:
- rounded milliseconds
public long roundHalfEven(long instant)
Round to the nearest whole unit of this field. If the given millisecond value is closer to the floor, this function behaves like roundFloor. If the millisecond value is closer to the ceiling, this function behaves like roundCeiling. 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.
- Overrides:
- roundHalfEven in interface DateTimeField
- Parameters:
instant
- the milliseconds from 1970-01-01T00:00:00Z to round
- Returns:
- rounded milliseconds
public long roundHalfFloor(long instant)
Round to the nearest whole unit of this field. If the given millisecond value is closer to the floor or is exactly halfway, this function behaves like roundFloor. If the millisecond value is closer to the ceiling, this function behaves like roundCeiling.
- Overrides:
- roundHalfFloor in interface DateTimeField
- Parameters:
instant
- the milliseconds from 1970-01-01T00:00:00Z to round
- Returns:
- rounded milliseconds
public final long set(long instant, String text)
Sets a value in the milliseconds supplied from a human-readable, text value. This implementation usesset(long,String,Locale)
. Note: subclasses that override this method should also override getAsText.
- Overrides:
- set in interface DateTimeField
- Parameters:
instant
- the milliseconds from 1970-01-01T00:00:00Z to set intext
- the text value to set
- Returns:
- the updated milliseconds
public long set(long instant, String text, Locale locale)
Sets a value in the milliseconds supplied from a human-readable, text value. If the specified locale is null, the default locale is used. This implementation usesconvertText(String, Locale)
andset(long,int)
. Note: subclasses that override this method should also override getAsText.
- Overrides:
- set in interface DateTimeField
- Parameters:
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
- Returns:
- the updated milliseconds
public abstract long set(long instant, int value)
Sets a value in the milliseconds supplied. 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.
- Overrides:
- set in interface DateTimeField
- Parameters:
instant
- the milliseconds from 1970-01-01T00:00:00Z to set invalue
- the value to set, in the units of the field
- Returns:
- the updated milliseconds
public 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. If the specified locale is null, the default locale is used. This implementation usesconvertText(String, Locale)
andset(ReadablePartial,int,int[],int)
.
- Overrides:
- set in interface DateTimeField
- Parameters:
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
- Returns:
- the passed in values
public int[] set(ReadablePartial partial, int fieldIndex, int[] values, int newValue)
Sets a value using the specified partial instant. 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.
- Overrides:
- set in interface DateTimeField
- Parameters:
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 field
- Returns:
- the updated values
public String toString()
Get a suitable debug string.
- Overrides:
- toString in interface DateTimeField
- Returns:
- debug string