org.joda.time.chrono
Class DelegateDateTimeField

java.lang.Object
  |
  +--org.joda.time.DateTimeField
        |
        +--org.joda.time.chrono.DelegateDateTimeField

All Implemented Interfaces:

java.io.Serializable

public abstract class DelegateDateTimeField

extends DateTimeField

DelegateDateTimeField delegates each method call to the date time field it wraps.

Since:

1.0

Author:

Brian S O'Neill

See Also:

Serialized Form

Constructor Summary

protected	DelegateDateTimeField(DateTimeField field)
protected	DelegateDateTimeField(java.lang.String name, DateTimeField field)

Method Summary

long	add(long millis, int value) Adds a value (which may be negative) to the millis value, overflowing into larger fields if necessary.
long	add(long millis, long value) Adds a value (which may be negative) to the millis value, overflowing into larger fields if necessary.
long	addWrapped(long millis, int value) Adds a value (which may be negative) to the millis value, wrapping within this field.
int	get(long millis) Get the value of this field from the milliseconds.
java.lang.String	getAsShortText(long millis, java.util.Locale locale) Get the human-readable, short text value of this field from the milliseconds.
java.lang.String	getAsText(long millis, java.util.Locale locale) Get the human-readable, text value of this field from the milliseconds.
protected DateTimeField	getDateTimeField() Gets the wrapped date time field.
long	getDifference(long minuendMillis, long subtrahendMillis) Computes the difference between two instants, as measured in the units of this field.
int	getLeapAmount(long millis) Gets the amount by which this field is 'leap' for the specified millis.
int	getMaximumShortTextLength(java.util.Locale locale) Get the maximum short text value for this field.
int	getMaximumTextLength(java.util.Locale locale) Get the maximum text value for this field.
int	getMaximumValue() Get the maximum allowable value for this field.
int	getMaximumValue(long millis) Get the maximum value for this field evaluated at the specified time.
int	getMinimumValue() Get the minimum allowable value for this field.
int	getMinimumValue(long millis) Get the minimum value for this field evaluated at the specified time.
long	getRangeMillis() Returns the range of this field, in milliseconds.
long	getUnitMillis() Returns the amount of milliseconds per unit value of this field.
boolean	isLeap(long millis) Returns whether this field is 'leap' for the specified millis.
long	remainder(long millis) Retains only the fractional units of this field.
long	roundCeiling(long millis) Round to the highest whole unit of this field.
long	roundFloor(long millis) Round to the lowest whole unit of this field.
long	roundHalfCeiling(long millis) Round to the nearest whole unit of this field.
long	roundHalfEven(long millis) Round to the nearest whole unit of this field.
long	roundHalfFloor(long millis) Round to the nearest whole unit of this field.
long	set(long millis, int value) Sets a value in the milliseconds supplied.
long	set(long millis, java.lang.String text, java.util.Locale locale) Sets a value in the milliseconds supplied from a human-readable, text value.
java.lang.String	toString() Get a suitable debug string.

Methods inherited from class org.joda.time.DateTimeField

addLong, getAsShortText, getAsText, getName, getWrappedValue, getWrappedValue, set, verifyValueBounds

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DelegateDateTimeField

protected DelegateDateTimeField(DateTimeField field)

DelegateDateTimeField

protected DelegateDateTimeField(java.lang.String name,
                                DateTimeField field)

Method Detail

getDateTimeField

protected DateTimeField getDateTimeField()

Gets the wrapped date time field.

Returns:

the wrapped DateTimeField

get

public int get(long millis)

Description copied from class: DateTimeField

Get the value of this field from the milliseconds.

Specified by:

get in class DateTimeField

Parameters:

millis - the milliseconds from 1970-01-01T00:00:00Z to query

Returns:

the value of the field, in the units of the field

getAsText

public java.lang.String getAsText(long millis,
                                  java.util.Locale locale)

Description copied from class: DateTimeField

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 Integer.toString(get(millis)).

Note: subclasses that override this method should also override getMaximumTextLength.

Overrides:

getAsText in class DateTimeField

Parameters:

millis - the milliseconds from 1970-01-01T00:00:00Z to query

locale - the locale to use for selecting a text symbol, null for default

