Added in API level 26

Month

class Month : TemporalAccessor, TemporalAdjuster

kotlin.Any
↳	kotlin.Enum<java.time.Month>
	↳	java.time.Month

Known Direct Subclasses

Month.APRIL, Month.AUGUST, Month.DECEMBER, Month.FEBRUARY, Month.JANUARY, Month.JULY, Month.JUNE, Month.MARCH, Month.MAY, Month.NOVEMBER, Month.OCTOBER, Month.SEPTEMBER

Month.APRIL	The singleton instance for the month of April with 30 days.
Month.AUGUST	The singleton instance for the month of August with 31 days.
Month.DECEMBER	The singleton instance for the month of December with 31 days.
Month.FEBRUARY	The singleton instance for the month of February with 28 days, or 29 in a leap year.
Month.JANUARY	The singleton instance for the month of January with 31 days.
Month.JULY	The singleton instance for the month of July with 31 days.
Month.JUNE	The singleton instance for the month of June with 30 days.
Month.MARCH	The singleton instance for the month of March with 31 days.
Month.MAY	The singleton instance for the month of May with 31 days.
Month.NOVEMBER	The singleton instance for the month of November with 30 days.
Month.OCTOBER	The singleton instance for the month of October with 31 days.
Month.SEPTEMBER	The singleton instance for the month of September with 30 days.

A month-of-year, such as 'July'.

Month is an enum representing the 12 months of the year - January, February, March, April, May, June, July, August, September, October, November and December.

In addition to the textual enum name, each month-of-year has an int value. The int value follows normal usage and the ISO-8601 standard, from 1 (January) to 12 (December). It is recommended that applications use the enum rather than the int value to ensure code clarity.

Do not use ordinal() to obtain the numeric representation of Month. Use getValue() instead.

This enum represents a common concept that is found in many calendar systems. As such, this enum may be used by any calendar system that has the month-of-year concept defined exactly equivalent to the ISO-8601 calendar system.

Summary

Enum values
`APRIL` The singleton instance for the month of April with 30 days.
`AUGUST` The singleton instance for the month of August with 31 days.
`DECEMBER` The singleton instance for the month of December with 31 days.
`FEBRUARY` The singleton instance for the month of February with 28 days, or 29 in a leap year.
`JANUARY` The singleton instance for the month of January with 31 days.
`JULY` The singleton instance for the month of July with 31 days.
`JUNE` The singleton instance for the month of June with 30 days.
`MARCH` The singleton instance for the month of March with 31 days.
`MAY` The singleton instance for the month of May with 31 days.
`NOVEMBER` The singleton instance for the month of November with 30 days.
`OCTOBER` The singleton instance for the month of October with 31 days.
`SEPTEMBER` The singleton instance for the month of September with 30 days.

Public methods
Temporal!	`adjustInto(temporal: Temporal!)` Adjusts the specified temporal object to have this month-of-year.
Int	`firstDayOfYear(leapYear: Boolean)` Gets the day-of-year corresponding to the first day of this month.
Month!	`firstMonthOfQuarter()` Gets the month corresponding to the first month of this quarter.
static Month!	`from(temporal: TemporalAccessor!)` Obtains an instance of `Month` from a temporal object.
Int	`get(field: TemporalField!)` Gets the value of the specified field from this month-of-year as an `int`.
String!	`getDisplayName(style: TextStyle!, locale: Locale!)` Gets the textual representation, such as 'Jan' or 'December'.
Long	`getLong(field: TemporalField!)` Gets the value of the specified field from this month-of-year as a `long`.
Int	`getValue()` Gets the month-of-year `int` value.
Boolean	`isSupported(field: TemporalField!)` Checks if the specified field is supported.
Int	`length(leapYear: Boolean)` Gets the length of this month in days.
Int	`maxLength()` Gets the maximum length of this month in days.
Int	`minLength()` Gets the minimum length of this month in days.
Month!	`minus(months: Long)` Returns the month-of-year that is the specified number of months before this one.
static Month!	`of(month: Int)` Obtains an instance of `Month` from an `int` value.
Month!	`plus(months: Long)` Returns the month-of-year that is the specified number of months after this one.
R	`query(query: TemporalQuery<R>!)` Queries this month-of-year using the specified query.
ValueRange!	`range(field: TemporalField!)` Gets the range of valid values for the specified field.

Enum values

APRIL

Added in API level 26

enum val APRIL : Month

The singleton instance for the month of April with 30 days. This has the numeric value of 4.

AUGUST

Added in API level 26

enum val AUGUST : Month

The singleton instance for the month of August with 31 days. This has the numeric value of 8.

DECEMBER

Added in API level 26

enum val DECEMBER : Month

The singleton instance for the month of December with 31 days. This has the numeric value of 12.

FEBRUARY

Added in API level 26

enum val FEBRUARY : Month

The singleton instance for the month of February with 28 days, or 29 in a leap year. This has the numeric value of 2.

JANUARY

Added in API level 26

enum val JANUARY : Month

The singleton instance for the month of January with 31 days. This has the numeric value of 1.

