MonthDay

adjustInto

fun adjustInto(temporal: Temporal!): Temporal!

Adjusts the specified temporal object to have this month-day.

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

The adjustment is equivalent to using Temporal.with(TemporalField, long) twice, passing ChronoField.MONTH_OF_YEAR and ChronoField.DAY_OF_MONTH as the fields. 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 = thisMonthDay.adjustInto(temporal);
    temporal = temporal.with(thisMonthDay);
  

This instance is immutable and unaffected by this method call.

atYear

fun atYear(year: Int): LocalDate!

Combines this month-day with a year to create a LocalDate.

This returns a LocalDate formed from this month-day and the specified year.

A month-day of February 29th will be adjusted to February 28th in the resulting date if the year is not a leap year.

This instance is immutable and unaffected by this method call.

compareTo

fun compareTo(other: MonthDay!): Int

Compares this month-day to another month-day.

The comparison is based first on value of the month, then on the value of the day. It is "consistent with equals", as defined by Comparable.

equals

fun equals(other: Any?): Boolean

Checks if this month-day is equal to another month-day.

The comparison is based on the time-line position of the month-day within a year.

format

fun format(formatter: DateTimeFormatter!): String!

Formats this month-day using the specified formatter.

This month-day will be passed to the formatter to produce a string.

from

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

Obtains an instance of MonthDay from a temporal object.

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

The conversion extracts the MONTH_OF_YEAR and DAY_OF_MONTH fields. 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, MonthDay::from.

get

fun get(field: TemporalField!): Int

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

This queries this month-day 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 a ChronoField then the query is implemented here. The supported fields will return valid values based on this month-day. 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.

getDayOfMonth

fun getDayOfMonth(): Int

Gets the day-of-month field.

This method returns the primitive int value for the day-of-month.

getLong

fun getLong(field: TemporalField!): Long

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

This queries this month-day 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 a ChronoField then the query is implemented here. The supported fields will return valid values based on this month-day. 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.

getMonth

fun getMonth(): Month!

Gets the month-of-year field using the Month enum.

This method returns the enum Month for the month. This avoids confusion as to what int values mean. If you need access to the primitive int value then the enum provides the int value.

getMonthValue

fun getMonthValue(): Int

Gets the month-of-year field from 1 to 12.

This method returns the month as an int from 1 to 12. Application code is frequently clearer if the enum Month is used by calling getMonth().

hashCode

fun hashCode(): Int

A hash code for this month-day.

isAfter

fun isAfter(other: MonthDay!): Boolean

Checks if this month-day is after the specified month-day.

isBefore

fun isBefore(other: MonthDay!): Boolean

Checks if this month-day is before the specified month-day.

isSupported

fun isSupported(field: TemporalField!): Boolean

Checks if the specified field is supported.

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

If the field is a ChronoField then the query is implemented here. The supported fields are:

• MONTH_OF_YEAR
• YEAR

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.

isValidYear

fun isValidYear(year: Int): Boolean

Checks if the year is valid for this month-day.

This method checks whether this month and day and the input year form a valid date. This can only return false for February 29th.

now

static fun now(): MonthDay!

Obtains the current month-day from the system clock in the default time-zone.

This will query the system clock in the default time-zone to obtain the current month-day.

Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.

now

static fun now(clock: Clock!): MonthDay!

Obtains the current month-day from the specified clock.

This will query the specified clock to obtain the current month-day. Using this method allows the use of an alternate clock for testing. The alternate clock may be introduced using dependency injection.

now

static fun now(zone: ZoneId!): MonthDay!

Obtains the current month-day from the system clock in the specified time-zone.

This will query the system clock to obtain the current month-day. Specifying the time-zone avoids dependence on the default time-zone.

Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.

of

static fun of(
    month: Int, 
    dayOfMonth: Int
): MonthDay!

Obtains an instance of MonthDay.

The day-of-month must be valid for the month within a leap year. Hence, for month 2 (February), day 29 is valid.

For example, passing in month 4 (April) and day 31 will throw an exception, as there can never be April 31st in any year. By contrast, passing in February 29th is permitted, as that month-day can sometimes be valid.

of

static fun of(
    month: Month!, 
    dayOfMonth: Int
): MonthDay!

Obtains an instance of MonthDay.

The day-of-month must be valid for the month within a leap year. Hence, for February, day 29 is valid.

For example, passing in April and day 31 will throw an exception, as there can never be April 31st in any year. By contrast, passing in February 29th is permitted, as that month-day can sometimes be valid.

parse

static fun parse(text: CharSequence!): MonthDay!

Obtains an instance of MonthDay from a text string such as --12-03.

The string must represent a valid month-day. The format is --MM-dd.

parse

static fun parse(
    text: CharSequence!, 
    formatter: DateTimeFormatter!
): MonthDay!

Obtains an instance of MonthDay from a text string using a specific formatter.

The text is parsed using the formatter, returning a month-day.

query

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

Queries this month-day using the specified query.

This queries this month-day 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.

range

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-day 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 a ChronoField then the query is implemented here. The supported fields will return appropriate range instances. 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.

toString

fun toString(): String

Outputs this month-day as a String, such as --12-03.

The output will be in the format --MM-dd:

with

fun with(month: Month!): MonthDay!

Returns a copy of this MonthDay with the month-of-year altered.

This returns a month-day with the specified month. If the day-of-month is invalid for the specified month, the day will be adjusted to the last valid day-of-month.

This instance is immutable and unaffected by this method call.

withDayOfMonth

fun withDayOfMonth(dayOfMonth: Int): MonthDay!

Returns a copy of this MonthDay with the day-of-month altered.

This returns a month-day with the specified day-of-month. If the day-of-month is invalid for the month, an exception is thrown.

This instance is immutable and unaffected by this method call.

withMonth

fun withMonth(month: Int): MonthDay!

Returns a copy of this MonthDay with the month-of-year altered.

This returns a month-day with the specified month. If the day-of-month is invalid for the specified month, the day will be adjusted to the last valid day-of-month.

This instance is immutable and unaffected by this method call.