org.joda.time.field

Class BaseDateTimeField

Known Direct Subclasses:
DecoratedDateTimeField, ImpreciseDateTimeField, PreciseDurationDateTimeField

public abstract class BaseDateTimeField
extends DateTimeField

BaseDateTimeField provides the common behaviour for DateTimeField implementations.

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.

Author:
Brian S O'Neill
Since:
1.0
See Also:
DecoratedDateTimeField

Constructor Summary

BaseDateTimeField(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.
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, Locale locale)
Get the human-readable, short text value of this field from a partial instant.
String
getAsShortText(ReadablePartial partial, int fieldValue, 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, Locale locale)
Get the human-readable, text value of this field from a partial instant.
String
getAsText(ReadablePartial partial, int fieldValue, 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()
abstract DurationField
getRangeDurationField()
Returns the range duration of this field.
DateTimeFieldType
getType()
boolean
isLeap(long instant)
Returns whether this field is 'leap' for the specified instant.
boolean
isSupported()
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.
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.
abstract long
set(long instant, int value)
Sets a value in the milliseconds supplied.
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.
int[]
set(ReadablePartial partial, int fieldIndex, int[] values, int newValue)
Sets a value using the specified partial instant.
String
toString()
Get a suitable debug string.

Methods inherited from class org.joda.time.DateTimeField

add, add, add, addWrapField, addWrapField, addWrapPartial, get, getAsShortText, getAsShortText, getAsShortText, getAsShortText, getAsShortText, getAsText, getAsText, getAsText, getAsText, getAsText, getDifference, getDifferenceAsLong, getDurationField, getLeapAmount, getLeapDurationField, getMaximumShortTextLength, getMaximumTextLength, getMaximumValue, getMaximumValue, getMaximumValue, getMaximumValue, getMinimumValue, getMinimumValue, getMinimumValue, getMinimumValue, getName, getRangeDurationField, getType, isLeap, isLenient, isSupported, remainder, roundCeiling, roundFloor, roundHalfCeiling, roundHalfEven, roundHalfFloor, set, set, set, set, set, toString

Constructor Details

BaseDateTimeField

protected BaseDateTimeField(DateTimeFieldType type)
Constructor.

Method Details

add

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 to
value - the value to add, in the units of the field
Returns:
the updated milliseconds

add

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 to
value - the long value to add, in the units of the field
Returns:
the updated milliseconds
See Also:
add(long,int)

add

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 instant
fieldIndex - the index of this field in the partial
values - the values of the partial instant which should be updated
valueToAdd - the value to add, in the units of the field
Returns:
the passed in values

addWrapField

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 to
value - the value to add, in the units of the field
Returns:
the updated milliseconds

addWrapField

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 instant
fieldIndex - the index of this field in the instant
values - the values of the partial instant which should be updated
valueToAdd - the value to add, in the units of the field
Returns:
the passed in values

addWrapPartial

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 instant
fieldIndex - the index of this field in the partial
values - the values of the partial instant which should be updated
valueToAdd - the value to add, in the units of the field
Returns:
the passed in values

convertText

protected int convertText(String text,
                          Locale locale)
Convert the specified text and locale into a value.
Parameters:
text - the text to convert
locale - the locale to convert using
Returns:
the value extracted from the text

get

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

getAsShortText

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 text
locale - the locale to use for selecting a text symbol, null for default
Returns:
the text value of the field

getAsShortText

public final String getAsShortText(long instant)
Overrides:
getAsShortText in interface DateTimeField
Parameters:
instant - the milliseconds from 1970-01-01T00:00:00Z to query
Returns:
the text value of the field

getAsShortText

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 query
locale - the locale to use for selecting a text symbol, null means default
Returns:
the text value of the field

getAsShortText

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 calls ReadablePartial.get(DateTimeFieldType) and getAsText(ReadablePartial,int,Locale).

Overrides:
getAsShortText in interface DateTimeField
Parameters:
partial - the partial instant to query
locale - the locale to use for selecting a text symbol, null for default
Returns:
the text value of the field

getAsShortText

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 query
fieldValue - the field value of this field, provided for performance
locale - the locale to use for selecting a text symbol, null for default
Returns:
the text value of the field

getAsText

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 text
locale - the locale to use for selecting a text symbol, null for default
Returns:
the text value of the field

getAsText

public final String getAsText(long instant)
Overrides:
getAsText in interface DateTimeField
Parameters:
instant - the milliseconds from 1970-01-01T00:00:00Z to query
Returns:
the text value of the field

getAsText

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 query
locale - the locale to use for selecting a text symbol, null means default
Returns:
the text value of the field

getAsText

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 calls ReadablePartial.get(DateTimeFieldType) and getAsText(ReadablePartial,int,Locale).

Overrides:
getAsText in interface DateTimeField
Parameters:
partial - the partial instant to query
locale - the locale to use for selecting a text symbol, null for default
Returns:
the text value of the field

getAsText

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 query
fieldValue - the field value of this field, provided for performance
locale - the locale to use for selecting a text symbol, null for default
Returns:
the text value of the field

getDifference

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 from
subtrahendInstant - the milliseconds from 1970-01-01T00:00:00Z to subtract off the minuend
Returns:
the difference in the units of this field

getDifferenceAsLong

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 from
subtrahendInstant - the milliseconds from 1970-01-01T00:00:00Z to subtract off the minuend
Returns:
the difference in the units of this field

getDurationField

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

getLeapAmount

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

getLeapDurationField

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

getMaximumShortTextLength

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

getMaximumTextLength

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

getMaximumValue

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

getMaximumValue

public int getMaximumValue(long instant)
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

getMaximumValue

public int getMaximumValue(ReadablePartial instant)
Get the maximum value for this field evaluated at the specified instant.

This implementation returns the same as getMaximumValue().

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

getMaximumValue

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 as getMaximumValue(ReadablePartial).

Overrides:
getMaximumValue in interface DateTimeField
Parameters:
instant - the partial instant to query
values - the values to use
Returns:
the maximum value for this field, in the units of the field

getMinimumValue

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

getMinimumValue

public int getMinimumValue(long instant)
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

getMinimumValue

public int getMinimumValue(ReadablePartial instant)
Get the minimum value for this field evaluated at the specified instant.

This implementation returns the same as getMinimumValue().

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

getMinimumValue

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 as getMinimumValue(ReadablePartial).

Overrides:
getMinimumValue in interface DateTimeField
Parameters:
instant - the partial instant to query
values - the values to use
Returns:
the minimum value for this field, in the units of the field

getName

public final String getName()
Overrides:
getName in interface DateTimeField

getRangeDurationField

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

getType

public final DateTimeFieldType getType()
Overrides:
getType in interface DateTimeField

isLeap

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'

isSupported

public final boolean isSupported()
Overrides:
isSupported in interface DateTimeField
Returns:
true always

remainder

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 computes instant - 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

roundCeiling

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

roundFloor

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

roundHalfCeiling

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

roundHalfEven

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

roundHalfFloor

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

set

public final long set(long instant,
                      String text)
Overrides:
set in interface DateTimeField
Parameters:
instant - the milliseconds from 1970-01-01T00:00:00Z to set in
text - the text value to set
Returns:
the updated milliseconds

set

public long set(long instant,
                String text,
                Locale locale)
Overrides:
set in interface DateTimeField
Parameters:
instant - the milliseconds from 1970-01-01T00:00:00Z to set in
text - the text value to set
locale - the locale to use for selecting a text symbol, null for default
Returns:
the updated milliseconds

set

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 in
value - the value to set, in the units of the field
Returns:
the updated milliseconds

set

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 uses convertText(String, Locale) and set(ReadablePartial,int,int[],int).

Overrides:
set in interface DateTimeField
Parameters:
instant - the partial instant
fieldIndex - the index of this field in the instant
values - the values of the partial instant which should be updated
text - the text value to set
locale - the locale to use for selecting a text symbol, null for default
Returns:
the passed in values

set

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 instant
fieldIndex - the index of this field in the instant
values - the values to update
newValue - the value to set, in the units of the field
Returns:
the updated values

toString

public String toString()
Get a suitable debug string.
Overrides:
toString in interface DateTimeField
Returns:
debug string

Copyright (c) 2001-2006 - Joda.org