org.threeten.bp

MonthDay

final class MonthDay extends TemporalAccessor with TemporalAdjuster with Ordered[MonthDay] with Serializable

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 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 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.

Specification for implementors

This class is immutable and thread-safe.

Annotations
@SerialVersionUID( 939150713474957432L )
Linear Supertypes
Serializable, Ordered[MonthDay], Comparable[MonthDay], TemporalAdjuster, TemporalAccessor, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. MonthDay
  2. Serializable
  3. Ordered
  4. Comparable
  5. TemporalAdjuster
  6. TemporalAccessor
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def <(that: MonthDay): Boolean

    Definition Classes
    Ordered
  5. def <=(that: MonthDay): Boolean

    Definition Classes
    Ordered
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. def >(that: MonthDay): Boolean

    Definition Classes
    Ordered
  9. def >=(that: MonthDay): Boolean

    Definition Classes
    Ordered
  10. def adjustInto(temporal: Temporal): Temporal

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

    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.

    temporal

    the target object to be adjusted, not null

    returns

    the adjusted object, not null

    Definition Classes
    MonthDayTemporalAdjuster
    Exceptions thrown
    ArithmeticException

    if numeric overflow occurs

    DateTimeException

    if unable to make the adjustment

  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  12. def atYear(year: Int): LocalDate

    Combines this month-day with a year to create a 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.

    year

    the year to use, from MIN_YEAR to MAX_YEAR

    returns

    the local date formed from this month-day and the specified year, not null

    Exceptions thrown
    DateTimeException

    if the year is outside the valid range of years

  13. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. def compare(other: MonthDay): Int

    Compares this month-day to another month-day.

    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.

    other

    the other month-day to compare to, not null

    returns

    the comparator value, negative if less, positive if greater

    Definition Classes
    MonthDay → Ordered
  15. def compareTo(that: MonthDay): Int

    Definition Classes
    Ordered → Comparable
  16. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. def equals(obj: Any): Boolean

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

    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.

    obj

    the object to check, null returns false

    returns

    true if this is equal to the other month-day

    Definition Classes
    MonthDay → AnyRef → Any
  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def format(formatter: DateTimeFormatter): String

    Outputs this month-day as a String using the formatter.

    Outputs this month-day as a String using the formatter.

    This month-day will be passed to the formatter DateTimeFormatter#format(TemporalAccessor) print method.

    formatter

    the formatter to use, not null

    returns

    the formatted month-day string, not null

    Exceptions thrown
    DateTimeException

    if an error occurs during printing

  20. def get(field: TemporalField): Int

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

    Gets the value of the specified field from this month-day as an 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 #isSupported(TemporalField) supported fields will return valid values based on this month-day. All other ChronoField instances will throw a DateTimeException.

    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.

    field

    the field to get, not null

    returns

    the value for the field

    Definition Classes
    MonthDayTemporalAccessor
    Exceptions thrown
    ArithmeticException

    if numeric overflow occurs

    DateTimeException

    if a value for the field cannot be obtained

  21. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  22. def getDayOfMonth: Int

    Gets the day-of-month field.

    Gets the day-of-month field.

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

    returns

    the day-of-month, from 1 to 31

  23. def getLong(field: TemporalField): Long

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

    Gets the value of the specified field from this month-day as a 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 #isSupported(TemporalField) supported fields will return valid values based on this month-day. All other ChronoField instances will throw a DateTimeException.

    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.

    field

    the field to get, not null

    returns

    the value for the field

    Definition Classes
    MonthDayTemporalAccessor
    Exceptions thrown
    ArithmeticException

    if numeric overflow occurs

    DateTimeException

    if a value for the field cannot be obtained

  24. def getMonth: Month

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

    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 Month#getValue() int value.

    returns

    the month-of-year, not null

    See also

    #getMonthValue()

  25. def getMonthValue: Int

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

    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().

    returns

    the month-of-year, from 1 to 12

    See also

    #getMonth()

  26. def hashCode(): Int

    A hash code for this month-day.

    A hash code for this month-day.

    returns

    a suitable hash code

    Definition Classes
    MonthDay → AnyRef → Any
  27. def isAfter(other: MonthDay): Boolean

    Is this month-day after the specified month-day.

    Is this month-day after the specified month-day.

    other

    the other month-day to compare to, not null

    returns

    true if this is after the specified month-day

  28. def isBefore(other: MonthDay): Boolean

    Is this month-day before the specified month-day.

    Is this month-day before the specified month-day.

    other

    the other month-day to compare to, not null

    returns

    true if this point is before the specified month-day

  29. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  30. def isSupported(field: TemporalField): Boolean

    Checks if the specified field is supported.

    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(TemporalField) range and #get(TemporalField) get methods will throw an exception.

    If the field is a ChronoField then the query is implemented here. The #isSupported(TemporalField) supported fields will return valid values based on this date-time. The supported fields are:

    • MONTH_OF_YEAR
    • YEAR

    All other 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.

    field

    the field to check, null returns false

    returns

    true if the field is supported on this month-day, false if not

    Definition Classes
    MonthDayTemporalAccessor
  31. def isValidYear(year: Int): Boolean

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

    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.

    year

    the year to validate, an out of range value returns false

    returns

    true if the year is valid for this month-day

    See also

    Year#isValidMonthDay(MonthDay)

  32. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  33. final def notify(): Unit

    Definition Classes
    AnyRef
  34. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  35. def query[R >: Null](query: TemporalQuery[R]): R

    Queries this month-day using the specified query.

    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.

    R

    the type of the result

    query

    the query to invoke, not null

    returns

    the query result, null may be returned (defined by the query)

    Definition Classes
    MonthDayTemporalAccessor
    Exceptions thrown
    ArithmeticException

    if numeric overflow occurs (defined by the query)

    DateTimeException

    if unable to query (defined by the query)

  36. def range(field: TemporalField): ValueRange

    Gets the range of valid values for the specified field.

    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 #isSupported(TemporalField) supported fields will return appropriate range instances. All other ChronoField instances will throw a DateTimeException.

    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.

    field

    the field to query the range for, not null

    returns

    the range of valid values for the field, not null

    Definition Classes
    MonthDayTemporalAccessor
    Exceptions thrown
    DateTimeException

    if the range for the field cannot be obtained

  37. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  38. def toString(): String

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

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

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

    returns

    a string representation of this month-day, not null

    Definition Classes
    MonthDay → AnyRef → Any
  39. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. def with(month: Month): MonthDay

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

    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.

    month

    the month-of-year to set in the returned month-day, not null

    returns

    a { @code MonthDay} based on this month-day with the requested month, not null

  43. def withDayOfMonth(dayOfMonth: Int): MonthDay

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

    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.

    dayOfMonth

    the day-of-month to set in the return month-day, from 1 to 31

    returns

    a { @code MonthDay} based on this month-day with the requested day, not null

    Exceptions thrown
    DateTimeException

    if the day-of-month is invalid for the month

  44. def withMonth(month: Int): MonthDay

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

    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.

    month

    the month-of-year to set in the returned month-day, from 1 (January) to 12 (December)

    returns

    a { @code MonthDay} based on this month-day with the requested month, not null

    Exceptions thrown
    DateTimeException

    if the month-of-year value is invalid

Inherited from Serializable

Inherited from Ordered[MonthDay]

Inherited from Comparable[MonthDay]

Inherited from TemporalAdjuster

Inherited from TemporalAccessor

Inherited from AnyRef

Inherited from Any

Ungrouped