org.joda.time.field

Class SkipDateTimeField

java.lang.Object

org.joda.time.DateTimeField

org.joda.time.field.DelegatedDateTimeField

org.joda.time.field.SkipDateTimeField

All Implemented Interfaces:

Serializable

public final class SkipDateTimeField
extends DelegatedDateTimeField

Wraps another field such that a certain value is skipped.

This is most useful for years where you want to skip zero, so the sequence runs ...,2,1,-1,-2,...

SkipDateTimeField is thread-safe and immutable.

Since:

1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SkipDateTimeField(Chronology chronology, DateTimeField field) Constructor that skips zero.
SkipDateTimeField(Chronology chronology, DateTimeField field, int skip) Constructor.

Method Summary

Modifier and Type	Method and Description
int	get(long millis) Get the value of this field from the milliseconds.
int	getMinimumValue() Get the minimum allowable value for this field.
long	set(long millis, int value) Sets a value in the milliseconds supplied.

Methods inherited from class org.joda.time.field.DelegatedDateTimeField

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

Methods inherited from class org.joda.time.DateTimeField

setExtended

Methods inherited from class java.lang.Object

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

Constructor Detail

SkipDateTimeField

public SkipDateTimeField(Chronology chronology,
                         DateTimeField field)

Constructor that skips zero.

Parameters:

chronology - the chronology to use

field - the field to skip zero on

SkipDateTimeField

public SkipDateTimeField(Chronology chronology,
                         DateTimeField field,
                         int skip)

Constructor.

Parameters:

chronology - the chronology to use

field - the field to skip zero on

skip - the value to skip

Method Detail

get

public int get(long millis)

Description copied from class: DateTimeField

Get the value of this field from the milliseconds.

Overrides:

get in class DelegatedDateTimeField

Parameters:

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

Returns:

the value of the field, in the units of the 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.

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

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

getMinimumValue

public int getMinimumValue()

Description copied from class: DateTimeField

Get the minimum allowable value for this field.

Overrides:

getMinimumValue in class DelegatedDateTimeField

Returns:

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