Package org.joda.time

Class YearMonth.Property

  • All Implemented Interfaces:
    java.io.Serializable
    Enclosing class:
    YearMonth

    public static class YearMonth.Property
    extends AbstractPartialFieldProperty
    implements java.io.Serializable
    The property class for YearMonth.

    This class binds a YearMonth to a DateTimeField.

    Since:
    2.0
    See Also:
    Serialized Form
    • Method Detail

      • getYearMonth

        public YearMonth getYearMonth()
        Gets the partial that this property belongs to.
        Returns:
        the partial
      • addToCopy

        public YearMonth addToCopy​(int valueToAdd)
        Adds to the value of this field in a copy of this YearMonth.

        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 YearMonth 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 YearMonth with the field value changed
        Throws:
        java.lang.IllegalArgumentException - if the value isn't valid
      • addWrapFieldToCopy

        public YearMonth addWrapFieldToCopy​(int valueToAdd)
        Adds to the value of this field in a copy of this YearMonth 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 addWrapField one month returns 2004-01.

        The YearMonth 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 YearMonth with the field value changed
        Throws:
        java.lang.IllegalArgumentException - if the value isn't valid
      • setCopy

        public YearMonth setCopy​(int value)
        Sets this field in a copy of the YearMonth.

        The YearMonth 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 YearMonth with the field value changed
        Throws:
        java.lang.IllegalArgumentException - if the value isn't valid
      • setCopy

        public YearMonth setCopy​(java.lang.String text,
                                 java.util.Locale locale)
        Sets this field in a copy of the YearMonth to a parsed text value.

        The YearMonth 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 YearMonth with the field value changed
        Throws:
        java.lang.IllegalArgumentException - if the text value isn't valid
      • setCopy

        public YearMonth setCopy​(java.lang.String text)
        Sets this field in a copy of the YearMonth to a parsed text value.

        The YearMonth 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 YearMonth with the field value changed
        Throws:
        java.lang.IllegalArgumentException - if the text value isn't valid