org.joda.time.field
Class LenientDateTimeField

java.lang.Object
  org.joda.time.DateTimeField
      org.joda.time.field.DelegatedDateTimeField
          org.joda.time.field.LenientDateTimeField

All Implemented Interfaces:

Serializable

public class LenientDateTimeField
extends DelegatedDateTimeField

Converts a strict DateTimeField into a lenient one. By being lenient, the set method accepts out of bounds values, performing an addition instead.

LenientDateTimeField is thread-safe and immutable.

Since:

1.0

Author:

Brian S O'Neill

See Also:

LenientChronology, StrictDateTimeField, Serialized Form

Method Summary

static DateTimeField	getInstance(DateTimeField field) Returns a lenient version of the given field.
boolean	isLenient() Returns true if the set method is lenient.
long	set(long instant, int value) Set values which may be out of bounds.

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

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, getWrappedField, isLeap, isSupported, remainder, roundCeiling, roundFloor, roundHalfCeiling, roundHalfEven, roundHalfFloor, set, set, set, set, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static DateTimeField getInstance(DateTimeField field)

Returns a lenient version of the given field. If it is already lenient, then it is returned as-is. Otherwise, a new LenientDateTimeField is returned.

isLenient

public final boolean isLenient()

Description copied from class: DateTimeField

Returns true if the set method is lenient. If so, it accepts values that are out of bounds. For example, a lenient day of month field accepts 32 for January, converting it to February 1.

Overrides:

isLenient in class DelegatedDateTimeField

Returns:

true if this field is lenient

set

public long set(long instant,
                int value)

Set values which may be out of bounds. If the value is out of bounds, the instant is first set to the minimum allowed value, and then the difference is added.

Overrides:

set in class DelegatedDateTimeField

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