Object/Class

org.threeten.bp

YearMonth

Related Docs: class YearMonth | package bp

Permalink

object YearMonth extends Serializable

A year-month in the ISO-8601 calendar system, such as 2007-12.

YearMonth is an immutable date-time object that represents the combination of a year and month. Any field that can be derived from a year and month, such as quarter-of-year, can be obtained.

This class does not store or represent a day, time or time-zone. For example, the value "October 2007" can be stored in a YearMonth.

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()
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. YearMonth
  2. Serializable
  3. Serializable
  4. AnyRef
  5. 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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. def from(temporal: TemporalAccessor): YearMonth

    Permalink

    Obtains an instance of YearMonth from a temporal object.

    Obtains an instance of YearMonth from a temporal object.

    A TemporalAccessor represents some form of date and time information. This factory converts the arbitrary temporal object to an instance of YearMonth.

    The conversion extracts the YEAR and MONTH_OF_YEAR 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 in queries via method reference, YearMonth::from.

    temporal

    the temporal object to convert, not null

    returns

    the year-month, not null

    Exceptions thrown

    DateTimeException if unable to convert to a { @code YearMonth}

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  16. def now(clock: Clock): YearMonth

    Permalink

    Obtains the current year-month from the specified clock.

    Obtains the current year-month from the specified clock.

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

    clock

    the clock to use, not null

    returns

    the current year-month, not null

  17. def now(zone: ZoneId): YearMonth

    Permalink

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

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

    This will query the system clock to obtain the current year-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.

    zone

    the zone ID to use, not null

    returns

    the current year-month using the system clock, not null

  18. def now: YearMonth

    Permalink

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

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

    This will query the system clock in the default time-zone to obtain the current year-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.

    returns

    the current year-month using the system clock and default time-zone, not null

  19. def of(year: Int, month: Int): YearMonth

    Permalink

    Obtains an instance of YearMonth from a year and month.

    Obtains an instance of YearMonth from a year and month.

    year

    the year to represent, from MIN_YEAR to MAX_YEAR

    month

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

    returns

    the year-month, not null

    Exceptions thrown

    DateTimeException if either field value is invalid

  20. def of(year: Int, month: Month): YearMonth

    Permalink

    Obtains an instance of YearMonth from a year and month.

    Obtains an instance of YearMonth from a year and month.

    year

    the year to represent, from MIN_YEAR to MAX_YEAR

    month

    the month-of-year to represent, not null

    returns

    the year-month, not null

    Exceptions thrown

    DateTimeException if the year value is invalid

  21. def parse(text: CharSequence, formatter: DateTimeFormatter): YearMonth

    Permalink

    Obtains an instance of YearMonth from a text string using a specific formatter.

    Obtains an instance of YearMonth from a text string using a specific formatter.

    The text is parsed using the formatter, returning a year-month.

    text

    the text to parse, not null

    formatter

    the formatter to use, not null

    returns

    the parsed year-month, not null

    Exceptions thrown

    DateTimeParseException if the text cannot be parsed

  22. def parse(text: CharSequence): YearMonth

    Permalink

    Obtains an instance of YearMonth from a text string such as 2007-12.

    Obtains an instance of YearMonth from a text string such as 2007-12.

    The string must represent a valid year-month. The format must be yyyy-MM. Years outside the range 0000 to 9999 must be prefixed by the plus or minus symbol.

    text

    the text to parse such as "2007-12", not null

    returns

    the parsed year-month, not null

    Exceptions thrown

    DateTimeParseException if the text cannot be parsed

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

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

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

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped