ZonedChronology.ZonedDateTimeField

java.lang.Object
- org.joda.time.DateTimeField
- - org.joda.time.field.BaseDateTimeField
  - - org.joda.time.chrono.ZonedChronology.ZonedDateTimeField

Enclosing class:

ZonedChronology
```
static final class ZonedChronology.ZonedDateTimeField
extends BaseDateTimeField
```
A DateTimeField that decorates another to add timezone behaviour.
This class converts passed in instants to local wall time, and vice versa on output.

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) DurationField`	`iDurationField`
`(package private) DateTimeField`	`iField`
`(package private) DurationField`	`iLeapDurationField`
`(package private) DurationField`	`iRangeDurationField`
`(package private) boolean`	`iTimeField`
`(package private) DateTimeZone`	`iZone`
`private static long`	`serialVersionUID`

Constructor Summary

Constructors
Constructor and Description
`ZonedDateTimeField(DateTimeField field, DateTimeZone zone, DurationField durationField, DurationField rangeDurationField, DurationField leapDurationField)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`add(long instant, int value)` Adds a value (which may be negative) to the instant value, overflowing into larger fields if necessary.
`long`	`add(long instant, long 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.
`boolean`	`equals(java.lang.Object obj)`
`int`	`get(long instant)` Get the value of this field from the milliseconds.
`java.lang.String`	`getAsShortText(int fieldValue, java.util.Locale locale)` Get the human-readable, short text value of this field from the field value.
`java.lang.String`	`getAsShortText(long instant, java.util.Locale locale)` Get the human-readable, short text value of this field from the milliseconds.
`java.lang.String`	`getAsText(int fieldValue, java.util.Locale locale)` Get the human-readable, text value of this field from the field value.
`java.lang.String`	`getAsText(long instant, java.util.Locale locale)` Get the human-readable, text value of this field from the milliseconds.
`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(java.util.Locale locale)` Get the maximum short text value for this field.
`int`	`getMaximumTextLength(java.util.Locale locale)` Get the maximum text value for this field.
`int`	`getMaximumValue()` Get the maximum allowable 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.
`int`	`getMaximumValue(ReadablePartial instant, int[] values)` Get the maximum value for this field using the partial instant and the specified values.
`int`	`getMinimumValue()` Get the minimum allowable value for this field.
`int`	`getMinimumValue(long instant)` Get the minimum value for this field evaluated at the specified time.
`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.
`private int`	`getOffsetToAdd(long instant)`
`DurationField`	`getRangeDurationField()` Returns the range duration of this field.
`int`	`hashCode()`
`boolean`	`isLeap(long instant)` Returns whether this field is 'leap' for the specified instant.
`boolean`	`isLenient()` Returns true if the set method is lenient.
`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`	`set(long instant, int value)` Sets a value in the milliseconds supplied.
`long`	`set(long instant, java.lang.String text, java.util.Locale locale)` Sets a value in the milliseconds supplied from a human-readable, text value.

Methods inherited from class org.joda.time.field.BaseDateTimeField
add, addWrapField, addWrapPartial, convertText, getAsShortText, getAsShortText, getAsShortText, getAsText, getAsText, getAsText, getName, getType, isSupported, roundHalfCeiling, roundHalfEven, roundHalfFloor, set, set, set, toString

Methods inherited from class org.joda.time.DateTimeField
setExtended

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
  - iField
```
final DateTimeField iField
```
  - iZone
```
final DateTimeZone iZone
```
  - iDurationField
```
final DurationField iDurationField
```
  - iTimeField
```
final boolean iTimeField
```
  - iRangeDurationField
```
final DurationField iRangeDurationField
```
  - iLeapDurationField
```
final DurationField iLeapDurationField
```
- Constructor Detail
  - ZonedDateTimeField
```
ZonedDateTimeField(DateTimeField field,
                   DateTimeZone zone,
                   DurationField durationField,
                   DurationField rangeDurationField,
                   DurationField leapDurationField)
```
- Method Detail
  - isLenient