Returns:

the text value of the field

getAsShortText

public java.lang.String getAsShortText(long millis,
                                       java.util.Locale locale)

Description copied from class: DateTimeField

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 getAsText(millis, locale).

Note: subclasses that override this method should also override getMaximumShortTextLength.

Overrides:

getAsShortText in class DateTimeField

Parameters:

millis - the milliseconds from 1970-01-01T00:00:00Z to query

locale - the locale to use for selecting a text symbol, null for default

Returns:

the short text value of the field

add

public long add(long millis,
                int value)

Description copied from class: DateTimeField

Adds a value (which may be negative) to the millis 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

Specified by:

add in class DateTimeField

Parameters:

millis - 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 millis,
                long value)

Description copied from class: DateTimeField

Adds a value (which may be negative) to the millis value, overflowing into larger fields if necessary.

Specified by:

add in class DateTimeField

Parameters:

millis - 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:

DateTimeField.add(long,int)

addWrapped

public long addWrapped(long millis,
                       int value)

Description copied from class: DateTimeField

Adds a value (which may be negative) to the millis 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 addWrapped six months is 2000-02-20
2000-08-20 addWrapped twenty months is 2000-04-20
2000-08-20 addWrapped minus nine months is 2000-11-20
2001-01-31 addWrapped one month is 2001-02-28
2001-01-31 addWrapped two months is 2001-03-31

Overrides:

addWrapped in class DateTimeField

Parameters:

millis - 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

getDifference

public long getDifference(long minuendMillis,
                          long subtrahendMillis)

Description copied from class: DateTimeField

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 millis = ...
 int v = ...
 long age = getDifference(add(millis, v), millis);
 

The value 'age' is the same as the value 'v'.

The default implementation performs a guess-and-check algorithm using the getUnitMillis and add methods. Subclasses are encouraged to provide a more efficient implementation.

Overrides:

getDifference in class DateTimeField

Parameters:

minuendMillis - the milliseconds from 1970-01-01T00:00:00Z to subtract from

subtrahendMillis - the milliseconds from 1970-01-01T00:00:00Z to subtract off the minuend

Returns:

the difference in the units of this field

set

public long set(long millis,
                int value)

Description copied from class: DateTimeField

Sets a value in the milliseconds supplied.

The value of this field will be set. If the value is invalid, an exception if thrown. Other fields are always unaffected.

Specified by:

set in class DateTimeField

Parameters:

millis - 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 long set(long millis,
                java.lang.String text,
                java.util.Locale locale)

Description copied from class: DateTimeField

Sets a value in the milliseconds supplied from a human-readable, text value. If the specified locale is null, the default locale is used.

The default implementation returns set(millis, Integer.parseInt(millis)).

Note: subclasses that override this method should also override getAsText.

Overrides:

set in class DateTimeField

Parameters:

millis - 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

isLeap

public boolean isLeap(long millis)

Description copied from class: DateTimeField

Returns whether this field is 'leap' for the specified millis.

For example, a leap year would return true, a non leap year would return false.

This implementation returns false.

Overrides:

isLeap in class DateTimeField

Returns:

true if the field is 'leap'

getLeapAmount

public int getLeapAmount(long millis)

Description copied from class: DateTimeField

Gets the amount by which this field is 'leap' for the specified millis.

For example, a leap year would return one, a non leap year would return zero.

This implementation returns zero.

Overrides:

getLeapAmount in class DateTimeField

getUnitMillis

public long getUnitMillis()

Description copied from class: DateTimeField

Returns the amount of milliseconds per unit value of this field. For example, if this field represents "hour of day", then the unit is the amount of milliseconds per one hour.

For fields with a variable unit size, this method returns a suitable average value.

Specified by:

getUnitMillis in class DateTimeField

Returns:

the unit size of this field, in milliseconds

getRangeMillis

public long getRangeMillis()

Description copied from class: DateTimeField

Returns the range of this field, in milliseconds. For example, if this field represents "hour of day", then the range is the amount of milliseconds per one day.

For fields with a variable range, this method returns a suitable average value. If the range is too large to fit in a long, Long.MAX_VALUE is returned.

Specified by:

getRangeMillis in class DateTimeField

Returns:

