Package net.time4j.range

Class CalendarMonth

java.lang.Object

net.time4j.engine.ChronoEntity<T>

net.time4j.range.FixedCalendarInterval<CalendarMonth>

net.time4j.range.CalendarMonth

All Implemented Interfaces:

Serializable, Comparable<CalendarMonth>, Iterable<PlainDate>, TemporalAccessor, ChronoDisplay, ThreetenAdapter, LocalizedPatternSupport, ChronoInterval<PlainDate>

@CalendarType("iso8601")
public final class CalendarMonth
extends FixedCalendarInterval<CalendarMonth>
implements ThreetenAdapter, LocalizedPatternSupport

Represents the month of a gregorian calendar year as interval (like from 1st of January until end of January).

The elements registered by this class are:

• YEAR
• MONTH_OF_YEAR
• MONTH_AS_NUMBER

Formatting example for localized styles:

    ChronoFormatter<CalendarMonth> usStyle =
      ChronoFormatter.ofStyle(DisplayMode.SHORT, Locale.US, CalendarMonth.chronology());
    ChronoFormatter<CalendarMonth> germanStyle =
      ChronoFormatter.ofStyle(DisplayMode.SHORT, Locale.GERMANY, CalendarMonth.chronology());
    System.out.println("US-format: " + usStyle.format(CalendarMonth.of(2016, 5))); // US-format: 5/2016
    System.out.println("German: " + germanStyle.format(CalendarMonth.of(2016, 5))); // German: 5.2016
 

Note: The current month of calendar year can be determined by an expression like: nowInSystemTime() or in a more general way CalendarMonth current = SystemClock.inLocalView().now(CalendarMonth.chronology()).

Since:

3.21/4.17

Author:

Meno Hochschild

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static ChronoElement<Integer>	MONTH_AS_NUMBER	Element with the month as number in the value range 1 - 12.
static ChronoElement<Month>	MONTH_OF_YEAR	Element with the month of year in the value range January - December.
static ChronoElement<Integer>	YEAR	Element with the proleptic iso-year without any era reference and the value range -999999999 until 999999999.

Method Summary

Modifier and Type	Method	Description
PlainDate	atDayOfMonth(int dayOfMonth)	Combines this year and month with given day of month to a calendar date.
PlainDate	atEndOfMonth()	Yields the date of the end of this calendar month.
static Chronology<CalendarMonth>	chronology()	Yields the associated chronology.
int	compareTo(CalendarMonth other)
boolean	contains(PlainDate temporal)	Queries if given time point belongs to this interval.
boolean	equals(Object obj)
static CalendarMonth	from(YearMonth yearMonth)	Converts given JSR-310-type to a calendar month.
static CalendarMonth	from(GregorianDate date)	Converts given gregorian date to a calendar month.
Boundary<PlainDate>	getEnd()	Yields the upper bound of this interval.
Month	getMonth()	Yields the month as enum.
Boundary<PlainDate>	getStart()	Yields the lower bound of this interval.
int	getYear()	Yields the year number.
int	hashCode()
boolean	isAfter(PlainDate temporal)	Is this interval after the given time point?
boolean	isBefore(PlainDate temporal)	Is this interval before the given time point?
Iterator<PlainDate>	iterator()	Iterates over all days of this calendar month.
int	length()	Determines the count of days belonging to this month.
CalendarMonth	minus(Months months)	Subtracts given months from this calendar month.
CalendarMonth	minus(Years<CalendarUnit> years)	Subtracts given years from this calendar month.
static CalendarMonth	nowInSystemTime()	Obtains the current calendar month in system time.
static CalendarMonth	of(int year, int month)	Creates a new instance based on given gregorian calendar year and month.
static CalendarMonth	of(int year, Month month)	Creates a new instance based on given gregorian calendar year and month.
static CalendarMonth	parseISO(String text)	Interpretes given ISO-conforming text as calendar month.
CalendarMonth	plus(Months months)	Adds given months to this calendar month.
CalendarMonth	plus(Years<CalendarUnit> years)	Adds given years to this calendar month.
static Chronology<YearMonth>	threeten()	Obtains a bridge chronology for the type java.time.YearMonth.
static TimeLine<CalendarMonth>	timeline()	Obtains a timeline for this type.
String	toString()	Outputs this instance as a String in CLDR-format "uuuu-MM" (like "2016-10").
YearMonth	toTemporalAccessor()	Converts this object to a TemporalAccessor.

