StrictDateTimeField

extends DelegatedDateTimeField

java.lang.Object
↳	org.joda.time.DateTimeField
	↳	org.joda.time.field.DelegatedDateTimeField
		↳	org.joda.time.field.StrictDateTimeField

Class Overview

Converts a lenient DateTimeField into a strict one. By being strict, the set throws an IllegalArgumentException if the value is out of bounds.

StrictDateTimeField is thread-safe and immutable.

Summary

Protected Constructors
	StrictDateTimeField(DateTimeField field)

Public Methods
static DateTimeField	getInstance(DateTimeField field) Returns a strict version of the given field.
final boolean	isLenient() Returns true if the set method is lenient.
long	set(long instant, int value) Does a bounds check before setting the value.

[Expand]

Inherited Methods

From class org.joda.time.field.DelegatedDateTimeField

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	add(long instant, long value) Adds a value (which may be negative) to the millis value, overflowing into larger fields if necessary.
long	add(long instant, int value) Adds a value (which may be negative) to the millis value, overflowing into larger fields if necessary.
long	addWrapField(long instant, int value) Adds a value (which may be negative) to the millis 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.
int	get(long instant) Get the value of this field from the milliseconds.
String	getAsShortText(ReadablePartial partial, int fieldValue, Locale locale) Get the human-readable, short text value of this field from a partial instant.
String	getAsShortText(int fieldValue, Locale locale) Get the human-readable, short text value of this field from the field value.
String	getAsShortText(ReadablePartial partial, Locale locale) Get the human-readable, short text value of this field from a partial instant.
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	getAsText(ReadablePartial partial, Locale locale) Get the human-readable, 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, Locale locale) Get the human-readable, text value of this field from the milliseconds.
String	getAsText(long instant) Get the human-readable, text value of this field from the milliseconds.
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.
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.
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 time.
int	getMaximumValue() Get the maximum allowable value for this field.
int	getMaximumValue(ReadablePartial instant, int[] values) Get the maximum value for this field using the partial instant and the specified values.
int	getMinimumValue(ReadablePartial instant) Get the minimum value for this field evaluated at the specified time.
int	getMinimumValue(ReadablePartial instant, int[] values) Get the minimum value for this field using the partial instant and the specified values.
int	getMinimumValue(long instant) Get the minimum value for this field evaluated at the specified time.
int	getMinimumValue() Get the minimum allowable value for this field.
String	getName() Get the name of the field.
DurationField	getRangeDurationField() Returns the range duration of this field.
DateTimeFieldType	getType() Get the type of the field.
final DateTimeField	getWrappedField() Gets the wrapped date time field.
boolean	isLeap(long instant) Returns whether this field is 'leap' for the specified instant.
boolean	isLenient() Returns true if the set method is lenient.
boolean	isSupported() Returns true if this field is supported.
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.
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, Locale locale) Sets a value in the milliseconds supplied from a human-readable, text value.
int[]	set(ReadablePartial instant, int fieldIndex, int[] values, int newValue) Sets a value using the specified partial instant.
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.
long	set(long instant, int value) Sets a value in the milliseconds supplied.
long	set(long instant, String text) Sets a value in the milliseconds supplied from a human-readable, text value.
String	toString() Get a suitable debug string.

From class org.joda.time.DateTimeField