```
public 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.
    
    Specified by:
    
    isLenient in class DateTimeField
    
    Returns:
    
    true if this field is lenient
  - get
```
public int get(long instant)
```
    Description copied from class: BaseDateTimeField
    
    Get the value of this field from the milliseconds.
    
    Specified by:
    
    get in class BaseDateTimeField
    
    Parameters:
    
    instant - the milliseconds from 1970-01-01T00:00:00Z to query
    
    Returns:
    
    the value of the field, in the units of the field
  - getAsText
```
public java.lang.String getAsText(long instant,
                                  java.util.Locale locale)
```
    Description copied from class: BaseDateTimeField
    
    Get the human-readable, text value of this field from the milliseconds. If the specified locale is null, the default locale is used.
    The default implementation returns getAsText(get(instant), locale).
    
    Overrides:
    
    getAsText in class BaseDateTimeField
    
    Parameters:
    
    instant - the milliseconds from 1970-01-01T00:00:00Z to query
    
    locale - the locale to use for selecting a text symbol, null means default
    
    Returns:
    
    the text value of the field
  - getAsShortText
```
public java.lang.String getAsShortText(long instant,
                                       java.util.Locale locale)
```
    Description copied from class: BaseDateTimeField
    
    Get the human-readable, short text value of this field from the milliseconds. If the specified locale is null, the default locale is used.
    The default implementation returns getAsShortText(get(instant), locale).
    
    Overrides:
    
    getAsShortText in class BaseDateTimeField
    
    Parameters:
    
    instant - the milliseconds from 1970-01-01T00:00:00Z to query
    
    locale - the locale to use for selecting a text symbol, null means default
    
    Returns:
    
    the text value of the field
  - getAsText
```
public java.lang.String getAsText(int fieldValue,
                                  java.util.Locale locale)
```
    Description copied from class: BaseDateTimeField
    
    Get the human-readable, text value of this field from the field value. If the specified locale is null, the default locale is used.
    The default implementation returns Integer.toString(get(instant)).
    Note: subclasses that override this method should also override getMaximumTextLength.
    
    Overrides:
    
    getAsText in class BaseDateTimeField
    
    Parameters:
    
    fieldValue - the numeric value to convert to text
    
    locale - the locale to use for selecting a text symbol, null for default
    
    Returns:
    
    the text value of the field
  - getAsShortText
```
public java.lang.String getAsShortText(int fieldValue,
                                       java.util.Locale locale)
```
    Description copied from class: BaseDateTimeField
    
    Get the human-readable, short text value of this field from the field value. If the specified locale is null, the default locale is used.
    The default implementation returns getAsText(fieldValue, locale).
    Note: subclasses that override this method should also override getMaximumShortTextLength.
    
    Overrides:
    
    getAsShortText in class BaseDateTimeField
    
    Parameters:
    
    fieldValue - the numeric value to convert to text
    
    locale - the locale to use for selecting a text symbol, null for default
    
    Returns:
    
    the text value of the field
  - add
```
public long add(long instant,
                int value)
```
    Description copied from class: BaseDateTimeField
    
    Adds a value (which may be negative) to the instant value, overflowing into larger fields if necessary.
    The value will be added to this field. If the value is too large to be added solely to this field, larger fields will increase as required. Smaller fields should be unaffected, except where the result would be an invalid value for a smaller field. In this case the smaller field is adjusted to be in range.
    For example, in the ISO chronology:
    2000-08-20 add six months is 2001-02-20
    2000-08-20 add twenty months is 2002-04-20
    2000-08-20 add minus nine months is 1999-11-20
    2001-01-31 add one month is 2001-02-28
    2001-01-31 add two months is 2001-03-31
    
    Overrides:
    
    add in class BaseDateTimeField
    
    Parameters:
    
    instant - the milliseconds from 1970-01-01T00:00:00Z to add to
    
    value - the value to add, in the units of the field
    
    Returns:
    
    the updated milliseconds
  - add
```
public long add(long instant,
                long value)