Methods inherited from class net.time4j.range.FixedCalendarInterval

abuts, contains, isBefore, isEmpty, isFinite, isSimultaneous, streamDaily, toFlexInterval, withValue

Methods inherited from class net.time4j.engine.ChronoEntity

contains, get, get, getInt, getMaximum, getMinimum, getRegisteredElements, getTimezone, hasTimezone, isValid, isValid, isValid, matches, with, with, with, with

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.time4j.range.ChronoInterval

intersects, isAfter

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface net.time4j.format.LocalizedPatternSupport

getFormatPattern, getFormatPattern, useDynamicFormatPattern

Methods inherited from interface net.time4j.engine.ThreetenAdapter

get, getLong, isSupported, query, range

Field Details

YEAR

@FormattableElement(format="u")
public static final ChronoElement<Integer> YEAR

Element with the proleptic iso-year without any era reference and the value range -999999999 until 999999999.

The term "proleptic" means that the rules of the gregorian calendar and the associated way of year counting is applied backward even before the introduction of gregorian calendar. The year 0 is permitted - and negative years, too. For historic year numbers, this mathematical extrapolation is not recommended and usually wrong.

MONTH_OF_YEAR

@FormattableElement(format="M",
                    alt="L")
public static final ChronoElement<Month> MONTH_OF_YEAR

Element with the month of year in the value range January - December.

MONTH_AS_NUMBER

public static final ChronoElement<Integer> MONTH_AS_NUMBER

Element with the month as number in the value range 1 - 12.

Method Details

of

public static CalendarMonth of(int year,
 int month)

Creates a new instance based on given gregorian calendar year and month.

Parameters:

year - gregorian year within range -999,999,999 / +999,999,999

month - gregorian month in range 1-12

Returns:

new instance

Throws:

IllegalArgumentException - if any argument is out of range

of

public static CalendarMonth of(int year,
 Month month)

Creates a new instance based on given gregorian calendar year and month.

Parameters:

year - gregorian year within range -999,999,999 / +999,999,999

month - gregorian month

Returns:

new instance

Throws:

IllegalArgumentException - if given year is out of range

nowInSystemTime

public static CalendarMonth nowInSystemTime()

Obtains the current calendar month in system time.

Convenient short-cut for: SystemClock.inLocalView().now(CalendarMonth.chronology()).

Returns:

current calendar month in system time zone using the system clock

Since:

3.24/4.20

See Also:

SystemClock.inLocalView(), ZonalClock.now(net.time4j.engine.Chronology)

atDayOfMonth

public PlainDate atDayOfMonth(int dayOfMonth)

Combines this year and month with given day of month to a calendar date.

Parameters:

dayOfMonth - day of month in range 1-28/29/30/31

Returns:

calendar date

Throws:

IllegalArgumentException - if the day-of-month is out of range

atEndOfMonth

public PlainDate atEndOfMonth()

Yields the date of the end of this calendar month.

Returns:

PlainDate

getYear

public int getYear()

Yields the year number.

Returns:

int

getMonth

public Month getMonth()

Yields the month as enum.

User who wish to get the month as integer can use the expression getMonth().getValue().

Returns:

Month

getStart

public Boundary<PlainDate> getStart()

Description copied from interface: ChronoInterval

Yields the lower bound of this interval.

Specified by:

getStart in interface ChronoInterval<PlainDate>

Returns:

start interval boundary

getEnd

public Boundary<PlainDate> getEnd()

Description copied from interface: ChronoInterval

