 java.lang.Object

 org.threeten.extra.Months

 All Implemented Interfaces:
Serializable
,Comparable<Months>
,TemporalAmount
public final class Months extends Object implements TemporalAmount, Comparable<Months>, Serializable
A monthbased amount of time, such as '12 months'.This class models a quantity or amount of time in terms of months. It is a typesafe way of representing a number of months in an application.
The model is of a directed amount, meaning that the amount may be negative.
Implementation Requirements:
This class is immutable and threadsafe.This class must be treated as a value type. Do not synchronize, rely on the identity hash code or use the distinction between equals() and ==.
 See Also:
 Serialized Form


Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Months
abs()
Returns a copy of this duration with a positive length.Temporal
addTo(Temporal temporal)
Adds this amount to the specified temporal object.static Months
between(Temporal startDateInclusive, Temporal endDateExclusive)
Obtains aMonths
consisting of the number of months between two dates.int
compareTo(Months otherAmount)
Compares this amount to the specifiedMonths
.Months
dividedBy(int divisor)
Returns an instance with the amount divided by the specified divisor.boolean
equals(Object otherAmount)
Checks if this amount is equal to the specifiedMonths
.static Months
from(TemporalAmount amount)
Obtains an instance ofMonths
from a temporal amount.long
get(TemporalUnit unit)
Gets the value of the requested unit.int
getAmount()
Gets the number of months in this amount.List<TemporalUnit>
getUnits()
Gets the set of units supported by this amount.int
hashCode()
A hash code for this amount.boolean
isNegative()
Checks if the amount is negative.boolean
isPositive()
Checks if the amount is positive.boolean
isZero()
Checks if the amount is zero.Months
minus(int months)
Returns a copy of this amount with the specified number of months subtracted.Months
minus(TemporalAmount amountToSubtract)
Returns a copy of this amount with the specified amount subtracted.Months
multipliedBy(int scalar)
Returns an instance with the amount multiplied by the specified scalar.Months
negated()
Returns an instance with the amount negated.static Months
of(int months)
Obtains aMonths
representing a number of months.static Months
ofYears(int years)
Obtains aMonths
representing the number of months equivalent to a number of years.static Months
parse(CharSequence text)
Obtains aMonths
from a text string such asPnM
.Months
plus(int months)
Returns a copy of this amount with the specified number of months added.Months
plus(TemporalAmount amountToAdd)
Returns a copy of this amount with the specified amount added.Temporal
subtractFrom(Temporal temporal)
Subtracts this amount from the specified temporal object.Period
toPeriod()
Gets the number of months as aPeriod
.String
toString()
Returns a string representation of the number of months.



Method Detail

of
public static Months of(int months)
Obtains aMonths
representing a number of months.The resulting amount will have the specified months.
 Parameters:
months
 the number of months, positive or negative Returns:
 the number of months, not null

ofYears
public static Months ofYears(int years)
Obtains aMonths
representing the number of months equivalent to a number of years.The resulting amount will be monthbased, with the number of months equal to the number of years multiplied by 12.
 Parameters:
years
 the number of years, positive or negative Returns:
 the amount with the input years converted to months, not null
 Throws:
ArithmeticException
 if numeric overflow occurs

from
public static Months from(TemporalAmount amount)
Obtains an instance ofMonths
from a temporal amount.This obtains an instance based on the specified amount. A
TemporalAmount
represents an amount of time, which may be datebased or timebased, which this factory extracts to aMonths
.The result is calculated by looping around each unit in the specified amount. Each amount is converted to months using
Temporals.convertAmount(long, java.time.temporal.TemporalUnit, java.time.temporal.TemporalUnit)
. If the conversion yields a remainder, an exception is thrown. If the amount is zero, the unit is ignored. Parameters:
amount
 the temporal amount to convert, not null Returns:
 the equivalent amount, not null
 Throws:
DateTimeException
 if unable to convert to aMonths
ArithmeticException
 if numeric overflow occurs

parse
public static Months parse(CharSequence text)
Obtains aMonths
from a text string such asPnM
.This will parse the string produced by
toString()
which is based on the ISO8601 period formatPnYnM
.The string starts with an optional sign, denoted by the ASCII negative or positive symbol. If negative, the whole amount is negated. The ASCII letter "P" is next in upper or lower case. There are then two sections, each consisting of a number and a suffix. At least one of the two sections must be present. The sections have suffixes in ASCII of "Y" and "M" for years and months, accepted in upper or lower case. The suffixes must occur in order. The number part of each section must consist of ASCII digits. The number may be prefixed by the ASCII negative or positive symbol. The number must parse to an
int
.The leading plus/minus sign, and negative values for years and months are not part of the ISO8601 standard.
For example, the following are valid inputs:
"P2M"  Months.of(2) "P2M"  Months.of(2) "P2M"  Months.of(2) "P2M"  Months.of(2) "P3Y"  Months.of(3 * 12) "P3Y2M"  Months.of(3 * 12  2)
 Parameters:
text
 the text to parse, not null Returns:
 the parsed period, not null
 Throws:
DateTimeParseException
 if the text cannot be parsed to a period

between
public static Months between(Temporal startDateInclusive, Temporal endDateExclusive)
Obtains aMonths
consisting of the number of months between two dates.The start date is included, but the end date is not. The result of this method can be negative if the end is before the start.
 Parameters:
startDateInclusive
 the start date, inclusive, not nullendDateExclusive
 the end date, exclusive, not null Returns:
 the number of months between this date and the end date, not null

get
public long get(TemporalUnit unit)
Gets the value of the requested unit.This returns a value for the supported unit 
MONTHS
. All other units throw an exception. Specified by:
get
in interfaceTemporalAmount
 Parameters:
unit
 theTemporalUnit
for which to return the value Returns:
 the long value of the unit
 Throws:
UnsupportedTemporalTypeException
 if the unit is not supported

getUnits
public List<TemporalUnit> getUnits()
Gets the set of units supported by this amount.The single supported unit is
MONTHS
.This set can be used in conjunction with
get(TemporalUnit)
to access the entire state of the amount. Specified by:
getUnits
in interfaceTemporalAmount
 Returns:
 a list containing the months unit, not null

getAmount
public int getAmount()
Gets the number of months in this amount. Returns:
 the number of months

isNegative
public boolean isNegative()
Checks if the amount is negative. Returns:
 true if the amount is negative, false if the amount is zero or positive

isZero
public boolean isZero()
Checks if the amount is zero. Returns:
 true if the amount is zero, false if not

isPositive
public boolean isPositive()
Checks if the amount is positive. Returns:
 true if the amount is positive, false if the amount is zero or negative

plus
public Months plus(TemporalAmount amountToAdd)
Returns a copy of this amount with the specified amount added.The parameter is converted using
from(TemporalAmount)
.This instance is immutable and unaffected by this method call.
 Parameters:
amountToAdd
 the amount to add, not null Returns:
 a
Months
based on this instance with the requested amount added, not null  Throws:
DateTimeException
 if the specified amount contains an invalid unitArithmeticException
 if numeric overflow occurs

plus
public Months plus(int months)
Returns a copy of this amount 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 Returns:
 a
Months
based on this instance with the requested amount added, not null  Throws:
ArithmeticException
 if the result overflows an int

minus
public Months minus(TemporalAmount amountToSubtract)
Returns a copy of this amount with the specified amount subtracted.The parameter is converted using
from(TemporalAmount)
.This instance is immutable and unaffected by this method call.
 Parameters:
amountToSubtract
 the amount to subtract, not null Returns:
 a
Months
based on this instance with the requested amount subtracted, not null  Throws:
DateTimeException
 if the specified amount contains an invalid unitArithmeticException
 if numeric overflow occurs