```
    Description copied from class: BaseDateTimeField
    
    Adds a value (which may be negative) to the instant value, overflowing into larger fields if necessary.
    
    Overrides:
    
    add in class BaseDateTimeField
    
    Parameters:
    
    instant - the milliseconds from 1970-01-01T00:00:00Z to add to
    
    value - the long value to add, in the units of the field
    
    Returns:
    
    the updated milliseconds
    
    See Also:
    
    BaseDateTimeField.add(long,int)
  - addWrapField
```
public long addWrapField(long instant,
                         int value)
```
    Description copied from class: BaseDateTimeField
    
    Adds a value (which may be negative) to the instant value, wrapping within this field.
    The value will be added to this field. If the value is too large to be added solely to this field then it wraps. Larger fields are always unaffected. Smaller fields should be unaffected, except where the result would be an invalid value for a smaller field. In this case the smaller field is adjusted to be in range.
    For example, in the ISO chronology:
    2000-08-20 addWrapField six months is 2000-02-20
    2000-08-20 addWrapField twenty months is 2000-04-20
    2000-08-20 addWrapField minus nine months is 2000-11-20
    2001-01-31 addWrapField one month is 2001-02-28
    2001-01-31 addWrapField two months is 2001-03-31
    
    The default implementation internally calls set. Subclasses are encouraged to provide a more efficient implementation.
    
    Overrides:
    
    addWrapField in class BaseDateTimeField
    
    Parameters:
    
    instant - the milliseconds from 1970-01-01T00:00:00Z to add to
    
    value - the value to add, in the units of the field
    
    Returns:
    
    the updated milliseconds
  - set
```
public long set(long instant,
                int value)
```
    Description copied from class: BaseDateTimeField
    
    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.
    
    Specified by:
    
    set in class BaseDateTimeField
    
    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
  - set
```
public long set(long instant,
                java.lang.String text,
                java.util.Locale locale)
```
    Description copied from class: BaseDateTimeField
    
    Sets a value in the milliseconds supplied from a human-readable, text value. If the specified locale is null, the default locale is used.
    This implementation uses convertText(String, Locale) and BaseDateTimeField.set(long, int).
    Note: subclasses that override this method should also override getAsText.
    
    Overrides:
    
    set in class BaseDateTimeField
    
    Parameters:
    
    instant - the milliseconds from 1970-01-01T00:00:00Z to set in
    
    text - the text value to set
    
    locale - the locale to use for selecting a text symbol, null for default
    
    Returns:
    
    the updated milliseconds
  - getDifference
```
public int getDifference(long minuendInstant,
                         long subtrahendInstant)
```
    Description copied from class: BaseDateTimeField
    Computes the difference between two instants, as measured in the units of this field. Any fractional units are dropped from the result. Calling getDifference reverses the effect of calling add. In the following code:
```
 long instant = ...
 int v = ...
 int age = getDifference(add(instant, v), instant);
 
```
    The value 'age' is the same as the value 'v'.
    Overrides:
    
    getDifference in class BaseDateTimeField
    
    Parameters:
    
    minuendInstant - the milliseconds from 1970-01-01T00:00:00Z to subtract from
    
    subtrahendInstant - the milliseconds from 1970-01-01T00:00:00Z to subtract off the minuend
    
    Returns:
    
    the difference in the units of this field
  - getDifferenceAsLong
```
public long getDifferenceAsLong(long minuendInstant,
                                long subtrahendInstant)
```
    Description copied from class: BaseDateTimeField
    Computes the difference between two instants, as measured in the units of this field. Any fractional units are dropped from the result. Calling getDifference reverses the effect of calling add. In the following code:
```
 long instant = ...
 long v = ...
 long age = getDifferenceAsLong(add(instant, v), instant);
 
```
    The value 'age' is the same as the value 'v'.
    Overrides:
    
    getDifferenceAsLong in class BaseDateTimeField
    
    Parameters:
    
    minuendInstant - the milliseconds from 1970-01-01T00:00:00Z to subtract from
    
    subtrahendInstant - the milliseconds from 1970-01-01T00:00:00Z to subtract off the minuend
    
    Returns:
    
    the difference in the units of this field
  - getDurationField
```
public final DurationField getDurationField()
```
    Description copied from class: BaseDateTimeField
    
    Returns the duration per unit value of this field. For example, if this field represents "hour of day", then the unit duration is an hour.
    
    Specified by:
    
    getDurationField in class BaseDateTimeField
    
    Returns:
    
    the duration of this field, or UnsupportedDurationField if field has no duration
  - getRangeDurationField
```
public final DurationField getRangeDurationField()
```
    Description copied from class: BaseDateTimeField
    
    Returns the range duration of this field. For example, if this field represents "hour of day", then the range duration is a day.
    
    Specified by:
    
    getRangeDurationField in class BaseDateTimeField
    
    Returns:
    
    the range duration of this field, or null if field has no range
  - isLeap
```
public boolean isLeap(long instant)
```
    Description copied from class: BaseDateTimeField
    
    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.
    
    Overrides:
    
    isLeap in class BaseDateTimeField
    
    Parameters:
    
    instant - the instant to check for leap status
    
    Returns:
    
    true if the field is 'leap'
  - getLeapAmount
```
public int getLeapAmount(long instant)
```
    Description copied from class: BaseDateTimeField
    
    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.
    
    Overrides:
    
    getLeapAmount in class BaseDateTimeField
    
    Parameters:
    
    instant - the instant to check for leap status
    
    Returns:
    
    the amount, in units of the leap duration field, that the field is leap
  - getLeapDurationField
```
public final DurationField getLeapDurationField()
```
    Description copied from class: BaseDateTimeField
    
    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.
    
    Overrides:
    
    getLeapDurationField in class BaseDateTimeField
    
    Returns:
    
    the leap duration field if field can be leap, null if it can't
  - roundFloor
```
public long roundFloor(long instant)
```
    Description copied from class: BaseDateTimeField
    
    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.
    
    Specified by:
    
    roundFloor in class BaseDateTimeField
    
    Parameters:
    
    instant - the milliseconds from 1970-01-01T00:00:00Z to round
    
    Returns:
    
    rounded milliseconds
  - roundCeiling
```
public long roundCeiling(long instant)
```
    Description copied from class: BaseDateTimeField
    
    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.
    
    Overrides:
    
    roundCeiling in class BaseDateTimeField
    
    Parameters:
    
    instant - the milliseconds from 1970-01-01T00:00:00Z to round
    
    Returns:
    
    rounded milliseconds
  - remainder
```
public long remainder(long instant)
```
    Description copied from class: BaseDateTimeField
    
    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.
    
    Overrides:
    
    remainder in class BaseDateTimeField
    
    Parameters:
    
    instant - the milliseconds from 1970-01-01T00:00:00Z to get the remainder
    
    Returns:
    
    remainder duration, in milliseconds
  - getMinimumValue
```
public int getMinimumValue()
```
    Description copied from class: BaseDateTimeField
    
    Get the minimum allowable value for this field.
    
    Specified by:
    
    getMinimumValue in class BaseDateTimeField
    
    Returns:
    
    the minimum valid value for this field, in the units of the field
  - getMinimumValue
```
public int getMinimumValue(long instant)
```
    Description copied from class: BaseDateTimeField
    
    Get the minimum value for this field evaluated at the specified time.
    This implementation returns the same as BaseDateTimeField.getMinimumValue().
    
    Overrides:
    
    getMinimumValue in class BaseDateTimeField
    
    Parameters:
    
    instant - the milliseconds from 1970-01-01T00:00:00Z to query
    
    Returns:
    
    the minimum value for this field, in the units of the field
  - getMinimumValue
```
public int getMinimumValue(ReadablePartial instant)
```
    Description copied from class: BaseDateTimeField
    
    Get the minimum value for this field evaluated at the specified instant.
    This implementation returns the same as BaseDateTimeField.getMinimumValue().
    
    Overrides:
    
    getMinimumValue in class BaseDateTimeField
    
    Parameters:
    
    instant - the partial instant to query
    
    Returns:
    
    the minimum value for this field, in the units of the field
  - getMinimumValue
```
public int getMinimumValue(ReadablePartial instant,
                           int[] values)
