public static final class

LocalDate.Property

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

Class Overview

LocalDate.Property binds a LocalDate 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). 

 LocalDate dt = new LocalDate(1972, 12, 3, 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 LocalDate - they do not modify the original. The example below yields two independent immutable date objects 20 years apart. 

 LocalDate dt = new LocalDate(1972, 12, 3);
 LocalDate dt1920 = dt.year().setCopy(1920);

LocalDate.Property itself is thread-safe and immutable, as well as the LocalDate being operated on.

Summary

Public Methods
LocalDate addToCopy(int value)
Adds to this field in a copy of this LocalDate.
LocalDate addWrapFieldToCopy(int value)
Adds to this field, possibly wrapped, in a copy of this LocalDate.
DateTimeField getField()
Gets the field being used.
LocalDate getLocalDate()
Gets the LocalDate object linked to this property.
LocalDate roundCeilingCopy()
Rounds to the highest whole unit of this field on a copy of this LocalDate.
LocalDate roundFloorCopy()
Rounds to the lowest whole unit of this field on a copy of this LocalDate.
LocalDate roundHalfCeilingCopy()
Rounds to the nearest whole unit of this field on a copy of this LocalDate, favoring the ceiling if halfway.
LocalDate roundHalfEvenCopy()
Rounds to the nearest whole unit of this field on a copy of this LocalDate.
LocalDate roundHalfFloorCopy()
Rounds to the nearest whole unit of this field on a copy of this LocalDate, favoring the floor if halfway.
LocalDate setCopy(String text, Locale locale)
Sets this field in a copy of the LocalDate to a parsed text value.
LocalDate setCopy(int value)
Sets this field in a copy of the LocalDate.
LocalDate setCopy(String text)
Sets this field in a copy of the LocalDate to a parsed text value.
LocalDate withMaximumValue()
Returns a new LocalDate with this field set to the maximum value for this field.
LocalDate withMinimumValue()
Returns a new LocalDate 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 date that this property is linked to.
[Expand]
Inherited Methods
From class org.joda.time.field.AbstractReadableInstantFieldProperty
From class java.lang.Object

Public Methods

public LocalDate addToCopy (int value)

Adds to this field in a copy of this LocalDate.

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

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

public LocalDate addWrapFieldToCopy (int value)

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

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

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

public DateTimeField getField ()

Gets the field being used.

Returns
  • the field

public LocalDate getLocalDate ()

Gets the LocalDate object linked to this property.

Returns
  • the linked LocalDate

public LocalDate roundCeilingCopy ()

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

For example, rounding floor on the hourOfDay field of a LocalDate where the time is 10:30 would result in new LocalDate with the time of 11:00.

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

public LocalDate roundFloorCopy ()

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

For example, rounding floor on the hourOfDay field of a LocalDate where the time is 10:30 would result in new LocalDate with the time of 10:00.

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

public LocalDate roundHalfCeilingCopy ()

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

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

public LocalDate roundHalfEvenCopy ()

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

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

public LocalDate roundHalfFloorCopy ()

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

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

public LocalDate setCopy (String text, Locale locale)

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

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

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

public LocalDate setCopy (int value)

Sets this field in a copy of the LocalDate.

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

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

public LocalDate setCopy (String text)

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

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

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

public LocalDate withMaximumValue ()

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

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

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

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

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

public LocalDate withMinimumValue ()

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

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

Returns
  • a copy of the LocalDate 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 date that this property is linked to.

Returns
  • the milliseconds