minus
public Months minus(int months)
Returns a copy of this amount with the specified number of months subtracted.This instance is immutable and unaffected by this method call.
 Parameters:
months
 the amount of months to add, may be negative Returns:
 a
Months
based on this instance with the requested amount subtracted, not null  Throws:
ArithmeticException
 if the result overflows an int

multipliedBy
public Months multipliedBy(int scalar)
Returns an instance with the amount multiplied by the specified scalar.This instance is immutable and unaffected by this method call.
 Parameters:
scalar
 the scalar to multiply by, not null Returns:
 the amount multiplied by the specified scalar, not null
 Throws:
ArithmeticException
 if numeric overflow occurs

dividedBy
public Months dividedBy(int divisor)
Returns an instance with the amount 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 Returns:
 the amount divided by the specified divisor, not null
 Throws:
ArithmeticException
 if the divisor is zero

negated
public Months negated()
Returns an instance with the amount negated.This instance is immutable and unaffected by this method call.
 Returns:
 the negated amount, not null
 Throws:
ArithmeticException
 if numeric overflow occurs, which only happens if the amount isLong.MIN_VALUE

abs
public Months abs()
Returns a copy of this duration with a positive length.This method returns a positive duration by effectively removing the sign from any negative total length.
This instance is immutable and unaffected by this method call.
 Returns:
 the absolute amount, not null
 Throws:
ArithmeticException
 if numeric overflow occurs, which only happens if the amount isLong.MIN_VALUE

toPeriod
public Period toPeriod()
Gets the number of months as aPeriod
.This returns a period with the same number of months.
 Returns:
 the equivalent period, not null

addTo
public Temporal addTo(Temporal temporal)
Adds this amount to the specified temporal object.This returns a temporal object of the same observable type as the input with this amount added.
In most cases, it is clearer to reverse the calling pattern by using
Temporal.plus(TemporalAmount)
.// these two lines are equivalent, but the second approach is recommended dateTime = thisAmount.addTo(dateTime); dateTime = dateTime.plus(thisAmount);
Only nonzero amounts will be added.
This instance is immutable and unaffected by this method call.
 Specified by:
addTo
in interfaceTemporalAmount
 Parameters:
temporal
 the temporal object to adjust, not null Returns:
 an object of the same type with the adjustment made, not null
 Throws:
DateTimeException
 if unable to addUnsupportedTemporalTypeException
 if the MONTHS unit is not supportedArithmeticException
 if numeric overflow occurs

subtractFrom
public Temporal subtractFrom(Temporal temporal)
Subtracts this amount from the specified temporal object.This returns a temporal object of the same observable type as the input with this amount subtracted.
In most cases, it is clearer to reverse the calling pattern by using
Temporal.minus(TemporalAmount)
.// these two lines are equivalent, but the second approach is recommended dateTime = thisAmount.subtractFrom(dateTime); dateTime = dateTime.minus(thisAmount);
Only nonzero amounts will be subtracted.
This instance is immutable and unaffected by this method call.
 Specified by:
subtractFrom
in interfaceTemporalAmount
 Parameters:
temporal
 the temporal object to adjust, not null Returns:
 an object of the same type with the adjustment made, not null
 Throws:
DateTimeException
 if unable to subtractUnsupportedTemporalTypeException
 if the MONTHS unit is not supportedArithmeticException
 if numeric overflow occurs

compareTo
public int compareTo(Months otherAmount)
Compares this amount to the specifiedMonths
.The comparison is based on the total length of the amounts. It is "consistent with equals", as defined by
Comparable
. Specified by:
compareTo
in interfaceComparable<Months>
 Parameters:
otherAmount
 the other amount, not null Returns:
 the comparator value, negative if less, positive if greater

equals
public boolean equals(Object otherAmount)
Checks if this amount is equal to the specifiedMonths
.The comparison is based on the total length of the durations.

hashCode
public int hashCode()
A hash code for this amount.