Yields the upper bound of this interval.

Specified by:

getEnd in interface ChronoInterval<PlainDate>

Returns:

end interval boundary

contains

public boolean contains(PlainDate temporal)

Description copied from interface: ChronoInterval

Queries if given time point belongs to this interval.

Specified by:

contains in interface ChronoInterval<PlainDate>

Parameters:

temporal - time point to be queried

Returns:

true if given time point belongs to this interval else false

isAfter

public boolean isAfter(PlainDate temporal)

Description copied from interface: ChronoInterval

Is this interval after the given time point?

Specified by:

isAfter in interface ChronoInterval<PlainDate>

Parameters:

temporal - reference time point

Returns:

true if this interval is after given time point else false

isBefore

public boolean isBefore(PlainDate temporal)

Description copied from interface: ChronoInterval

Is this interval before the given time point?

Specified by:

isBefore in interface ChronoInterval<PlainDate>

Parameters:

temporal - reference time point

Returns:

true if this interval is before given time point else false

length

public int length()

Determines the count of days belonging to this month.

Returns:

int

from

public static CalendarMonth from(GregorianDate date)

Converts given gregorian date to a calendar month.

Parameters:

date - gregorian calendar date (for example PlainDate

Returns:

CalendarMonth

Throws:

IllegalArgumentException - if given date is invalid

Since:

3.28/4.24

from

public static CalendarMonth from(YearMonth yearMonth)

Converts given JSR-310-type to a calendar month.

Parameters:

yearMonth - Threeten-equivalent of this instance

Returns:

CalendarMonth

See Also:

toTemporalAccessor()

plus

public CalendarMonth plus(Years<CalendarUnit> years)

Adds given years to this calendar month.

Parameters:

years - the count of years to be added

Returns:

result of addition

plus

public CalendarMonth plus(Months months)

Adds given months to this calendar month.

Parameters:

months - the count of months to be added

Returns:

result of addition

minus

public CalendarMonth minus(Years<CalendarUnit> years)

Subtracts given years from this calendar month.

Parameters:

years - the count of years to be subtracted

Returns:

result of subtraction

minus

public CalendarMonth minus(Months months)

Subtracts given months from this calendar month.

Parameters:

months - the count of months to be subtracted

Returns:

result of subtraction

compareTo

public int compareTo(CalendarMonth other)

Specified by:

compareTo in interface Comparable<CalendarMonth>

iterator

public Iterator<PlainDate> iterator()

Iterates over all days of this calendar month.

Specified by:

iterator in interface Iterable<PlainDate>

Returns:

Iterator

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Outputs this instance as a String in CLDR-format "uuuu-MM" (like "2016-10").

Overrides:

toString in class Object

Returns:

String

See Also:

parseISO(String)

parseISO

public static CalendarMonth parseISO(String text)
                              throws ParseException

Interpretes given ISO-conforming text as calendar month.

The underlying parser uses the CLDR-pattern "uuuu-MM|uuuuMM".

Parameters:

text - text to be parsed

Returns:

parsed calendar month

Throws:

IndexOutOfBoundsException - if given text is empty

ParseException - if the text is not parseable

See Also:

toString()

toTemporalAccessor

public YearMonth toTemporalAccessor()

Description copied from interface: ThreetenAdapter

Converts this object to a TemporalAccessor.

Any implementation is required to return a new object with a different concrete type, not this instance.

Specified by:

toTemporalAccessor in interface ThreetenAdapter

Returns:

converted Threeten-object (always as new object)

chronology

public static Chronology<CalendarMonth> chronology()

Yields the associated chronology.

Returns:

the underlying rule engine

threeten

public static Chronology<YearMonth> threeten()

Obtains a bridge chronology for the type java.time.YearMonth.

Returns:

rule engine adapted for the type java.time.YearMonth

See Also:

chronology()

timeline

public static TimeLine<CalendarMonth> timeline()

Obtains a timeline for this type.

Returns:

singleton timeline

Since:

5.0