DayOfMonth

Obtains an instance of DayOfMonth from a date-time object.

This obtains a day-of-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 DayOfMonth.

The conversion extracts the ChronoField#DAY_OF_MONTH day-of-month 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 in queries via method reference, DayOfMonth.from.

Throw:

Function overloading for DayOfMonth.now:

• if called with no arguments, DayOfMonth._now0 is executed;
• if called with an instance of ZoneId, then DayOfMonth._nowZoneId is executed;
• if called with an instance of Clock, then DayOfMonth._nowClock is executed;
• otherwise IllegalArgumentException is thrown.

Obtains an instance of DayOfMonth.

A day-of-month object represents one of the 31 days of the month, from 1 to 31.

Throw:

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

This will query the Clock.systemDefaultZone system clock in the default time-zone to obtain the current day-of-month. The zone and offset will be set based on the time-zone in the clock.

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

Obtains the current day-of-month from the specified clock.

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

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

This will query the {@link Clock#system(java.time.ZoneId) system clock} to obtain the current day-of-month. 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.

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

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

The adjustment is equivalent to using Temporal.with passing ChronoField.DAY_OF_MONTH 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:

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

This instance is immutable and unaffected by this method call.

Throw:

Combines this day-of-month with a month to create a MonthDay.

This returns a MonthDay formed from this day and the specified month.

This method can be used as part of a chain to produce a date:

 LocalDate date = day.atMonth(month).atYear(year);

If this day-of-month is invalid for the month then it will be changed to the last valid date for the month.

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

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

If this day-of-month is invalid for the year-month then it will be changed to the last valid date for the month.

Compares this day-of-month to another.

The comparison is based on the value of the day. It is 'consistent with equals', as defined by Comparable.

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

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

This queries this day-of-month 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 DayOfMonth.isSupported supported fields will return valid values based on this day-of-month. 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 passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

Throw:

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

This queries this day-of-month 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 DayOfMonth.isSupported(TemporalField) supported fields} will return valid values based on this day-of-month. 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 passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

Throw:

A hash code for this day-of-month.

Checks if the specified field is supported.

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

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

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

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

This method checks whether this day and the input year and month form a valid date.

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

This queries this day-of-month 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 method on the specified query passing this as the argument.

Throw:

Gets the range of valid values for the specified field.

The range object expresses the minimum and maximum valid values for a field. This day-of-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 a ChronoField then the query is implemented here. The DayOfMonth.isSupported 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 passing this as the argument. Whether the range can be obtained is determined by the field.

Throw:

Outputs this day-of-month as a String.

Gets the day-of-month value.