Class/Object

java.time

Month

Related Docs: object Month | package time

Permalink

final class Month extends Enum[Month] with TemporalAccessor with TemporalAdjuster

Linear Supertypes
TemporalAdjuster, TemporalAccessor, Enum[Month], Serializable, Comparable[Month], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Month
  2. TemporalAdjuster
  3. TemporalAccessor
  4. Enum
  5. Serializable
  6. Comparable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def adjustInto(temporal: Temporal): Temporal

    Permalink

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

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

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

    The adjustment is equivalent to using long) passing ChronoField#MONTH_OF_YEAR 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(TemporalAdjuster):

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

    For example, given a date in May, the following are output:

    dateInMay.with(JANUARY);    // four months earlier
    dateInMay.with(APRIL);      // one months earlier
    dateInMay.with(MAY);        // same date
    dateInMay.with(JUNE);       // one month later
    dateInMay.with(DECEMBER);   // seven months later
    

    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
    MonthTemporalAdjuster
    Exceptions thrown

    ArithmeticException if numeric overflow occurs

    DateTimeException if unable to make the adjustment

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. final def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    Enum → AnyRef
    Annotations
    @throws( ... )
  7. final def compareTo(arg0: Month): Int

    Permalink
    Definition Classes
    Enum → Comparable
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. final def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    Enum → AnyRef → Any
  10. final def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    Enum → AnyRef
  11. def firstDayOfYear(leapYear: Boolean): Int

    Permalink

    Gets the day-of-year corresponding to the first day of this month.

    Gets the day-of-year corresponding to the first day of this month.

    This returns the day-of-year that this month begins on, using the leap year flag to determine the length of February.

    leapYear

    true if the length is required for a leap year

    returns

    the day of year corresponding to the first day of this month, from 1 to 336

  12. def firstMonthOfQuarter: Month

    Permalink

    Gets the month corresponding to the first month of this quarter.

    Gets the month corresponding to the first month of this quarter.

    The year can be divided into four quarters. This method returns the first month of the quarter for the base month. January, February and March return January. April, May and June return April. July, August and September return July. October, November and December return October.

    returns

    the first month of the quarter corresponding to this month, not null

  13. def get(field: TemporalField): Int

    Permalink

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

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

    This queries this 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 MONTH_OF_YEAR then the value of the month-of-year, from 1 to 12, will be returned. 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, within the valid range of values

    Definition Classes
    MonthTemporalAccessor
    Exceptions thrown

    ArithmeticException if numeric overflow occurs

    DateTimeException if the value is outside the range of valid values for the field

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

    Permalink
    Definition Classes
    AnyRef → Any
  15. final def getDeclaringClass(): Class[Month]

    Permalink
    Definition Classes
    Enum
  16. def getDisplayName(style: TextStyle, locale: Locale): String

    Permalink

    Gets the textual representation, such as 'Jan' or 'December'.

    Gets the textual representation, such as 'Jan' or 'December'.

    This returns the textual name used to identify the month-of-year. The parameters control the length of the returned text and the locale.

    If no textual mapping is found then the numeric value is returned.

    style

    the length of the text required, not null

    locale

    the locale to use, not null

    returns

    the text value of the month-of-year, not null

  17. def getLong(field: TemporalField): Long

    Permalink

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

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

    This queries this 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 MONTH_OF_YEAR then the value of the month-of-year, from 1 to 12, will be returned. 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
    MonthTemporalAccessor
    Exceptions thrown

    ArithmeticException if numeric overflow occurs

    DateTimeException if a value for the field cannot be obtained

  18. def getValue: Int

    Permalink

    Gets the month-of-year int value.

    Gets the month-of-year int value.

    The values are numbered following the ISO-8601 standard, from 1 (January) to 12 (December).

    returns

    the month-of-year, from 1 (January) to 12 (December)

  19. final def hashCode(): Int

    Permalink
    Definition Classes
    Enum → AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

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

    Permalink

    Checks if the specified field is supported.

    Checks if the specified field is supported.

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

    If the field is MONTH_OF_YEAR then this method returns true. 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-of-year, false if not

    Definition Classes
    MonthTemporalAccessor
  22. def length(leapYear: Boolean): Int

    Permalink

    Gets the length of this month in days.

    Gets the length of this month in days.

    This takes a flag to determine whether to return the length for a leap year or not.

    February has 28 days in a standard year and 29 days in a leap year. April, June, September and November have 30 days. All other months have 31 days.

    leapYear

    true if the length is required for a leap year

    returns

    the length of this month in days, from 28 to 31

  23. def maxLength: Int

    Permalink

    Gets the maximum length of this month in days.

    Gets the maximum length of this month in days.

    February has a maximum length of 29 days. April, June, September and November have 30 days. All other months have 31 days.

    returns

    the maximum length of this month in days, from 29 to 31

  24. def minLength: Int

    Permalink

    Gets the minimum length of this month in days.

    Gets the minimum length of this month in days.

    February has a minimum length of 28 days. April, June, September and November have 30 days. All other months have 31 days.

    returns

    the minimum length of this month in days, from 28 to 31

  25. def minus(months: Long): Month

    Permalink

    Returns the month-of-year that is the specified number of months before this one.

    Returns the month-of-year that is the specified number of months before this one.

    The calculation rolls around the start of the year from January to December. The specified period may be negative.

    This instance is immutable and unaffected by this method call.

    months

    the months to subtract, positive or negative

    returns

    the resulting month, not null

  26. final def name(): String

    Permalink
    Definition Classes
    Enum
  27. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. final def ordinal(): Int

    Permalink
    Definition Classes
    Enum
  31. def plus(months: Long): Month

    Permalink

    Returns the month-of-year that is the specified number of quarters after this one.

    Returns the month-of-year that is the specified number of quarters after this one.

    The calculation rolls around the end of the year from December to January. The specified period may be negative.

    This instance is immutable and unaffected by this method call.

    months

    the months to add, positive or negative

    returns

    the resulting month, not null

  32. def query[R](query: TemporalQuery[R]): R

    Permalink

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

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

    This queries this month-of-year 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
    MonthTemporalAccessor
    Exceptions thrown

    ArithmeticException if numeric overflow occurs (defined by the query)

    DateTimeException if unable to query (defined by the query)

  33. def range(field: TemporalField): ValueRange

    Permalink

    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 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 MONTH_OF_YEAR then the range of the month-of-year, from 1 to 12, will be returned. 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
    MonthTemporalAccessor
    Exceptions thrown

    DateTimeException if the range for the field cannot be obtained

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

    Permalink
    Definition Classes
    AnyRef
  35. def toString(): String

    Permalink
    Definition Classes
    Enum → AnyRef → Any
  36. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from TemporalAdjuster

Inherited from TemporalAccessor

Inherited from Enum[Month]

Inherited from Serializable

Inherited from Comparable[Month]

Inherited from AnyRef

Inherited from Any

Ungrouped