public static final class

DateTime.Property

extends AbstractReadableInstantFieldProperty
java.lang.Object
   ↳ org.joda.time.field.AbstractReadableInstantFieldProperty
     ↳ org.joda.time.DateTime.Property

Class Overview

DateTime.Property binds a DateTime to a DateTimeField allowing powerful datetime functionality to be easily accessed.

The simplest use of this class is as an alternative get method, here used to get the year '1972' (as an int) and the month 'December' (as a String). 

 DateTime dt = new DateTime(1972, 12, 3, 0, 0, 0, 0);
 int year = dt.year().get();
 String monthStr = dt.month().getAsText();

Methods are also provided that allow date modification. These return new instances of DateTime - they do not modify the original. The example below yields two independent immutable date objects 20 years apart. 

 DateTime dt = new DateTime(1972, 12, 3, 0, 0, 0, 0);
 DateTime dt20 = dt.year().addToCopy(20);
Serious modification of dates (ie. more than just changing one or two fields) should use the MutableDateTime class.

DateTime.Propery itself is thread-safe and immutable, as well as the DateTime being operated on.

Summary

Public Methods
DateTime addToCopy(int value)
Adds to this field in a copy of this DateTime.
DateTime addToCopy(long value)
Adds to this field in a copy of this DateTime.
DateTime addWrapFieldToCopy(int value)
Adds to this field, possibly wrapped, in a copy of this DateTime.
DateTime getDateTime()
Gets the datetime being used.
DateTimeField getField()
Gets the field being used.
DateTime roundCeilingCopy()
Rounds to the highest whole unit of this field on a copy of this DateTime.
DateTime roundFloorCopy()
Rounds to the lowest whole unit of this field on a copy of this DateTime.
DateTime roundHalfCeilingCopy()
Rounds to the nearest whole unit of this field on a copy of this DateTime, favoring the ceiling if halfway.
DateTime roundHalfEvenCopy()
Rounds to the nearest whole unit of this field on a copy of this DateTime.
DateTime roundHalfFloorCopy()
Rounds to the nearest whole unit of this field on a copy of this DateTime, favoring the floor if halfway.
DateTime setCopy(String text, Locale locale)
Sets this field in a copy of the DateTime to a parsed text value.
DateTime setCopy(int value)
Sets this field in a copy of the DateTime.
DateTime setCopy(String text)
Sets this field in a copy of the DateTime to a parsed text value.
DateTime withMaximumValue()
Returns a new DateTime with this field set to the maximum value for this field.
DateTime withMinimumValue()
Returns a new DateTime with this field set to the minimum value for this field.
Protected Methods
Chronology getChronology()
Gets the chronology of the datetime that this property is linked to.
long getMillis()
Gets the milliseconds of the datetime that this property is linked to.
[Expand]
Inherited Methods
From class org.joda.time.field.AbstractReadableInstantFieldProperty
From class java.lang.Object

Public Methods

public DateTime addToCopy (int value)

Adds to this field in a copy of this DateTime.

The DateTime attached to this property is unchanged by this call. This operation is faster than converting a DateTime to a MutableDateTime and back again when setting one field. When setting multiple fields, it is generally quicker to make the conversion to MutableDateTime.

Parameters
value the value to add to the field in the copy
Returns
  • a copy of the DateTime with the field value changed
Throws
IllegalArgumentException if the value isn't valid

public DateTime addToCopy (long value)

Adds to this field in a copy of this DateTime.

The DateTime attached to this property is unchanged by this call. This operation is faster than converting a DateTime to a MutableDateTime and back again when setting one field. When setting multiple fields, it is generally quicker to make the conversion to MutableDateTime.

Parameters
value the value to add to the field in the copy
Returns
  • a copy of the DateTime with the field value changed
Throws
IllegalArgumentException if the value isn't valid

public DateTime addWrapFieldToCopy (int value)