abstract 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.
abstract long	add(long instant, long value) Adds a value (which may be negative) to the millis value, overflowing into larger fields if necessary.
abstract long	add(long instant, int value) Adds a value (which may be negative) to the millis value, overflowing into larger fields if necessary.
abstract long	addWrapField(long instant, int value) Adds a value (which may be negative) to the millis value, wrapping within this field.
abstract 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.
abstract 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.
abstract int	get(long instant) Get the value of this field from the milliseconds.
abstract String	getAsShortText(ReadablePartial partial, int fieldValue, Locale locale) Get the human-readable, short text value of this field from a partial instant.
abstract String	getAsShortText(int fieldValue, Locale locale) Get the human-readable, short text value of this field from the field value.
abstract String	getAsShortText(ReadablePartial partial, Locale locale) Get the human-readable, short text value of this field from a partial instant.
abstract String	getAsShortText(long instant) Get the human-readable, short text value of this field from the milliseconds.
abstract String	getAsShortText(long instant, Locale locale) Get the human-readable, short text value of this field from the milliseconds.
abstract String	getAsText(ReadablePartial partial, Locale locale) Get the human-readable, text value of this field from a partial instant.
abstract String	getAsText(int fieldValue, Locale locale) Get the human-readable, text value of this field from the field value.
abstract String	getAsText(long instant, Locale locale) Get the human-readable, text value of this field from the milliseconds.
abstract String	getAsText(long instant) Get the human-readable, text value of this field from the milliseconds.
abstract String	getAsText(ReadablePartial partial, int fieldValue, Locale locale) Get the human-readable, text value of this field from a partial instant.
abstract int	getDifference(long minuendInstant, long subtrahendInstant) Computes the difference between two instants, as measured in the units of this field.
abstract 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.
abstract int	getLeapAmount(long instant) Gets the amount by which this field is 'leap' for the specified instant.
abstract DurationField	getLeapDurationField() If this field were to leap, then it would be in units described by the returned duration.
abstract int	getMaximumShortTextLength(Locale locale) Get the maximum short text value for this field.
abstract int	getMaximumTextLength(Locale locale) Get the maximum text value for this field.
abstract int	getMaximumValue(long instant) Get the maximum value for this field evaluated at the specified time.
abstract int	getMaximumValue(ReadablePartial instant) Get the maximum value for this field evaluated at the specified time.
abstract int	getMaximumValue() Get the maximum allowable value for this field.
abstract int	getMaximumValue(ReadablePartial instant, int[] values) Get the maximum value for this field using the partial instant and the specified values.
abstract int	getMinimumValue(ReadablePartial instant) Get the minimum value for this field evaluated at the specified time.
abstract int	getMinimumValue(ReadablePartial instant, int[] values) Get the minimum value for this field using the partial instant and the specified values.
abstract int	getMinimumValue(long instant) Get the minimum value for this field evaluated at the specified time.
abstract int	getMinimumValue() Get the minimum allowable value for this field.
abstract String	getName() Get the name of the field.
abstract DurationField	getRangeDurationField() Returns the range duration of this field.
abstract DateTimeFieldType	getType() Get the type of the field.
abstract boolean	isLeap(long instant) Returns whether this field is 'leap' for the specified instant.
abstract boolean	isLenient() Returns true if the set method is lenient.
abstract boolean	isSupported() Returns true if this field is supported.
abstract long	remainder(long instant) Returns the fractional duration milliseconds of this field.
abstract 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.
abstract long	roundHalfCeiling(long instant) Round to the nearest whole unit of this field.
abstract long	roundHalfEven(long instant) Round to the nearest whole unit of this field.
abstract long	roundHalfFloor(long instant) Round to the nearest whole unit of this field.
abstract long	set(long instant, String text, Locale locale) Sets a value in the milliseconds supplied from a human-readable, text value.
abstract int[]	set(ReadablePartial instant, int fieldIndex, int[] values, int newValue) Sets a value using the specified partial instant.
abstract 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.
abstract long	set(long instant, int value) Sets a value in the milliseconds supplied.
abstract long	set(long instant, String text) Sets a value in the milliseconds supplied from a human-readable, text value.
abstract String	toString() Get a suitable debug string.

From class java.lang.Object

Protected Constructors

protected StrictDateTimeField (DateTimeField field)

Public Methods

public static DateTimeField getInstance (DateTimeField field)

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

public final boolean isLenient ()

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.

Returns

true if this field is lenient

public long set (long instant, int value)

Does a bounds check before setting the value.

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

Throws

IllegalArgumentException	if the value is invalid

Classes

StrictDateTimeField

Class Overview

See Also

Summary

Protected Constructors

protected StrictDateTimeField (DateTimeField field)

Public Methods

public static DateTimeField getInstance (DateTimeField field)

public final boolean isLenient ()

Returns

public long set (long instant, int value)

Parameters

Returns

Throws