Summary: Ctors | Methods | Protected Methods | Inherited Methods | [Expand All]

public abstract class

PreciseDurationDateTimeField

extends BaseDateTimeField

java.lang.Object
↳	org.joda.time.DateTimeField
	↳	org.joda.time.field.BaseDateTimeField
		↳	org.joda.time.field.PreciseDurationDateTimeField

Known Direct Subclasses

PreciseDateTimeField

Class Overview

Precise datetime field, which has a precise unit duration field.

PreciseDurationDateTimeField is thread-safe and immutable, and its subclasses must be as well.

Summary

Public Constructors
	PreciseDurationDateTimeField(DateTimeFieldType type, DurationField unit) Constructor.

Public Methods
DurationField	getDurationField() Returns the duration per unit value of this field.
int	getMinimumValue() Get the minimum value for the field.
final long	getUnitMillis()
boolean	isLenient() Returns false by default.
long	remainder(long instant) This method assumes that this field is properly rounded on 1970-01-01T00:00:00.
long	roundCeiling(long instant) This method assumes that this field is properly rounded on 1970-01-01T00:00:00.
long	roundFloor(long instant) This method assumes that this field is properly rounded on 1970-01-01T00:00:00.
long	set(long instant, int value) Set the specified amount of units to the specified time instant.

Protected Methods
int	getMaximumValueForSet(long instant, int value) Called by the set method to get the maximum allowed value.

[Expand]

Inherited Methods

From class org.joda.time.field.BaseDateTimeField

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 instant value, overflowing into larger fields if necessary.
long	add(long instant, int value) Adds a value (which may be negative) to the instant value, overflowing into larger fields if necessary.
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.
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(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.
final String	getAsShortText(ReadablePartial partial, Locale locale) Get the human-readable, short text value of this field from a partial instant.
final 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.
final 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.
final 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.
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.
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.
abstract 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 instant.
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.
abstract int	getMinimumValue() Get the minimum allowable value for this field.
final String	getName() Get the name of the field.
abstract DurationField	getRangeDurationField() Returns the range duration of this field.
final DateTimeFieldType	getType() Get the type of the field.
boolean	isLeap(long instant) Returns whether this field is 'leap' for the specified instant.
final 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.
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, 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.
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.
final 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

Public Constructors

public PreciseDurationDateTimeField (DateTimeFieldType type, DurationField unit)

Constructor.

Parameters

type	the field type
unit	precise unit duration, like "days()".

Throws

IllegalArgumentException	if duration field is imprecise
IllegalArgumentException	if unit milliseconds is less than one

Public Methods

public DurationField getDurationField ()

Returns the duration per unit value of this field. For example, if this field represents "minute of hour", then the duration field is minutes.

Returns

the duration of this field, or UnsupportedDurationField if field has no duration

public int getMinimumValue ()

Get the minimum value for the field.

Returns

the minimum value

public final long getUnitMillis ()

public boolean isLenient ()

Returns false by default.

Returns

true if this field is lenient

public long remainder (long instant)

This method assumes that this field is properly rounded on 1970-01-01T00:00:00. If the rounding alignment differs, override this method as follows:

 return super.remainder(instant + ALIGNMENT_MILLIS);

Parameters

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

Returns

remainder duration, in milliseconds

public long roundCeiling (long instant)

This method assumes that this field is properly rounded on 1970-01-01T00:00:00. If the rounding alignment differs, override this method as follows:

 return super.roundCeiling(instant + ALIGNMENT_MILLIS) - ALIGNMENT_MILLIS;

Parameters

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

Returns

rounded milliseconds

public long roundFloor (long instant)

This method assumes that this field is properly rounded on 1970-01-01T00:00:00. If the rounding alignment differs, override this method as follows:

 return super.roundFloor(instant + ALIGNMENT_MILLIS) - ALIGNMENT_MILLIS;

Parameters

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

Returns

rounded milliseconds

public long set (long instant, int value)

Set the specified amount of units to the specified time instant.

Parameters

instant	the milliseconds from 1970-01-01T00:00:00Z to set in
value	value of units to set.

Returns

the updated time instant.

Throws

IllegalArgumentException	if value is too large or too small.

Protected Methods

protected int getMaximumValueForSet (long instant, int value)

Called by the set method to get the maximum allowed value. By default, returns getMaximumValue(instant). Override to provide a faster implementation.

Classes

PreciseDurationDateTimeField

Class Overview

Summary

Public Constructors

public PreciseDurationDateTimeField (DateTimeFieldType type, DurationField unit)

Parameters

Throws

Public Methods

public DurationField getDurationField ()

Returns

public int getMinimumValue ()

Returns

public final long getUnitMillis ()

public boolean isLenient ()

Returns

public long remainder (long instant)

Parameters

Returns

public long roundCeiling (long instant)

Parameters

Returns

public long roundFloor (long instant)

Parameters

Returns

public long set (long instant, int value)

Parameters

Returns

Throws

Protected Methods

protected int getMaximumValueForSet (long instant, int value)