Package org.joda.time.chrono

Class BasicMonthOfYearDateTimeField

  • Direct Known Subclasses:
    GJMonthOfYearDateTimeField
    class BasicMonthOfYearDateTimeField
extends ImpreciseDateTimeField
    Provides time calculations for the month of the year component of time.
    Since:
    1.2, refactored from GJMonthOfYearDateTimeField

    • Field Detail

      • serialVersionUID

        private static final long serialVersionUID
        Serialization version
        See Also:
        Constant Field Values

      • iMax

        private final int iMax

      • iLeapMonth

        private final int iLeapMonth

    • Constructor Detail

      • BasicMonthOfYearDateTimeField

        BasicMonthOfYearDateTimeField​(BasicChronology chronology,
                              int leapMonth)
        Restricted constructor.
        Parameters:
        leapMonth - the month of year that leaps

    • Method Detail

      • isLenient

        public boolean isLenient()
        Description copied from class: DateTimeField
        Returns true if the set method is lenient. If so, it accepts values that are out of bounds. For example, a lenient day of month field accepts 32 for January, converting it to February 1.
        Specified by:
        isLenient in class DateTimeField
        Returns:
        true if this field is lenient

      • add

        public long add​(long instant,
                int months)
        Add the specified month to the specified time instant. The amount added may be negative.

        If the new month has less total days than the specified day of the month, this value is coerced to the nearest sane value. e.g.

        07-31 - (1 month) = 06-30

        03-31 - (1 month) = 02-28 or 02-29 depending

        Specified by:
        add in class ImpreciseDateTimeField
        Parameters:
        instant - the time instant in millis to update.
        months - the months to add (can be negative).
        Returns:
        the updated time instant.
        See Also:
        DateTimeField.add(long, int), ReadWritableDateTime.addMonths(int)

      • add

        public long add​(long instant,
                long months)
        Description copied from class: BaseDateTimeField
        Adds a value (which may be negative) to the instant value, overflowing into larger fields if necessary.
        Specified by:
        add in class ImpreciseDateTimeField
        Parameters:
        instant - the milliseconds from 1970-01-01T00:00:00Z to add to
        months - the long value to add, in the units of the field
        Returns:
        the updated milliseconds
        See Also:
        BaseDateTimeField.add(long,int)

      • add

        public int[] add​(ReadablePartial partial,
                 int fieldIndex,
                 int[] values,
                 int valueToAdd)
        Description copied from class: BaseDateTimeField
        Adds a value (which may be negative) to the partial instant, throwing an exception if the maximum size of the instant is reached.

        The value will be added to this field, overflowing into larger fields if necessary. Smaller fields should be unaffected, except where the result would be an invalid value for a smaller field. In this case the smaller field is adjusted to be in range.

        Partial instants only contain some fields. This may result in a maximum possible value, such as TimeOfDay being limited to 23:59:59:999. If this limit is breached by the add an exception is thrown.

        For example, in the ISO chronology:
        2000-08-20 add six months is 2000-02-20
        2000-08-20 add twenty months is 2000-04-20
        2000-08-20 add minus nine months is 2000-11-20
        2001-01-31 add one month is 2001-02-28
        2001-01-31 add two months is 2001-03-31

        Overrides:
        add in class BaseDateTimeField
        Parameters:
        partial - the partial instant
        fieldIndex - the index of this field in the partial
        values - the values of the partial instant which should be updated
        valueToAdd - the value to add, in the units of the field
        Returns:
        the passed in values

      • addWrapField

        public long addWrapField​(long instant,
                         int months)
        Add to the Month component of the specified time instant wrapping around within that component if necessary.
        Overrides:
        addWrapField in class BaseDateTimeField
        Parameters:
        instant - the time instant in millis to update.
        months - the months to add (can be negative).
        Returns:
        the updated time instant.
        See Also:
        DateTimeField.addWrapField(long, int)

      • getDifferenceAsLong

        public long getDifferenceAsLong​(long minuendInstant,
                                long subtrahendInstant)
        Description copied from class: ImpreciseDateTimeField
        Computes the difference between two instants, as measured in the units of this field. Any fractional units are dropped from the result. Calling getDifference reverses the effect of calling add. In the following code: 
         long instant = ...
 long v = ...
 long age = getDifferenceAsLong(add(instant, v), instant);
        The value 'age' is the same as the value 'v'.

        The default implementation performs a guess-and-check algorithm using getDurationField().getUnitMillis() and the add() method. Subclasses are encouraged to provide a more efficient implementation.

        Overrides:
        getDifferenceAsLong in class ImpreciseDateTimeField
        Parameters:
        minuendInstant - the milliseconds from 1970-01-01T00:00:00Z to subtract from
        subtrahendInstant - the milliseconds from 1970-01-01T00:00:00Z to subtract off the minuend
        Returns:
        the difference in the units of this field

      • set

        public long set​(long instant,
                int month)
        Set the Month component of the specified time instant.

        If the new month has less total days than the specified day of the month, this value is coerced to the nearest sane value. e.g.

        07-31 to month 6 = 06-30

        03-31 to month 2 = 02-28 or 02-29 depending

        Specified by:
        set in class ImpreciseDateTimeField
        Parameters:
        instant - the time instant in millis to update.
        month - the month (1,12) to update the time to.
        Returns:
        the updated time instant.
        Throws:
        java.lang.IllegalArgumentException - if month is invalid

      • getRangeDurationField

        public DurationField getRangeDurationField()
        Description copied from class: BaseDateTimeField
        Returns the range duration of this field. For example, if this field represents "hour of day", then the range duration is a day.
        Specified by:
        getRangeDurationField in class ImpreciseDateTimeField
        Returns:
        the range duration of this field, or null if field has no range

      • isLeap

        public boolean isLeap​(long instant)
        Description copied from class: BaseDateTimeField
        Returns whether this field is 'leap' for the specified instant.

        For example, a leap year would return true, a non leap year would return false.

        This implementation returns false.

        Overrides:
        isLeap in class BaseDateTimeField
        Parameters:
        instant - the instant to check for leap status
        Returns:
        true if the field is 'leap'

      • getLeapAmount

        public int getLeapAmount​(long instant)
        Description copied from class: BaseDateTimeField
        Gets the amount by which this field is 'leap' for the specified instant.

        For example, a leap year would return one, a non leap year would return zero.

        This implementation returns zero.

        Overrides:
        getLeapAmount in class BaseDateTimeField
        Parameters:
        instant - the instant to check for leap status
        Returns:
        the amount, in units of the leap duration field, that the field is leap

      • getLeapDurationField

        public DurationField getLeapDurationField()
        Description copied from class: BaseDateTimeField
        If this field were to leap, then it would be in units described by the returned duration. If this field doesn't ever leap, null is returned.

        This implementation returns null.

        Overrides:
        getLeapDurationField in class BaseDateTimeField
        Returns:
        the leap duration field if field can be leap, null if it can't

      • getMinimumValue

        public int getMinimumValue()
        Description copied from class: BaseDateTimeField
        Get the minimum allowable value for this field.
        Specified by:
        getMinimumValue in class BaseDateTimeField
        Returns:
        the minimum valid value for this field, in the units of the field

      • getMaximumValue

        public int getMaximumValue()
        Description copied from class: BaseDateTimeField
        Get the maximum allowable value for this field.
        Specified by:
        getMaximumValue in class BaseDateTimeField
        Returns:
        the maximum valid value for this field, in the units of the field

      • roundFloor

        public long roundFloor​(long instant)
        Description copied from class: BaseDateTimeField
        Round to the lowest whole unit of this field. After rounding, the value of this field and all fields of a higher magnitude are retained. The fractional millis that cannot be expressed in whole increments of this field are set to minimum.

        For example, a datetime of 2002-11-02T23:34:56.789, rounded to the lowest whole hour is 2002-11-02T23:00:00.000.

        Specified by:
        roundFloor in class ImpreciseDateTimeField
        Parameters:
        instant - the milliseconds from 1970-01-01T00:00:00Z to round
        Returns:
        rounded milliseconds

      • remainder

        public long remainder​(long instant)
        Description copied from class: BaseDateTimeField
        Returns the fractional duration milliseconds of this field. In other words, calling remainder returns the duration that roundFloor would subtract.

        For example, on a datetime of 2002-11-02T23:34:56.789, the remainder by hour is 34 minutes and 56.789 seconds.

        The default implementation computes instant - roundFloor(instant). Subclasses are encouraged to provide a more efficient implementation.

        Overrides:
        remainder in class BaseDateTimeField
        Parameters:
        instant - the milliseconds from 1970-01-01T00:00:00Z to get the remainder
        Returns:
        remainder duration, in milliseconds

      • readResolve

        private java.lang.Object readResolve()
        Serialization singleton