public static class

Partial.Property

extends AbstractPartialFieldProperty
implements Serializable
java.lang.Object
   ↳ org.joda.time.field.AbstractPartialFieldProperty
     ↳ org.joda.time.Partial.Property

Class Overview

The property class for Partial.

This class binds a Partial to a DateTimeField.

Summary

Public Methods
Partial addToCopy(int valueToAdd)
Adds to the value of this field in a copy of this Partial.
Partial addWrapFieldToCopy(int valueToAdd)
Adds to the value of this field in a copy of this Partial wrapping within this field if the maximum value is reached.
int get()
Gets the value of this field.
DateTimeField getField()
Gets the field that this property uses.
Partial getPartial()
Gets the partial that this property belongs to.
Partial setCopy(String text, Locale locale)
Sets this field in a copy of the Partial to a parsed text value.
Partial setCopy(int value)
Sets this field in a copy of the Partial.
Partial setCopy(String text)
Sets this field in a copy of the Partial to a parsed text value.
Partial withMaximumValue()
Returns a new Partial with this field set to the maximum value for this field.
Partial withMinimumValue()
Returns a new Partial with this field set to the minimum value for this field.
Protected Methods
ReadablePartial getReadablePartial()
Gets the partial that this property belongs to.
[Expand]
Inherited Methods
From class org.joda.time.field.AbstractPartialFieldProperty
From class java.lang.Object

Public Methods

public Partial addToCopy (int valueToAdd)

Adds to the value of this field in a copy of this Partial.

The value will be added to this field. If the value is too large to be added solely to this field then it will affect larger fields. Smaller fields are unaffected.

If the result would be too large, beyond the maximum year, then an IllegalArgumentException is thrown.

The Partial attached to this property is unchanged by this call. Instead, a new instance is returned.

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

public Partial addWrapFieldToCopy (int valueToAdd)

Adds to the value of this field in a copy of this Partial wrapping within this field if the maximum value is reached.

The value will be added to this field. If the value is too large to be added solely to this field then it wraps within this field. Other fields are unaffected.

For example, 2004-12-20 addWrapField one month returns 2004-01-20.

The Partial attached to this property is unchanged by this call. Instead, a new instance is returned.

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

public int get ()

Gets the value of this field.

Returns
  • the field value

public DateTimeField getField ()

Gets the field that this property uses.

Returns
  • the field

public Partial getPartial ()

Gets the partial that this property belongs to.

Returns
  • the partial

public Partial setCopy (String text, Locale locale)

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

The Partial attached to this property is unchanged by this call. Instead, a new instance is returned.

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

public Partial setCopy (int value)

Sets this field in a copy of the Partial.

The Partial attached to this property is unchanged by this call. Instead, a new instance is returned.

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

public Partial setCopy (String text)

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

The Partial attached to this property is unchanged by this call. Instead, a new instance is returned.

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

public Partial withMaximumValue ()

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

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

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

public Partial withMinimumValue ()

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

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

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

Protected Methods

protected ReadablePartial getReadablePartial ()

Gets the partial that this property belongs to.

Returns
  • the partial