```
    Description copied from class: BaseDateTimeField
    
    Get the minimum value for this field using the partial instant and the specified values.
    This implementation returns the same as BaseDateTimeField.getMinimumValue(ReadablePartial).
    
    Overrides:
    
    getMinimumValue in class BaseDateTimeField
    
    Parameters:
    
    instant - the partial instant to query
    
    values - the values to use
    
    Returns:
    
    the minimum value for this field, in the units of the field
  - getMaximumValue
```
public int getMaximumValue()
```
    Description copied from class: BaseDateTimeField
    
    Get the maximum allowable value for this field.
    
    Specified by:
    
    getMaximumValue in class BaseDateTimeField
    
    Returns:
    
    the maximum valid value for this field, in the units of the field
  - getMaximumValue
```
public int getMaximumValue(long instant)
```
    Description copied from class: BaseDateTimeField
    
    Get the maximum value for this field evaluated at the specified time.
    This implementation returns the same as BaseDateTimeField.getMaximumValue().
    
    Overrides:
    
    getMaximumValue in class BaseDateTimeField
    
    Parameters:
    
    instant - the milliseconds from 1970-01-01T00:00:00Z to query
    
    Returns:
    
    the maximum value for this field, in the units of the field
  - getMaximumValue
```
public int getMaximumValue(ReadablePartial instant)
```
    Description copied from class: BaseDateTimeField
    
    Get the maximum value for this field evaluated at the specified instant.
    This implementation returns the same as BaseDateTimeField.getMaximumValue().
    
    Overrides:
    
    getMaximumValue in class BaseDateTimeField
    
    Parameters:
    
    instant - the partial instant to query
    
    Returns:
    
    the maximum value for this field, in the units of the field
  - getMaximumValue
```
public int getMaximumValue(ReadablePartial instant,
                           int[] values)
```
    Description copied from class: BaseDateTimeField
    
    Get the maximum value for this field using the partial instant and the specified values.
    This implementation returns the same as BaseDateTimeField.getMaximumValue(ReadablePartial).
    
    Overrides:
    
    getMaximumValue in class BaseDateTimeField
    
    Parameters:
    
    instant - the partial instant to query
    
    values - the values to use
    
    Returns:
    
    the maximum value for this field, in the units of the field
  - getMaximumTextLength
```
public int getMaximumTextLength(java.util.Locale locale)
```
    Description copied from class: BaseDateTimeField
    
    Get the maximum text value for this field. The default implementation returns the equivalent of Integer.toString(getMaximumValue()).length().
    
    Overrides:
    
    getMaximumTextLength in class BaseDateTimeField
    
    Parameters:
    
    locale - the locale to use for selecting a text symbol
    
    Returns:
    
    the maximum text length
  - getMaximumShortTextLength
```
public int getMaximumShortTextLength(java.util.Locale locale)
```
    Description copied from class: BaseDateTimeField
    
    Get the maximum short text value for this field. The default implementation returns getMaximumTextLength().
    
    Overrides:
    
    getMaximumShortTextLength in class BaseDateTimeField
    
    Parameters:
    
    locale - the locale to use for selecting a text symbol
    
    Returns:
    
    the maximum short text length
  - getOffsetToAdd
```
private int getOffsetToAdd(long instant)
```
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class ZonedChronology.ZonedDateTimeField

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class org.joda.time.DateTimeField

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

iField

iZone

iDurationField

iTimeField

iRangeDurationField

iLeapDurationField

Constructor Detail

ZonedDateTimeField

Method Detail

isLenient

get

getAsText

getAsShortText

getAsText

getAsShortText

add

add

addWrapField

set

set

getDifference

getDifferenceAsLong

getDurationField

getRangeDurationField

isLeap

getLeapAmount

getLeapDurationField

roundFloor

roundCeiling

remainder

getMinimumValue

getMinimumValue

getMinimumValue

getMinimumValue

getMaximumValue

getMaximumValue

getMaximumValue

getMaximumValue

getMaximumTextLength

getMaximumShortTextLength

getOffsetToAdd

equals

hashCode