| java.lang.Object
 org.joda.time.base.BaseSingleFieldPeriod
org.joda.time.Months
| Months | | final public class Months extends BaseSingleFieldPeriod (Code) | | An immutable time period representing a number of months.
Months is an immutable period that can only store months.
It does not store years, days or hours for example. As such it is a
type-safe way of representing a number of months in an application.
The number of months is set in the constructor, and may be queried using
getMonths(). Basic mathematical operations are provided -
plus(), minus(), multipliedBy() and
dividedBy().
Months is thread-safe and immutable.
author:
Stephen Colebourne
since:
1.4 |
| Field Summary | |
| final public static Months | EIGHT
Constant representing eight months. | | final public static Months | ELEVEN
Constant representing eleven months. | | final public static Months | FIVE
Constant representing five months. | | final public static Months | FOUR
Constant representing four months. | | final public static Months | MAX_VALUE
Constant representing the maximum number of months that can be stored in this object. | | final public static Months | MIN_VALUE
Constant representing the minimum number of months that can be stored in this object. | | final public static Months | NINE
Constant representing nine months. | | final public static Months | ONE
Constant representing one day. | | final public static Months | SEVEN
Constant representing seven months. | | final public static Months | SIX
Constant representing six months. | | final public static Months | TEN
Constant representing ten months. | | final public static Months | THREE
Constant representing three months. | | final public static Months | TWELVE
Constant representing twelve months. | | final public static Months | TWO
Constant representing two months. | | final public static Months | ZERO
Constant representing zero months. |
| Method Summary | |
| public Months | dividedBy(int divisor)
Returns a new instance with the months divided by the specified divisor. | | public DurationFieldType | getFieldType()
Gets the duration field type, which is months. | | public int | getMonths()
Gets the number of months that this period represents. | | public PeriodType | getPeriodType()
Gets the period type, which is months. | | public boolean | isGreaterThan(Months other)
Is this months instance greater than the specified number of months. | | public boolean | isLessThan(Months other)
Is this months instance less than the specified number of months. | | public Months | minus(int months)
Returns a new instance with the specified number of months taken away. | | public Months | minus(Months months)
Returns a new instance with the specified number of months taken away. | | public static Months | months(int months)
Obtains an instance of Months that may be cached. | | public static Months | monthsBetween(ReadableInstant start, ReadableInstant end)
Creates a Months representing the number of whole months
between the two specified datetimes. | | public static Months | monthsBetween(ReadablePartial start, ReadablePartial end)
Creates a Months representing the number of whole months
between the two specified partial datetimes. | | public static Months | monthsIn(ReadableInterval interval)
Creates a Months representing the number of whole months
in the specified interval. | | public Months | multipliedBy(int scalar)
Returns a new instance with the months multiplied by the specified scalar. | | public Months | negated()
Returns a new instance with the months value negated. | | public static Months | parseMonths(String periodStr)
Creates a new Months by parsing a string in the ISO8601 format 'PnM'.
The parse will accept the full ISO syntax of PnYnMnWnDTnHnMnS however only the
months component may be non-zero. | | public Months | plus(int months)
Returns a new instance with the specified number of months added. | | public Months | plus(Months months)
Returns a new instance with the specified number of months added. | | public String | toString()
Gets this instance as a String in the ISO8601 duration format. |
| EIGHT | | final public static Months EIGHT(Code) | | Constant representing eight months.
|
| ELEVEN | | final public static Months ELEVEN(Code) | | Constant representing eleven months.
|
| FIVE | | final public static Months FIVE(Code) | | Constant representing five months.
|
| FOUR | | final public static Months FOUR(Code) | | Constant representing four months.
|
| MAX_VALUE | | final public static Months MAX_VALUE(Code) | | Constant representing the maximum number of months that can be stored in this object.
|
| MIN_VALUE | | final public static Months MIN_VALUE(Code) | | Constant representing the minimum number of months that can be stored in this object.
|
| NINE | | final public static Months NINE(Code) | | Constant representing nine months.
|
| ONE | | final public static Months ONE(Code) | | Constant representing one day.
|
| SEVEN | | final public static Months SEVEN(Code) | | Constant representing seven months.
|
| SIX | | final public static Months SIX(Code) | | Constant representing six months.
|
| TEN | | final public static Months TEN(Code) | | Constant representing ten months.
|
| THREE | | final public static Months THREE(Code) | | Constant representing three months.
|
| TWELVE | | final public static Months TWELVE(Code) | | Constant representing twelve months.
|
| TWO | | final public static Months TWO(Code) | | Constant representing two months.
|
| ZERO | | final public static Months ZERO(Code) | | Constant representing zero months.
|
| dividedBy | | public Months dividedBy(int divisor)(Code) | | Returns a new instance with the months divided by the specified divisor.
The calculation uses integer division, thus 3 divided by 2 is 1.
This instance is immutable and unaffected by this method call.
Parameters:
divisor - the amount to divide by, may be negative the new period divided by the specified divisor
throws:
ArithmeticException - if the divisor is zero |
| getFieldType | | public DurationFieldType getFieldType()(Code) | | Gets the duration field type, which is months.
the period type |
| getMonths | | public int getMonths()(Code) | | Gets the number of months that this period represents.
the number of months in the period |
| getPeriodType | | public PeriodType getPeriodType()(Code) | | Gets the period type, which is months.
the period type |
| isGreaterThan | | public boolean isGreaterThan(Months other)(Code) | | Is this months instance greater than the specified number of months.
Parameters:
other - the other period, null means zero true if this months instance is greater than the specified one |
| isLessThan | | public boolean isLessThan(Months other)(Code) | | Is this months instance less than the specified number of months.
Parameters:
other - the other period, null means zero true if this months instance is less than the specified one |
| minus | | public Months minus(int months)(Code) | | Returns a new instance with the specified number of months taken away.
This instance is immutable and unaffected by this method call.
Parameters:
months - the amount of months to take away, may be negative the new period minus the specified number of months
throws:
ArithmeticException - if the result overflows an int |
| minus | | public Months minus(Months months)(Code) | | Returns a new instance with the specified number of months taken away.
This instance is immutable and unaffected by this method call.
Parameters:
months - the amount of months to take away, may be negative, null means zero the new period minus the specified number of months
throws:
ArithmeticException - if the result overflows an int |
| months | | public static Months months(int months)(Code) | | Obtains an instance of Months that may be cached.
Months is immutable, so instances can be cached and shared.
This factory method provides access to shared instances.
Parameters:
months - the number of months to obtain an instance for the instance of Months |
| monthsBetween | | public static Months monthsBetween(ReadableInstant start, ReadableInstant end)(Code) | | Creates a Months representing the number of whole months
between the two specified datetimes. This method corectly handles
any daylight savings time changes that may occur during the interval.
Parameters:
start - the start instant, must not be null
Parameters:
end - the end instant, must not be null the period in months
throws:
IllegalArgumentException - if the instants are null or invalid |
| monthsBetween | | public static Months monthsBetween(ReadablePartial start, ReadablePartial end)(Code) | | Creates a Months representing the number of whole months
between the two specified partial datetimes.
The two partials must contain the same fields, for example you can specify
two LocalDate objects.
Parameters:
start - the start partial date, must not be null
Parameters:
end - the end partial date, must not be null the period in months
throws:
IllegalArgumentException - if the partials are null or invalid |
| monthsIn | | public static Months monthsIn(ReadableInterval interval)(Code) | | Creates a Months representing the number of whole months
in the specified interval. This method corectly handles any daylight
savings time changes that may occur during the interval.
Parameters:
interval - the interval to extract months from, null returns zero the period in months
throws:
IllegalArgumentException - if the partials are null or invalid |
| multipliedBy | | public Months multipliedBy(int scalar)(Code) | | Returns a new instance with the months multiplied by the specified scalar.
This instance is immutable and unaffected by this method call.
Parameters:
scalar - the amount to multiply by, may be negative the new period multiplied by the specified scalar
throws:
ArithmeticException - if the result overflows an int |
| negated | | public Months negated()(Code) | | Returns a new instance with the months value negated.
the new period with a negated value
throws:
ArithmeticException - if the result overflows an int |
| parseMonths | | public static Months parseMonths(String periodStr)(Code) | | Creates a new Months by parsing a string in the ISO8601 format 'PnM'.
The parse will accept the full ISO syntax of PnYnMnWnDTnHnMnS however only the
months component may be non-zero. If any other component is non-zero, an exception
will be thrown.
Parameters:
periodStr - the period string, null returns zero the period in months
throws:
IllegalArgumentException - if the string format is invalid |
| plus | | public Months plus(int months)(Code) | | Returns a new instance with the specified number of months added.
This instance is immutable and unaffected by this method call.
Parameters:
months - the amount of months to add, may be negative the new period plus the specified number of months
throws:
ArithmeticException - if the result overflows an int |
| plus | | public Months plus(Months months)(Code) | | Returns a new instance with the specified number of months added.
This instance is immutable and unaffected by this method call.
Parameters:
months - the amount of months to add, may be negative, null means zero the new period plus the specified number of months
throws:
ArithmeticException - if the result overflows an int |
| toString | | public String toString()(Code) | | Gets this instance as a String in the ISO8601 duration format.
For example, "P4M" represents 4 months.
the value as an ISO8601 string |
|
|