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

public class

OffsetDateTimeField

extends DecoratedDateTimeField

java.lang.Object
↳	org.joda.time.DateTimeField
	↳	org.joda.time.field.BaseDateTimeField
		↳	org.joda.time.field.DecoratedDateTimeField
			↳	org.joda.time.field.OffsetDateTimeField

Class Overview

Generic offset adjusting datetime field.

OffsetDateTimeField is thread-safe and immutable.

Summary

Public Constructors
	OffsetDateTimeField(DateTimeField field, int offset) Constructor.
	OffsetDateTimeField(DateTimeField field, DateTimeFieldType type, int offset) Constructor.
	OffsetDateTimeField(DateTimeField field, DateTimeFieldType type, int offset, int minValue, int maxValue) Constructor.

Public Methods
long	add(long instant, long amount) Add the specified amount of offset units to the specified time instant.
long	add(long instant, int amount) Add the specified amount of offset units to the specified time instant.
long	addWrapField(long instant, int amount) Add to the offset component of the specified time instant, wrapping around within that component if necessary.
int	get(long instant) Get the amount of offset units from the specified time instant.
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	getMaximumValue() Get the maximum value for the field.
int	getMinimumValue() Get the minimum value for the field.
int	getOffset() Returns the offset added to the field values.
boolean	isLeap(long instant) Returns whether this field is 'leap' for the specified instant.
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, int value) Set the specified amount of offset units to the specified time instant.

[Expand]

Inherited Methods

From class org.joda.time.field.DecoratedDateTimeField

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 OffsetDateTimeField (DateTimeField field, int offset)

Constructor.

Parameters

field	the field to wrap, like "year()".
offset	offset to add to field values

Throws

IllegalArgumentException	if offset is zero

public OffsetDateTimeField (DateTimeField field, DateTimeFieldType type, int offset)

Constructor.

Parameters

field	the field to wrap, like "year()".
type	the field type this field actually uses
offset	offset to add to field values

Throws

IllegalArgumentException	if offset is zero

public OffsetDateTimeField (DateTimeField field, DateTimeFieldType type, int offset, int minValue, int maxValue)

Constructor.

Parameters

field	the field to wrap, like "year()".
type	the field type this field actually uses
offset	offset to add to field values
minValue	minimum allowed value
maxValue	maximum allowed value

Throws

IllegalArgumentException	if offset is zero

Public Methods

public long add (long instant, long amount)

Add the specified amount of offset units to the specified time instant. The amount added may be negative.

Parameters

instant	the time instant in millis to update.
amount	the amount of units to add (can be negative).

Returns

the updated time instant.

public long add (long instant, int amount)

Add the specified amount of offset units to the specified time instant. The amount added may be negative.

Parameters

instant	the time instant in millis to update.
amount	the amount of units to add (can be negative).

Returns

the updated time instant.

public long addWrapField (long instant, int amount)

Add to the offset component of the specified time instant, wrapping around within that component if necessary.

Parameters

instant	the time instant in millis to update.
amount	the amount of units to add (can be negative).

Returns

the updated time instant.

public int get (long instant)

Get the amount of offset units from the specified time instant.

Parameters

instant	the time instant in millis to query.

Returns

the amount of units extracted from the input.

public int getLeapAmount (long instant)

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

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

This implementation returns zero.

Parameters

instant	the instant to check for leap status

Returns

the amount, in units of the leap duration field, that the field is leap

public DurationField getLeapDurationField ()

If this field were to leap, then it would be in units described by the returned duration. If this field doesn't ever leap, null is returned.

This implementation returns null.

Returns

the leap duration field if field can be leap, null if it can't

public int getMaximumValue ()

Get the maximum value for the field.

Returns

the maximum value

public int getMinimumValue ()

Get the minimum value for the field.

Returns

the minimum value

public int getOffset ()

Returns the offset added to the field values.

Returns

the offset

public boolean isLeap (long instant)

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

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

This implementation returns false.

Parameters

instant	the instant to check for leap status

Returns

true if the field is 'leap'

public long remainder (long instant)

Returns the fractional duration milliseconds of this field. In other words, calling remainder returns the duration that roundFloor would subtract.

For example, on a datetime of 2002-11-02T23:34:56.789, the remainder by hour is 34 minutes and 56.789 seconds.

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

Parameters

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

Returns

remainder duration, in milliseconds

public long roundCeiling (long instant)

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

Parameters

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

Returns

rounded milliseconds

public long roundFloor (long instant)

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.

Parameters

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

Returns

rounded milliseconds

public long roundHalfCeiling (long instant)

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.

Parameters

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

Returns

rounded milliseconds

public long roundHalfEven (long instant)

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.

Parameters

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

Returns

rounded milliseconds

public long roundHalfFloor (long instant)

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.

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 offset units to the specified time instant.

Parameters

instant	the time instant in millis to update.
value	value of units to set.

Returns

the updated time instant.

Throws

IllegalArgumentException	if value is too large or too small.

Classes

OffsetDateTimeField

Class Overview

Summary

Public Constructors

public OffsetDateTimeField (DateTimeField field, int offset)

Parameters

Throws

public OffsetDateTimeField (DateTimeField field, DateTimeFieldType type, int offset)

Parameters

Throws

public OffsetDateTimeField (DateTimeField field, DateTimeFieldType type, int offset, int minValue, int maxValue)

Parameters

Throws

Public Methods

public long add (long instant, long amount)

Parameters

Returns

public long add (long instant, int amount)

Parameters

Returns

public long addWrapField (long instant, int amount)

Parameters

Returns

public int get (long instant)

Parameters

Returns

public int getLeapAmount (long instant)

Parameters

Returns

public DurationField getLeapDurationField ()

Returns

public int getMaximumValue ()

Returns

public int getMinimumValue ()

Returns

public int getOffset ()

Returns

public boolean isLeap (long instant)

Parameters

Returns

public long remainder (long instant)

Parameters

Returns

public long roundCeiling (long instant)

Parameters

Returns

public long roundFloor (long instant)

Parameters

Returns

public long roundHalfCeiling (long instant)

Parameters

Returns

public long roundHalfEven (long instant)

Parameters

Returns

public long roundHalfFloor (long instant)

Parameters

Returns

public long set (long instant, int value)

Parameters

Returns

Throws