MonthDay
class MonthDay : TemporalAccessor, TemporalAdjuster, Comparable<MonthDay!>, Serializable
kotlin.Any | |
↳ | java.time.MonthDay |
A month-day in the ISO-8601 calendar system, such as --12-03
.
MonthDay
is an immutable date-time object that represents the combination of a month and day-of-month. Any field that can be derived from a month and day, such as quarter-of-year, can be obtained.
This class does not store or represent a year, time or time-zone. For example, the value "December 3rd" can be stored in a MonthDay
.
Since a MonthDay
does not possess a year, the leap day of February 29th is considered valid.
This class implements TemporalAccessor
rather than Temporal
. This is because it is not possible to define whether February 29th is valid or not without external information, preventing the implementation of plus/minus. Related to this, MonthDay
only provides access to query and set the fields MONTH_OF_YEAR
and DAY_OF_MONTH
.
The ISO-8601 calendar system is the modern civil calendar system used today in most of the world. It is equivalent to the proleptic Gregorian calendar system, in which today's rules for leap years are applied for all time. For most applications written today, the ISO-8601 rules are entirely suitable. However, any application that makes use of historical dates, and requires them to be accurate will find the ISO-8601 approach unsuitable.
Summary
Public methods | |
---|---|
Temporal! |
adjustInto(temporal: Temporal!) Adjusts the specified temporal object to have this month-day. |
LocalDate! |
Combines this month-day with a year to create a |
Int |
Compares this month-day to another month-day. |
Boolean |
Checks if this month-day is equal to another month-day. |
String! |
format(formatter: DateTimeFormatter!) Formats this month-day using the specified formatter. |
static MonthDay! |
from(temporal: TemporalAccessor!) Obtains an instance of |
Int |
get(field: TemporalField!) Gets the value of the specified field from this month-day as an |
Int |
Gets the day-of-month field. |
Long |
getLong(field: TemporalField!) Gets the value of the specified field from this month-day as a |
Month! |
getMonth() Gets the month-of-year field using the |
Int |
Gets the month-of-year field from 1 to 12. |
Int |
hashCode() A hash code for this month-day. |
Boolean |
Checks if this month-day is after the specified month-day. |
Boolean |
Checks if this month-day is before the specified month-day. |
Boolean |
isSupported(field: TemporalField!) Checks if the specified field is supported. |
Boolean |
isValidYear(year: Int) Checks if the year is valid for this month-day. |
static MonthDay! |
now() Obtains the current month-day from the system clock in the default time-zone. |
static MonthDay! |
Obtains the current month-day from the system clock in the specified time-zone. |
static MonthDay! |
Obtains the current month-day from the specified clock. |
static MonthDay! |
Obtains an instance of |
static MonthDay! |
Obtains an instance of |
static MonthDay! |
parse(text: CharSequence!) Obtains an instance of |
static MonthDay! |
parse(text: CharSequence!, formatter: DateTimeFormatter!) Obtains an instance of |
R |
query(query: TemporalQuery<R>!) Queries this month-day using the specified query. |
ValueRange! |
range(field: TemporalField!) Gets the range of valid values for the specified field. |
String |
toString() Outputs this month-day as a |
MonthDay! |
Returns a copy of this |
MonthDay! |
withDayOfMonth(dayOfMonth: Int) Returns a copy of this |
MonthDay! |
Returns a copy of this |
Public methods
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.
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 |
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.
Parameters | |
---|---|
year |
Int: the year to use, from MIN_YEAR to MAX_YEAR |
Return | |
---|---|
LocalDate! |
the local date formed from this month-day and the specified year, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the year is outside the valid range of years |
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
.
Parameters | |
---|---|
o |
the object to be compared. |
other |
MonthDay!: the other month-day to compare to, not null |
Return | |
---|---|
Int |
the comparator value, negative if less, positive if greater |
Exceptions | |
---|---|
java.lang.NullPointerException |
if the specified object is null |
java.lang.ClassCastException |
if the specified object's type prevents it from being compared to this object. |
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.
Parameters | |
---|---|
obj |
the object to check, null returns false |
Return | |
---|---|
Boolean |
true if this is equal to the other month-day |
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.
Parameters | |
---|---|
formatter |
DateTimeFormatter!: the formatter to use, not null |
Return | |
---|---|
String! |
the formatted month-day string, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if an error occurs during printing |
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
.
Parameters | |
---|---|
temporal |
TemporalAccessor!: the temporal object to convert, not null |
Return | |
---|---|
MonthDay! |
the month-day, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if unable to convert to a MonthDay |
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.
Parameters | |
---|---|
field |
TemporalField!: the field to get, not null |
Return | |
---|---|
Int |
the value for the field |
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 |
getDayOfMonth
fun getDayOfMonth(): Int
Gets the day-of-month field.
This method returns the primitive int
value for the day-of-month.
Return | |
---|---|
Int |
the day-of-month, from 1 to 31 |
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.
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 |
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
.
Return | |
---|---|
Month! |
the month-of-year, not null |
See Also
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()
.
Return | |
---|---|
Int |
the month-of-year, from 1 to 12 |
See Also
hashCode
fun hashCode(): Int
A hash code for this month-day.
Return | |
---|---|
Int |
a suitable hash code |
isAfter
fun isAfter(other: MonthDay!): Boolean
Checks if this month-day is after the specified month-day.
Parameters | |
---|---|
other |
MonthDay!: the other month-day to compare to, not null |
Return | |
---|---|
Boolean |
true if this is after the specified month-day |
isBefore
fun isBefore(other: MonthDay!): Boolean
Checks if this month-day is before the specified month-day.
Parameters | |
---|---|
other |
MonthDay!: the other month-day to compare to, not null |
Return | |
---|---|
Boolean |
true if this point 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
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-day, false if not |
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.
Parameters | |
---|---|
year |
Int: the year to validate |
Return | |
---|---|
Boolean |
true if the year is valid for this month-day |
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.
Return | |
---|---|
MonthDay! |
the current month-day using the system clock and default time-zone, not null |
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.
Parameters | |
---|---|
zone |
ZoneId!: the zone ID to use, not null |
Return | |
---|---|
MonthDay! |
the current month-day using the system clock, not null |
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
.
Parameters | |
---|---|
clock |
Clock!: the clock to use, not null |
Return | |
---|---|
MonthDay! |
the current month-day, not null |
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.
Parameters | |
---|---|
month |
Month!: the month-of-year to represent, not null |
dayOfMonth |
Int: the day-of-month to represent, from 1 to 31 |
Return | |
---|---|
MonthDay! |
the month-day, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the value of any field is out of range, or if the day-of-month is invalid for the month |
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.
Parameters | |
---|---|
month |
Int: the month-of-year to represent, from 1 (January) to 12 (December) |
dayOfMonth |
Int: the day-of-month to represent, from 1 to 31 |
Return | |
---|---|
MonthDay! |
the month-day, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the value of any field is out of range, or if the day-of-month is invalid for the month |
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
.
Parameters | |
---|---|
text |
CharSequence!: the text to parse such as "--12-03", not null |
Return | |
---|---|
MonthDay! |
the parsed month-day, not null |
Exceptions | |
---|---|
java.time.format.DateTimeParseException |
if the text cannot be parsed |
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.
Parameters | |
---|---|
text |
CharSequence!: the text to parse, not null |
formatter |
DateTimeFormatter!: the formatter to use, not null |
Return | |
---|---|
MonthDay! |
the parsed month-day, not null |
Exceptions | |
---|---|
java.time.format.DateTimeParseException |
if the text cannot be parsed |
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.
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
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.
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 |
toString
fun toString(): String
Outputs this month-day as a String
, such as --12-03
.
The output will be in the format --MM-dd
:
Return | |
---|---|
String |
a string representation of this month-day, not null |
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.
Parameters | |
---|---|
month |
Month!: the month-of-year to set in the returned month-day, not null |
Return | |
---|---|
MonthDay! |
a MonthDay based on this month-day with the requested month, not null |
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.
Parameters | |
---|---|
dayOfMonth |
Int: the day-of-month to set in the return month-day, from 1 to 31 |
Return | |
---|---|
MonthDay! |
a MonthDay based on this month-day with the requested day, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the day-of-month value is invalid, or if the day-of-month is invalid for the month |
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.
Parameters | |
---|---|
month |
Int: the month-of-year to set in the returned month-day, from 1 (January) to 12 (December) |
Return | |
---|---|
MonthDay! |
a MonthDay based on this month-day with the requested month, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the month-of-year value is invalid |