YearMonth

class YearMonth(year: Int, month: Month) : Comparable<YearMonth>

A month in a particular year.

Parameters

year

the year

month

the month of the year

Throws

io.islandtime.DateTimeException

if the year is outside the supported range

Constructors

YearMonth

common

fun YearMonth(year: Int, monthNumber: Int)

Creates a YearMonth.

YearMonth

common

fun YearMonth(year: Int, month: Month)

Creates a YearMonth.

Types

Companion

common

object Companion

Functions

compareTo

common

open operator override fun compareTo(other: YearMonth): Int

contains

common

operator fun contains(date: Date): Boolean

copy

common

fun copy(year: Int = this.year, month: Month = this.month): YearMonth

Returns a copy of this year-month with the values of any individual components replaced by the new values specified.

fun copy(year: Int = this.year, monthNumber: Int): YearMonth

Returns a copy of this year-month with the values of any individual components replaced by the new values specified.

equals

common

open operator override fun equals(other: Any?): Boolean

hashCode

common

open override fun hashCode(): Int

minus

common

operator fun minus(months: IntMonths): YearMonth

operator fun minus(years: IntYears): YearMonth

operator fun minus(months: LongMonths): YearMonth

operator fun minus(years: LongYears): YearMonth

plus

common

operator fun plus(months: IntMonths): YearMonth

operator fun plus(years: IntYears): YearMonth

operator fun plus(months: LongMonths): YearMonth

operator fun plus(years: LongYears): YearMonth

toString

common

open override fun toString(): String

Converts this date-time to a string in ISO-8601 extended format.

Properties

dateRange

common

val dateRange: DateRange

The range of dates within this year-month.

dayRange

common

val dayRange: IntRange

The range of days within this year-month.

endDate

common

val endDate: Date

The Date representing the last day in this year-month.

firstDayOfYear

common

val firstDayOfYear: Int

The ordinal date corresponding to the first day of this year-month.

isInLeapYear

common

val isInLeapYear: Boolean

Checks if this year-month falls within a leap year.

lastDay

common

val lastDay: Int

The last day of the year-month.

lastDayOfYear

common

val lastDayOfYear: Int

The ordinal date corresponding to the last day of this year-month.

lengthOfMonth

common

val lengthOfMonth: IntDays

The length of the year-month in days.

lengthOfYear

common

val lengthOfYear: IntDays

The length of the year in days.

month

common

val month: Month

The month of the year.

monthNumber

common

val monthNumber: Int

The ISO month number, from 1-12.

startDate

common

val startDate: Date

The Date representing the first day in this year-month.

year

common

val year: Int

The year.

Extensions

atDay

common

fun YearMonth.atDay(day: Int): Date

Combines a YearMonth with a day of the month to create a Date.

toJavaYearMonth

jvm

fun YearMonth.toJavaYearMonth(): YearMonth

Converts this year-month to an equivalent Java YearMonth.

toNSDateComponents

darwin

fun YearMonth.toNSDateComponents(includeCalendar: Boolean = false): <ERROR CLASS>

Converts this year-month to an equivalent NSDateComponents object.

toYear

common

fun YearMonth.toYear(): Year

Returns this year-month with the precision reduced to the year.