Adds to this field, possibly wrapped, in a copy of this DateTime. A wrapped operation only changes this field. Thus 31st January addWrapField one day goes to the 1st January.

The DateTime attached to this property is unchanged by this call. This operation is faster than converting a DateTime to a MutableDateTime and back again when setting one field. When setting multiple fields, it is generally quicker to make the conversion to MutableDateTime.

Parameters
value the value to add to the field in the copy
Returns
  • a copy of the DateTime with the field value changed
Throws
IllegalArgumentException if the value isn't valid

public DateTime getDateTime ()

Gets the datetime being used.

Returns
  • the datetime

public DateTimeField getField ()

Gets the field being used.

Returns
  • the field

public DateTime roundCeilingCopy ()

Rounds to the highest whole unit of this field on a copy of this DateTime.

Returns
  • a copy of the DateTime with the field value changed

public DateTime roundFloorCopy ()

Rounds to the lowest whole unit of this field on a copy of this DateTime.

Returns
  • a copy of the DateTime with the field value changed

public DateTime roundHalfCeilingCopy ()

Rounds to the nearest whole unit of this field on a copy of this DateTime, favoring the ceiling if halfway.

Returns
  • a copy of the DateTime with the field value changed

public DateTime roundHalfEvenCopy ()

Rounds to the nearest whole unit of this field on a copy of this DateTime. If halfway, the ceiling is favored over the floor only if it makes this field's value even.

Returns
  • a copy of the DateTime with the field value changed

public DateTime roundHalfFloorCopy ()

Rounds to the nearest whole unit of this field on a copy of this DateTime, favoring the floor if halfway.

Returns
  • a copy of the DateTime with the field value changed

public DateTime setCopy (String text, Locale locale)

Sets this field in a copy of the DateTime to a parsed text value.

The DateTime attached to this property is unchanged by this call. This operation is faster than converting a DateTime to a MutableDateTime and back again when setting one field. When setting multiple fields, it is generally quicker to make the conversion to MutableDateTime.

Parameters
text the text value to set
locale optional locale to use for selecting a text symbol
Returns
  • a copy of the DateTime with the field value changed
Throws
IllegalArgumentException if the text value isn't valid

public DateTime setCopy (int value)

Sets this field in a copy of the DateTime.

The DateTime attached to this property is unchanged by this call. This operation is faster than converting a DateTime to a MutableDateTime and back again when setting one field. When setting multiple fields, it is generally quicker to make the conversion to MutableDateTime.

Parameters
value the value to set the field in the copy to
Returns
  • a copy of the DateTime with the field value changed
Throws
IllegalArgumentException if the value isn't valid

public DateTime setCopy (String text)

Sets this field in a copy of the DateTime to a parsed text value.

The DateTime attached to this property is unchanged by this call. This operation is faster than converting a DateTime to a MutableDateTime and back again when setting one field. When setting multiple fields, it is generally quicker to make the conversion to MutableDateTime.

Parameters
text the text value to set
Returns
  • a copy of the DateTime with the field value changed
Throws
IllegalArgumentException if the text value isn't valid

public DateTime withMaximumValue ()

Returns a new DateTime with this field set to the maximum value for this field.

This operation is useful for obtaining a DateTime on the last day of the month, as month lengths vary. 

 DateTime lastDayOfMonth = dt.dayOfMonth().withMaximumValue();

The DateTime attached to this property is unchanged by this call.

Returns
  • a copy of the DateTime with this field set to its maximum

public DateTime withMinimumValue ()

Returns a new DateTime with this field set to the minimum value for this field.

The DateTime attached to this property is unchanged by this call.

Returns
  • a copy of the DateTime with this field set to its minimum

Protected Methods

protected Chronology getChronology ()

Gets the chronology of the datetime that this property is linked to.

Returns
  • the chronology

protected long getMillis ()

Gets the milliseconds of the datetime that this property is linked to.

Returns
  • the milliseconds