the range of this field, in milliseconds

getMinimumValue

public int getMinimumValue()

Description copied from class: DateTimeField

Get the minimum allowable value for this field.

Specified by:

getMinimumValue in class DateTimeField

Returns:

the minimum valid value for this field, in the units of the field

getMinimumValue

public int getMinimumValue(long millis)

Description copied from class: DateTimeField

Get the minimum value for this field evaluated at the specified time.

This implementation returns the same as DateTimeField.getMinimumValue().

Overrides:

getMinimumValue in class DateTimeField

Parameters:

millis - the milliseconds from 1970-01-01T00:00:00Z to query

Returns:

the minimum value for this field, in the units of the field

getMaximumValue

public int getMaximumValue()

Description copied from class: DateTimeField

Get the maximum allowable value for this field.

Specified by:

getMaximumValue in class DateTimeField

Returns:

the maximum valid value for this field, in the units of the field

getMaximumValue

public int getMaximumValue(long millis)

Description copied from class: DateTimeField

Get the maximum value for this field evaluated at the specified time.

This implementation returns the same as DateTimeField.getMaximumValue().

Overrides:

getMaximumValue in class DateTimeField

Parameters:

millis - the milliseconds from 1970-01-01T00:00:00Z to query

Returns:

the maximum value for this field, in the units of the field

getMaximumTextLength

public int getMaximumTextLength(java.util.Locale locale)

Description copied from class: DateTimeField

Get the maximum text value for this field. The default implementation returns the equivalent of Integer.toString(getMaximumValue()).length().

Overrides:

getMaximumTextLength in class DateTimeField

Parameters:

locale - the locale to use for selecting a text symbol

Returns:

the maximum text length

getMaximumShortTextLength

public int getMaximumShortTextLength(java.util.Locale locale)

Description copied from class: DateTimeField

Get the maximum short text value for this field. The default implementation returns getMaximumTextLength().

Overrides:

getMaximumShortTextLength in class DateTimeField

Parameters:

locale - the locale to use for selecting a text symbol

Returns:

the maximum short text length

roundFloor

public long roundFloor(long millis)

Description copied from class: DateTimeField

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.

Specified by:

roundFloor in class DateTimeField

Parameters:

millis - the milliseconds from 1970-01-01T00:00:00Z to round

Returns:

rounded milliseconds

roundCeiling

public long roundCeiling(long millis)

Description copied from class: DateTimeField

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 millis is modified as a result, adds one field unit. Subclasses are encouraged to provide a more efficient implementation.

Overrides:

roundCeiling in class DateTimeField

Parameters:

millis - the milliseconds from 1970-01-01T00:00:00Z to round

Returns:

rounded milliseconds

roundHalfFloor

public long roundHalfFloor(long millis)

Description copied from class: DateTimeField

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 class DateTimeField

Parameters:

millis - the milliseconds from 1970-01-01T00:00:00Z to round

Returns:

rounded milliseconds

roundHalfCeiling

public long roundHalfCeiling(long millis)

Description copied from class: DateTimeField

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 class DateTimeField

Parameters:

millis - the milliseconds from 1970-01-01T00:00:00Z to round

Returns:

rounded milliseconds

roundHalfEven

public long roundHalfEven(long millis)

Description copied from class: DateTimeField

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 class DateTimeField

Parameters:

millis - the milliseconds from 1970-01-01T00:00:00Z to round

Returns:

rounded milliseconds

remainder

public long remainder(long millis)

Description copied from class: DateTimeField

Retains only the fractional units of this field. This field value and all fields of higher magnitude are reset. In other words, calling remainder retains the part of the instant that roundFloor dropped.

For example, a datetime of 2002-11-02T23:34:56.789, the remainder by hour is 1970-01-01T00:34:56.789.

The default implementation computes millis - roundFloor(millis). Subclasses are encouraged to provide a more efficient implementation.

Overrides:

remainder in class DateTimeField

Parameters:

millis - the milliseconds from 1970-01-01T00:00:00Z to get the remainder

Returns:

remainder milliseconds

toString

public java.lang.String toString()

Description copied from class: DateTimeField

Get a suitable debug string.

Overrides:

toString in class DateTimeField

Returns:

debug string