Class YearMonthDay.Property
- All Implemented Interfaces:
Serializable
- Enclosing class:
YearMonthDay
YearMonthDay
.
This class binds a YearMonthDay
to a DateTimeField
.
- Since:
- 1.0
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionaddToCopy
(int valueToAdd) Deprecated.Adds to the value of this field in a copy of this YearMonthDay.addWrapFieldToCopy
(int valueToAdd) Deprecated.Adds to the value of this field in a copy of this YearMonthDay wrapping within this field if the maximum value is reached.int
get()
Deprecated.Gets the value of this field.getField()
Deprecated.Gets the field that this property uses.Deprecated.Gets the partial that this property belongs to.setCopy
(int value) Deprecated.Sets this field in a copy of the YearMonthDay.Deprecated.Sets this field in a copy of the YearMonthDay to a parsed text value.Deprecated.Sets this field in a copy of the YearMonthDay to a parsed text value.Deprecated.Returns a new YearMonthDay with this field set to the maximum value for this field.Deprecated.Returns a new YearMonthDay with this field set to the minimum value for this field.Methods inherited from class org.joda.time.field.AbstractPartialFieldProperty
compareTo, compareTo, equals, getAsShortText, getAsShortText, getAsString, getAsText, getAsText, getDurationField, getFieldType, getMaximumShortTextLength, getMaximumTextLength, getMaximumValue, getMaximumValueOverall, getMinimumValue, getMinimumValueOverall, getName, getRangeDurationField, hashCode, toString
-
Method Details
-
getField
Deprecated.Gets the field that this property uses.- Specified by:
getField
in classAbstractPartialFieldProperty
- Returns:
- the field
-
getYearMonthDay
Deprecated.Gets the partial that this property belongs to.- Returns:
- the partial
-
get
public int get()Deprecated.Gets the value of this field.- Specified by:
get
in classAbstractPartialFieldProperty
- Returns:
- the field value
-
addToCopy
Deprecated.Adds to the value of this field in a copy of this YearMonthDay.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 YearMonthDay 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 YearMonthDay with the field value changed
- Throws:
IllegalArgumentException
- if the value isn't valid
-
addWrapFieldToCopy
Deprecated.Adds to the value of this field in a copy of this YearMonthDay 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 returns2004-01-20
.The YearMonthDay 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 YearMonthDay with the field value changed
- Throws:
IllegalArgumentException
- if the value isn't valid
-
setCopy
Deprecated.Sets this field in a copy of the YearMonthDay.The YearMonthDay 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 YearMonthDay with the field value changed
- Throws:
IllegalArgumentException
- if the value isn't valid
-
setCopy
Deprecated.Sets this field in a copy of the YearMonthDay to a parsed text value.The YearMonthDay attached to this property is unchanged by this call. Instead, a new instance is returned.
- Parameters:
text
- the text value to setlocale
- optional locale to use for selecting a text symbol- Returns:
- a copy of the YearMonthDay with the field value changed
- Throws:
IllegalArgumentException
- if the text value isn't valid
-
setCopy
Deprecated.Sets this field in a copy of the YearMonthDay to a parsed text value.The YearMonthDay 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 YearMonthDay with the field value changed
- Throws:
IllegalArgumentException
- if the text value isn't valid
-
withMaximumValue
Deprecated.Returns a new YearMonthDay 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.
YearMonthDay lastDayOfMonth = dt.dayOfMonth().withMaximumValue();
The YearMonthDay attached to this property is unchanged by this call.
- Returns:
- a copy of the YearMonthDay with this field set to its maximum
- Since:
- 1.2
-
withMinimumValue
Deprecated.Returns a new YearMonthDay with this field set to the minimum value for this field.The YearMonthDay attached to this property is unchanged by this call.
- Returns:
- a copy of the YearMonthDay with this field set to its minimum
- Since:
- 1.2
-