MonthDay
Extends:
A month-day in the ISO-8601 calendar system, such as {@code --12-03}.
{@code MonthDay} is an immutable date-time object that represents the combination of a year and 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 {@code MonthDay}.
Since a {@code 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, {@code MonthDay} only provides access to query and set the fields {@code MONTH_OF_YEAR} and {@code 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.
Specification for implementors
This class is immutable and thread-safe.Static Method Summary
| Static Public Methods | ||
| public static |
from(temporal: TemporalAccessor): MonthDay Obtains an instance of {@code MonthDay} from a temporal object. |
|
| public static |
function overloading for MonthDay.now |
|
| public static |
Obtains the current month-day from the system clock in the default time-zone. |
|
| public static |
Obtains the current month-day from the specified clock. |
|
| public static |
Obtains the current month-day from the system clock in the specified time-zone. |
|
| public static |
function overloading for MonthDay.of |
|
| public static |
ofMonthNumber(month: Month, dayOfMonth: number): MonthDay Obtains an instance of {@code MonthDay}. |
|
| public static |
ofNumberNumber(month: number, dayOfMonth: number): MonthDay Obtains an instance of {@code MonthDay}. |
|
| public static |
function overloading for MonthDay.parse |
|
| public static |
parseString(text: String): MonthDay Obtains an instance of {@code MonthDay} from a text string such as {@code --12-03}. |
|
| public static |
parseStringFormatter(text: String, formatter: DateTimeFormatter): MonthDay Obtains an instance of {@code MonthDay} from a text string using a specific formatter. |
|
Constructor Summary
| Public Constructor | ||
| public |
constructor(month: number, dayOfMonth: number) Constructor, previously validated. |
|
Method Summary
| Public Methods | ||
| public |
adjustInto(temporal: Temporal): Temporal Adjusts the specified temporal object to have this month-day. |
|
| public |
Combines this month-day with a year to create a {@code LocalDate}. |
|
| public |
Compares this month-day to another month-day. |
|
| public |
dayOfMonth(): number Gets the day-of-month field. |
|
| public |
Checks if this month-day is equal to another month-day. |
|
| public |
format(formatter: DateTimeFormatter): String Outputs this month-day as a {@code String} using the formatter. |
|
| public |
get(field: TemporalField): number Gets the value of the specified field from this month-day as an {@code int}. |
|
| public |
getLong(field: TemporalField): number Gets the value of the specified field from this month-day as a {@code long}. |
|
| public |
Is this month-day after the specified month-day. |
|
| public |
Is this month-day before the specified month-day. |
|
| public |
isSupported(field: TemporalField): boolean Checks if the specified field is supported. |
|
| public |
isValidYear(year: number): boolean Checks if the year is valid for this month-day. |
|
| public |
Gets the month-of-year field using the {@code Month} enum. |
|
| public |
monthValue(): number Gets the month-of-year field from 1 to 12. |
|
| public |
query(query: TemporalQuery): * Queries this month-day using the specified query. |
|
| public |
range(field: TemporalField): ValueRange Gets the range of valid values for the specified field. |
|
| public |
Outputs this month-day as a {@code String}, such as {@code --12-03}. |
|
| public |
Returns a copy of this {@code MonthDay} with the month-of-year altered. |
|
| public |
withDayOfMonth(dayOfMonth: number): MonthDay Returns a copy of this {@code MonthDay} with the day-of-month altered. |
|
| public |
Returns a copy of this {@code MonthDay} with the month-of-year altered. |
|
Inherited Summary
| From class TemporalAccessor | ||
| public |
get(field: TemporalField): number Gets the value of the specified field as an {@code int}. |
|
| public |
query(query: TemporalQuery): * Queries this date-time. |
|
| public |
range(field: TemporalField): ValueRange Gets the range of valid values for the specified field. |
|
Static Public Methods
public static from(temporal: TemporalAccessor): MonthDay source
Obtains an instance of {@code MonthDay} from a temporal object.
A {@code TemporalAccessor} represents some form of date and time information. This factory converts the arbitrary temporal object to an instance of {@code MonthDay}.
The conversion extracts the {@link ChronoField#MONTH_OF_YEAR MONTH_OF_YEAR} and {@link ChronoField#DAY_OF_MONTH DAY_OF_MONTH} fields. The extraction is only permitted if the date-time has an ISO chronology.
This method matches the signature of the functional interface TemporalQuery allowing it to be used in queries via method reference, {@code MonthDay::from}.
Params:
| Name | Type | Attribute | Description |
| temporal | TemporalAccessor | the temporal object to convert, not null |
Throw:
* |
DateTimeException if unable to convert to a {@code MonthDay} |
public static now(arg1: ZoneId | Clock | null): MonthDay source
function overloading for MonthDay.now
if called with 0 argument MonthDay.now0 is applied,
if called with 1 argument and first argument is an instance of ZoneId, then MonthDay.nowZoneId is applied,
otherwise MonthDay.nowClock is applied
public static now0(): MonthDay source
Obtains the current month-day from the system clock in the default time-zone.
This will query the {@link Clock#systemDefaultZone() 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.
public static nowClock(clock: Clock): MonthDay source
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 {@link Clock dependency injection}.
Params:
| Name | Type | Attribute | Description |
| clock | Clock | the clock to use, not null |
public static nowZoneId(zone: ZoneId): MonthDay source
Obtains the current month-day from the system clock in the specified time-zone.
This will query the {@link Clock#system(ZoneId) 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.
Params:
| Name | Type | Attribute | Description |
| zone | ZoneId | the zone ID to use, not null |
public static of(arg1: Month | number, arg2: number | null): MonthDay source
function overloading for MonthDay.of
if called with 2 argument and first argument is an instance of Month, then MonthDay.ofMonthNumber is applied,
otherwise MonthDay.ofNumberNumber is applied
public static ofMonthNumber(month: Month, dayOfMonth: number): MonthDay source
Obtains an instance of {@code 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.
Throw:
* |
DateTimeException if the value of any field is out of range |
* |
DateTimeException if the day-of-month is invalid for the month |
public static ofNumberNumber(month: number, dayOfMonth: number): MonthDay source
Obtains an instance of {@code 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.
Throw:
* |
DateTimeException if the value of any field is out of range |
* |
DateTimeException if the day-of-month is invalid for the month |
public static parse(arg1: ZoneId | Clock | null): MonthDay source
function overloading for MonthDay.parse
if called with 1 argument, then MonthDay.parseString is applied,
otherwise MonthDay.parseStringFormatter is applied
public static parseString(text: String): MonthDay source
Obtains an instance of {@code MonthDay} from a text string such as {@code --12-03}.
The string must represent a valid month-day. The format is {@code --MM-dd}.
Params:
| Name | Type | Attribute | Description |
| text | String | the text to parse such as "--12-03", not null |
Throw:
* |
DateTimeParseException if the text cannot be parsed |
public static parseStringFormatter(text: String, formatter: DateTimeFormatter): MonthDay source
Obtains an instance of {@code MonthDay} from a text string using a specific formatter.
The text is parsed using the formatter, returning a month-day.
Params:
| Name | Type | Attribute | Description |
| text | String | the text to parse, not null |
|
| formatter | DateTimeFormatter | the formatter to use, not null |
Throw:
* |
DateTimeParseException if the text cannot be parsed |
Public Constructors
Public Methods
public adjustInto(temporal: Temporal): Temporal source
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 {@link 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 {@code DateTimeException} is thrown.
In most cases, it is clearer to reverse the calling pattern by using {@link 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.
Params:
| Name | Type | Attribute | Description |
| temporal | Temporal | the target object to be adjusted, not null |
Throw:
* |
DateTimeException if unable to make the adjustment |
* |
ArithmeticException if numeric overflow occurs |
public atYear(year: number): LocalDate source
Combines this month-day with a year to create a {@code LocalDate}.
This returns a {@code 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.
Params:
| Name | Type | Attribute | Description |
| year | number | the year to use, from MIN_YEAR to MAX_YEAR |
Throw:
* |
DateTimeException if the year is outside the valid range of years |
public compareTo(other: MonthDay): number source
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.
Params:
| Name | Type | Attribute | Description |
| other | MonthDay | the other month-day to compare to, not null |
public dayOfMonth(): number source
Gets the day-of-month field.
This method returns the primitive {@code int} value for the day-of-month.
public equals(obj: *): boolean source
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.
Params:
| Name | Type | Attribute | Description |
| obj | * | the object to check, null returns false |
public format(formatter: DateTimeFormatter): String source
Outputs this month-day as a {@code String} using the formatter.
This month-day will be passed to the formatter {@link DateTimeFormatter#format(TemporalAccessor) print method}.
Params:
| Name | Type | Attribute | Description |
| formatter | DateTimeFormatter | the formatter to use, not null |
Throw:
* |
DateTimeException if an error occurs during printing |
public get(field: TemporalField): number source
Gets the value of the specified field from this month-day as an {@code int}.
This queries this month-day for the value for 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 {@link #isSupported(TemporalField) supported fields} will return valid values based on this month-day. All other {@code ChronoField} instances will throw a {@code DateTimeException}.
If the field is not a {@code ChronoField}, then the result of this method is obtained by invoking {@code TemporalField.getFrom(TemporalAccessor)} passing {@code this} as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.
Override:
TemporalAccessor#getParams:
| Name | Type | Attribute | Description |
| field | TemporalField | the field to get, not null |
Throw:
* |
DateTimeException if a value for the field cannot be obtained |
* |
ArithmeticException if numeric overflow occurs |
public getLong(field: TemporalField): number source
Gets the value of the specified field from this month-day as a {@code long}.
This queries this month-day for the value for 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 {@link #isSupported(TemporalField) supported fields} will return valid values based on this month-day. All other {@code ChronoField} instances will throw a {@code DateTimeException}.
If the field is not a {@code ChronoField}, then the result of this method is obtained by invoking {@code TemporalField.getFrom(TemporalAccessor)} passing {@code this} as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.
Params:
| Name | Type | Attribute | Description |
| field | TemporalField | the field to get, not null |
Throw:
* |
DateTimeException if a value for the field cannot be obtained |
* |
ArithmeticException if numeric overflow occurs |
public isAfter(other: MonthDay): boolean source
Is this month-day after the specified month-day.
Params:
| Name | Type | Attribute | Description |
| other | MonthDay | the other month-day to compare to, not null |
public isBefore(other: MonthDay): boolean source
Is this month-day before the specified month-day.
Params:
| Name | Type | Attribute | Description |
| other | MonthDay | the other month-day to compare to, not null |
public isSupported(field: TemporalField): boolean source
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 {@link #range(TemporalField) range} and {@link #get(TemporalField) get} methods will throw an exception.
If the field is a ChronoField then the query is implemented here. The {@link #isSupported(TemporalField) supported fields} will return valid values based on this date-time. The supported fields are:
- {@code MONTH_OF_YEAR}
- {@code YEAR}
If the field is not a {@code ChronoField}, then the result of this method is obtained by invoking {@code TemporalField.isSupportedBy(TemporalAccessor)} passing {@code this} as the argument. Whether the field is supported is determined by the field.
Params:
| Name | Type | Attribute | Description |
| field | TemporalField | the field to check, null returns false |
public isValidYear(year: number): boolean source
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.
Params:
| Name | Type | Attribute | Description |
| year | number | the year to validate, an out of range value returns false |
public month(): Month source
Gets the month-of-year field using the {@code Month} enum.
This method returns the enum Month for the month. This avoids confusion as to what {@code int} values mean. If you need access to the primitive {@code int} value then the enum provides the {@link Month#getValue() int value}.
See:
public monthValue(): number source
Gets the month-of-year field from 1 to 12.
This method returns the month as an {@code int} from 1 to 12. Application code is frequently clearer if the enum Month is used by calling {@link #getMonth()}.
See:
public query(query: TemporalQuery): * source
Queries this month-day using the specified query.
This queries this month-day using the specified query strategy object. The {@code 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 {@link TemporalQuery#queryFrom(TemporalAccessor)} method on the specified query passing {@code this} as the argument.
Override:
TemporalAccessor#queryParams:
| Name | Type | Attribute | Description |
| query | TemporalQuery | the query to invoke, not null |
Return:
| * | the query result, null may be returned (defined by the query) |
Throw:
* |
DateTimeException if unable to query (defined by the query) |
* |
ArithmeticException if numeric overflow occurs (defined by the query) |
public range(field: TemporalField): ValueRange source
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 {@link #isSupported(TemporalField) supported fields} will return appropriate range instances. All other {@code ChronoField} instances will throw a {@code DateTimeException}.
If the field is not a {@code ChronoField}, then the result of this method is obtained by invoking {@code TemporalField.rangeRefinedBy(TemporalAccessor)} passing {@code this} as the argument. Whether the range can be obtained is determined by the field.
Override:
TemporalAccessor#rangeParams:
| Name | Type | Attribute | Description |
| field | TemporalField | the field to query the range for, not null |
Throw:
* |
DateTimeException if the range for the field cannot be obtained |
public toString(): String source
Outputs this month-day as a {@code String}, such as {@code --12-03}.
The output will be in the format {@code --MM-dd}:
public with(month: Month): MonthDay source
Returns a copy of this {@code 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.
Params:
| Name | Type | Attribute | Description |
| month | Month | the month-of-year to set in the returned month-day, not null |
public withDayOfMonth(dayOfMonth: number): MonthDay source
Returns a copy of this {@code 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.
Params:
| Name | Type | Attribute | Description |
| dayOfMonth | number | the day-of-month to set in the return month-day, from 1 to 31 |
Throw:
* |
DateTimeException if the day-of-month value is invalid |
* |
DateTimeException if the day-of-month is invalid for the month |
public withMonth(month: number): MonthDay source
Returns a copy of this {@code 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.
Params:
| Name | Type | Attribute | Description |
| month | number | the month-of-year to set in the returned month-day, from 1 (January) to 12 (December) |
Throw:
* |
DateTimeException if the month-of-year value is invalid |