JULY

Added in API level 26

enum val JULY : Month

The singleton instance for the month of July with 31 days. This has the numeric value of 7.

JUNE

Added in API level 26

enum val JUNE : Month

The singleton instance for the month of June with 30 days. This has the numeric value of 6.

MARCH

Added in API level 26

enum val MARCH : Month

The singleton instance for the month of March with 31 days. This has the numeric value of 3.

MAY

Added in API level 26

enum val MAY : Month

The singleton instance for the month of May with 31 days. This has the numeric value of 5.

NOVEMBER

Added in API level 26

enum val NOVEMBER : Month

The singleton instance for the month of November with 30 days. This has the numeric value of 11.

OCTOBER

Added in API level 26

enum val OCTOBER : Month

The singleton instance for the month of October with 31 days. This has the numeric value of 10.

SEPTEMBER

Added in API level 26

enum val SEPTEMBER : Month

The singleton instance for the month of September with 30 days. This has the numeric value of 9.

Public methods

adjustInto

Added in API level 26

fun adjustInto(temporal: Temporal!): Temporal!

Adjusts the specified temporal object to have this month-of-year.

This returns a temporal object of the same observable type as the input with the month-of-year changed to be the same as this.

The adjustment is equivalent to using Temporal.with(TemporalField, long) passing ChronoField.MONTH_OF_YEAR as the field. If the specified temporal object does not use the ISO calendar system then a DateTimeException is thrown.

In most cases, it is clearer to reverse the calling pattern by using Temporal.with(TemporalAdjuster):

// these two lines are equivalent, but the second approach is recommended
    temporal = thisMonth.adjustInto(temporal);
    temporal = temporal.with(thisMonth);

For example, given a date in May, the following are output:

dateInMay.with(JANUARY);    // four months earlier
    dateInMay.with(APRIL);      // one months earlier
    dateInMay.with(MAY);        // same date
    dateInMay.with(JUNE);       // one month later
    dateInMay.with(DECEMBER);   // seven months later

This instance is immutable and unaffected by this method call.

Parameters
`temporal`	Temporal!: the target object to be adjusted, not null

Return
`Temporal!`	the adjusted object, not null

Exceptions
`java.time.DateTimeException`	if unable to make the adjustment
`java.lang.ArithmeticException`	if numeric overflow occurs

firstDayOfYear

Added in API level 26

fun firstDayOfYear(leapYear: Boolean): Int

Gets the day-of-year corresponding to the first day of this month.

This returns the day-of-year that this month begins on, using the leap year flag to determine the length of February.

Parameters
`leapYear`	Boolean: true if the length is required for a leap year

Return
`Int`	the day of year corresponding to the first day of this month, from 1 to 336

firstMonthOfQuarter

Added in API level 26

fun firstMonthOfQuarter(): Month!

Gets the month corresponding to the first month of this quarter.

The year can be divided into four quarters. This method returns the first month of the quarter for the base month. January, February and March return January. April, May and June return April. July, August and September return July. October, November and December return October.

Return
`Month!`	the first month of the quarter corresponding to this month, not null

from

Added in API level 26

static fun from(temporal: TemporalAccessor!): Month!

Obtains an instance of Month from a temporal object.

This obtains a month based on the specified temporal. A TemporalAccessor represents an arbitrary set of date and time information, which this factory converts to an instance of Month.

The conversion extracts the MONTH_OF_YEAR field. The extraction is only permitted if the temporal object has an ISO chronology, or can be converted to a LocalDate.

This method matches the signature of the functional interface TemporalQuery allowing it to be used as a query via method reference, Month::from.

Parameters
`temporal`	TemporalAccessor!: the temporal object to convert, not null

Return
`Month!`	the month-of-year, not null

Exceptions
`java.time.DateTimeException`	if unable to convert to a `Month`

get

Added in API level 26

fun get(field: TemporalField!): Int

Gets the value of the specified field from this month-of-year as an int.

This queries this month for the value of the specified field. The returned value will always be within the valid range of values for the field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.

If the field is MONTH_OF_YEAR then the value of the month-of-year, from 1 to 12, will be returned. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

Parameters
`field`	TemporalField!: the field to get, not null

Return
`Int`	the value for the field, within the valid range of values

Exceptions
`java.time.DateTimeException`	if a value for the field cannot be obtained or the value is outside the range of valid values for the field
`java.time.temporal.UnsupportedTemporalTypeException`	if the field is not supported or the range of values exceeds an `int`
`java.lang.ArithmeticException`	if numeric overflow occurs

getDisplayName

Added in API level 26

fun getDisplayName(
    style: TextStyle!, 
    locale: Locale!
): String!

Gets the textual representation, such as 'Jan' or 'December'.

This returns the textual name used to identify the month-of-year, suitable for presentation to the user. The parameters control the style of the returned text and the locale.

If no textual mapping is found then the numeric value is returned.

Parameters
`style`	TextStyle!: the length of the text required, not null
`locale`	Locale!: the locale to use, not null

Return
`String!`	the text value of the month-of-year, not null

