Months (ThreeTen date and time API)

java.lang.Object
- javax.time.period.field.PeriodField
- - javax.time.period.field.Months

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Months>
```
public final class Months
extends PeriodField
implements java.lang.Comparable<Months>, java.io.Serializable
```
A period representing a number of months.
Months is an immutable period that can only store months. It is a type-safe way of representing a number of months in an application.
Static factory methods allow you to construct instances. The number of months may be queried using getMonths(). Basic mathematical operations are provided - plus(), minus(), multipliedBy(), dividedBy() and negated(), all of which return a new instance
Months is immutable and thread-safe.

Author:

Stephen Colebourne

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static Months ZERO
A constant for zero months.

Fields
Modifier and Type	Field and Description
`static Months`	`ZERO` A constant for zero months.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(Months otherMonths)` Compares the number of months in this instance to another instance.
`Months`	`dividedBy(int divisor)` Returns a new instance with the months divided by the specified divisor.
`int`	`getAmount()` Gets the number of months held in this period.
`PeriodUnit`	`getUnit()` Gets the unit defining the amount of time.
`boolean`	`isGreaterThan(Months otherMonths)` Is the number of months in this instance greater than that in another instance.
`boolean`	`isLessThan(Months otherMonths)` Is the number of months in this instance less than that in another instance.
`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.
`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`	`of(int months)` Obtains an instance of `Months`.
`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.
`java.lang.String`	`toString()` Returns a string representation of the number of months.
`Months`	`withAmount(int amount)` Returns a new instance of the subclass with a different number of months.

Methods inherited from class javax.time.period.field.PeriodField
equals, hashCode, toPeriodFields

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ZERO
```
public static final Months ZERO
```
    A constant for zero months.
- Method Detail
  - of
```
public static Months of(int months)
```
    Obtains an instance of Months.
    
    Parameters:
    months - the number of months the instance will represent
    
    Returns:
    the created Months
  - getAmount
```
public int getAmount()
```
    Gets the number of months held in this period.
    
    Specified by:
    
    getAmount in class PeriodField
    
    Returns:
    the number of months
  - withAmount
```
public Months withAmount(int amount)
```
    Returns a new instance of the subclass with a different number of months.
    
    Specified by:
    
    withAmount in class PeriodField
    
    Parameters:
    amount - the number of months to set in the new instance, may be negative
    
    Returns:
    a new period element, never null
  - getUnit
```
public PeriodUnit getUnit()
```
    Gets the unit defining the amount of time.
    
    Specified by:
    
    getUnit in class PeriodField
    
    Returns:
    the months unit, never null
  - 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.
    
    Overrides:
    
    plus in class PeriodField
    
    Parameters:
    months - the amount of months to add, may be negative
    
    Returns:
    the new period plus the specified number of months
    
    Throws:
    
    java.lang.ArithmeticException - if the result overflows an int
  - 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.
    
    Parameters:
    months - the amount of months to add, may be negative, not null
    
    Returns:
    the new period plus the specified number of months
    
    Throws:
    
    java.lang.NullPointerException - if the months to add is null
    
    java.lang.ArithmeticException - if the result overflows an int
  - 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.
    
    Overrides:
    
    minus in class PeriodField
    
    Parameters:
    months - the amount of months to take away, may be negative
    
    Returns:
    the new period minus the specified number of months
    
    Throws:
    
    java.lang.ArithmeticException - if the result overflows an int
  - 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.
    
    Parameters:
    months - the amount of months to take away, may be negative, not null
    
    Returns:
    the new period minus the specified number of months
    
    Throws:
    
    java.lang.NullPointerException - if the months to add is null
    
    java.lang.ArithmeticException - if the result overflows an int
  - 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.
    
    Overrides:
    
    multipliedBy in class PeriodField
    
    Parameters:
    scalar - the amount to multiply by, may be negative
    
    Returns:
    the new period multiplied by the specified scalar
    
    Throws:
    
    java.lang.ArithmeticException - if the result overflows an int
  - 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.
    
    Overrides:
    
    dividedBy in class PeriodField
    
    Parameters:
    divisor - the amount to divide by, may be negative
    
    Returns:
    the new period divided by the specified divisor
    
    Throws:
    
    java.lang.ArithmeticException - if the divisor is zero
  - negated
```
public Months negated()
```
    Returns a new instance with the months value negated.
    
    Overrides:
    
    negated in class PeriodField
    
    Returns:
    the new period with a negated value
    
    Throws:
    
    java.lang.ArithmeticException - if the result overflows an int
  - compareTo
```
public int compareTo(Months otherMonths)
```
    Compares the number of months in this instance to another instance.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<Months>
    
    Parameters:
    otherMonths - the other number of months, not null
    
    Returns:
    the comparator value, negative if less, postive if greater
    
    Throws:
    
    java.lang.NullPointerException - if otherMonths is null
  - isGreaterThan
```
public boolean isGreaterThan(Months otherMonths)
```
    Is the number of months in this instance greater than that in another instance.
    
    Parameters:
    otherMonths - the other number of months, not null
    
    Returns:
    true if this number of months is greater
    
    Throws:
    
    java.lang.NullPointerException - if otherMonths is null
  - isLessThan
```
public boolean isLessThan(Months otherMonths)
```
    Is the number of months in this instance less than that in another instance.
    
    Parameters:
    otherMonths - the other number of months, not null
    
    Returns:
    true if this number of months is less
    
    Throws:
    
    java.lang.NullPointerException - if otherMonths is null
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of the number of months. This will be in the format 'PnM' where n is the number of months.
    
    Specified by:
    
    toString in class PeriodField
    
    Returns:
    the number of months in ISO8601 string format

Class Months

Field Summary

Method Summary

Methods inherited from class javax.time.period.field.PeriodField

Methods inherited from class java.lang.Object

Field Detail

ZERO

Method Detail

of

getAmount

withAmount

getUnit

plus

plus

minus

minus

multipliedBy

dividedBy

negated

compareTo

isGreaterThan

isLessThan

toString