org.joda.time
Class Months
- Comparable, ReadablePeriod, Serializable
public final class Months
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.
static Months | EIGHT - Constant representing eight months.
|
static Months | ELEVEN - Constant representing eleven months.
|
static Months | FIVE - Constant representing five months.
|
static Months | FOUR - Constant representing four months.
|
static Months | MAX_VALUE - Constant representing the maximum number of months that can be stored in this object.
|
static Months | MIN_VALUE - Constant representing the minimum number of months that can be stored in this object.
|
static Months | NINE - Constant representing nine months.
|
static Months | ONE - Constant representing one day.
|
static Months | SEVEN - Constant representing seven months.
|
static Months | SIX - Constant representing six months.
|
static Months | TEN - Constant representing ten months.
|
static Months | THREE - Constant representing three months.
|
static Months | TWELVE - Constant representing twelve months.
|
static Months | TWO - Constant representing two months.
|
static Months | ZERO - Constant representing zero months.
|
Months | dividedBy(int divisor) - Returns a new instance with the months divided by the specified divisor.
|
DurationFieldType | getFieldType() - Gets the duration field type, which is
months .
|
int | getMonths() - Gets the number of months that this period represents.
|
PeriodType | getPeriodType() - Gets the period type, which is
months .
|
boolean | isGreaterThan(Months other) - Is this months instance greater than the specified number of months.
|
boolean | isLessThan(Months other) - Is this months instance less than the specified number of months.
|
Months | minus(int months) - Returns a new instance with the specified number of months taken away.
|
Months | minus(Months months) - Returns a new instance with the specified number of months taken away.
|
static Months | months(int months) - Obtains an instance of
Months that may be cached.
|
static Months | monthsBetween(ReadableInstant start, ReadableInstant end) - Creates a
Months representing the number of whole months
between the two specified datetimes.
|
static Months | monthsBetween(ReadablePartial start, ReadablePartial end) - Creates a
Months representing the number of whole months
between the two specified partial datetimes.
|
static Months | monthsIn(ReadableInterval interval) - Creates a
Months representing the number of whole months
in the specified interval.
|
Months | multipliedBy(int scalar) - Returns a new instance with the months multiplied by the specified scalar.
|
Months | negated() - Returns a new instance with the months value negated.
|
static Months | parseMonths(String periodStr) - Creates a new
Months by parsing a string in the ISO8601 format 'PnM'.
|
Months | plus(int months) - Returns a new instance with the specified number of months added.
|
Months | plus(Months months) - Returns a new instance with the specified number of months added.
|
String | toString() - Gets this instance as a String in the ISO8601 duration format.
|
between , between , compareTo , equals , get , getFieldType , getFieldType , getPeriodType , getValue , getValue , hashCode , isSupported , setValue , size , standardPeriodIn , toMutablePeriod , toPeriod |
EIGHT
public static final Months EIGHT
Constant representing eight months.
ELEVEN
public static final Months ELEVEN
Constant representing eleven months.
FIVE
public static final Months FIVE
Constant representing five months.
FOUR
public static final Months FOUR
Constant representing four months.
MAX_VALUE
public static final Months MAX_VALUE
Constant representing the maximum number of months that can be stored in this object.
MIN_VALUE
public static final Months MIN_VALUE
Constant representing the minimum number of months that can be stored in this object.
NINE
public static final Months NINE
Constant representing nine months.
ONE
public static final Months ONE
Constant representing one day.
SEVEN
public static final Months SEVEN
Constant representing seven months.
SIX
public static final Months SIX
Constant representing six months.
TEN
public static final Months TEN
Constant representing ten months.
THREE
public static final Months THREE
Constant representing three months.
TWELVE
public static final Months TWELVE
Constant representing twelve months.
TWO
public static final Months TWO
Constant representing two months.
ZERO
public static final Months ZERO
Constant representing zero months.
dividedBy
public Months dividedBy(int divisor)
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.
divisor
- the amount to divide by, may be negative
- the new period divided by the specified divisor
getMonths
public int getMonths()
Gets the number of months that this period represents.
- the number of months in the period
isGreaterThan
public boolean isGreaterThan(Months other)
Is this months instance greater than the specified number of months.
other
- the other period, null means zero
- true if this months instance is greater than the specified one
isLessThan
public boolean isLessThan(Months other)
Is this months instance less than the specified number of months.
other
- the other period, null means zero
- true if this months instance is less than the specified one
minus
public Months minus(int months)
Returns a new instance with the specified number of months taken away.
This instance is immutable and unaffected by this method call.
months
- the amount of months to take away, may be negative
- the new period minus the specified number of months
minus
public Months minus(Months months)
Returns a new instance with the specified number of months taken away.
This instance is immutable and unaffected by this method call.
months
- the amount of months to take away, may be negative, null means zero
- the new period minus the specified number of months
months
public static Months months(int months)
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.
months
- the number of months to obtain an instance for
monthsBetween
public static Months monthsBetween(ReadableInstant start,
ReadableInstant end)
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.
start
- the start instant, must not be nullend
- the end instant, must not be null
monthsBetween
public static Months monthsBetween(ReadablePartial start,
ReadablePartial end)
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.
start
- the start partial date, must not be nullend
- the end partial date, must not be null
monthsIn
public static Months monthsIn(ReadableInterval interval)
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.
interval
- the interval to extract months from, null returns zero
multipliedBy
public Months multipliedBy(int scalar)
Returns a new instance with the months multiplied by the specified scalar.
This instance is immutable and unaffected by this method call.
scalar
- the amount to multiply by, may be negative
- the new period multiplied by the specified scalar
negated
public Months negated()
Returns a new instance with the months value negated.
- the new period with a negated value
parseMonths
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. If any other component is non-zero, an exception
will be thrown.
periodStr
- the period string, null returns zero
plus
public Months plus(int months)
Returns a new instance with the specified number of months added.
This instance is immutable and unaffected by this method call.
months
- the amount of months to add, may be negative
- the new period plus the specified number of months
plus
public Months plus(Months months)
Returns a new instance with the specified number of months added.
This instance is immutable and unaffected by this method call.
months
- the amount of months to add, may be negative, null means zero
- the new period plus the specified number of months
toString
public String toString()
Gets this instance as a String in the ISO8601 duration format.
For example, "P4M" represents 4 months.
- toString in interface ReadablePeriod
- the value as an ISO8601 string
Copyright (c) 2001-2006 - Joda.org