getLong

Added in API level 26

fun getLong(field: TemporalField!): Long

Gets the value of the specified field from this month-of-year as a long.

This queries this month for the value of the specified field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.

If the field is MONTH_OF_YEAR then the value of the month-of-year, from 1 to 12, will be returned. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

Parameters
`field`	TemporalField!: the field to get, not null

Return
`Long`	the value for the field

Exceptions
`java.time.DateTimeException`	if a value for the field cannot be obtained
`java.time.temporal.UnsupportedTemporalTypeException`	if the field is not supported
`java.lang.ArithmeticException`	if numeric overflow occurs

getValue

Added in API level 26

fun getValue(): Int

Gets the month-of-year int value.

The values are numbered following the ISO-8601 standard, from 1 (January) to 12 (December).

Return
`Int`	the month-of-year, from 1 (January) to 12 (December)

isSupported

Added in API level 26

fun isSupported(field: TemporalField!): Boolean

Checks if the specified field is supported.

This checks if this month-of-year can be queried for the specified field. If false, then calling the range and get methods will throw an exception.

If the field is MONTH_OF_YEAR then this method returns true. All other ChronoField instances will return false.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.isSupportedBy(TemporalAccessor) passing this as the argument. Whether the field is supported is determined by the field.

Parameters
`field`	TemporalField!: the field to check, null returns false

Return
`Boolean`	true if the field is supported on this month-of-year, false if not

length

Added in API level 26

fun length(leapYear: Boolean): Int

Gets the length of this month in days.

This takes a flag to determine whether to return the length for a leap year or not.

February has 28 days in a standard year and 29 days in a leap year. April, June, September and November have 30 days. All other months have 31 days.

Parameters
`leapYear`	Boolean: true if the length is required for a leap year

Return
`Int`	the length of this month in days, from 28 to 31

maxLength

Added in API level 26

fun maxLength(): Int

Gets the maximum length of this month in days.

February has a maximum length of 29 days. April, June, September and November have 30 days. All other months have 31 days.

Return
`Int`	the maximum length of this month in days, from 29 to 31

minLength

Added in API level 26

fun minLength(): Int

Gets the minimum length of this month in days.

February has a minimum length of 28 days. April, June, September and November have 30 days. All other months have 31 days.

Return
`Int`	the minimum length of this month in days, from 28 to 31

minus

Added in API level 26

fun minus(months: Long): Month!

Returns the month-of-year that is the specified number of months before this one.

The calculation rolls around the start of the year from January to December. The specified period may be negative.

This instance is immutable and unaffected by this method call.

Parameters
`months`	Long: the months to subtract, positive or negative

Return
`Month!`	the resulting month, not null

of

Added in API level 26

static fun of(month: Int): Month!

Obtains an instance of Month from an int value.

Month is an enum representing the 12 months of the year. This factory allows the enum to be obtained from the int value. The int value follows the ISO-8601 standard, from 1 (January) to 12 (December).

Parameters
`month`	Int: the month-of-year to represent, from 1 (January) to 12 (December)

Return
`Month!`	the month-of-year, not null

Exceptions
`java.time.DateTimeException`	if the month-of-year is invalid

plus

Added in API level 26

fun plus(months: Long): Month!

Returns the month-of-year that is the specified number of months after this one.

The calculation rolls around the end of the year from December to January. The specified period may be negative.

This instance is immutable and unaffected by this method call.

Parameters
`months`	Long: the months to add, positive or negative

Return
`Month!`	the resulting month, not null

query

Added in API level 26

fun <R : Any!> query(query: TemporalQuery<R>!): R

Queries this month-of-year using the specified query.

This queries this month-of-year using the specified query strategy object. The TemporalQuery object defines the logic to be used to obtain the result. Read the documentation of the query to understand what the result of this method will be.

The result of this method is obtained by invoking the TemporalQuery.queryFrom(TemporalAccessor) method on the specified query passing this as the argument.

Parameters
`<R>`	the type of the result
`query`	TemporalQuery<R>!: the query to invoke, not null

Return
`R`	the query result, null may be returned (defined by the query)

Exceptions
`java.time.DateTimeException`	if unable to query (defined by the query)
`java.lang.ArithmeticException`	if numeric overflow occurs (defined by the query)

range

Added in API level 26

fun range(field: TemporalField!): ValueRange!

Gets the range of valid values for the specified field.

The range object expresses the minimum and maximum valid values for a field. This month is used to enhance the accuracy of the returned range. If it is not possible to return the range, because the field is not supported or for some other reason, an exception is thrown.

If the field is MONTH_OF_YEAR then the range of the month-of-year, from 1 to 12, will be returned. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.rangeRefinedBy(TemporalAccessor) passing this as the argument. Whether the range can be obtained is determined by the field.

Parameters
`field`	TemporalField!: the field to query the range for, not null

Return
`ValueRange!`	the range of valid values for the field, not null

Exceptions
`java.time.DateTimeException`	if the range for the field cannot be obtained
`java.time.temporal.UnsupportedTemporalTypeException`	if the field is not supported