org.sellcom.geotemporal.time

Class Months

java.lang.Object

org.sellcom.geotemporal.time.Months

public class Months
extends Object

Operations with Months.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
static boolean	isAfter(Month former, Month latter) Checks whether the given former month follows the given latter month.
static boolean	isBefore(Month former, Month latter) Checks whether the given former month precedes the given latter month.
static boolean	isInRange(Month month, Month startMonth, Month endMonth) Checks whether the given month is within the range of the given months.
static Month	next(Month month) Returns the month following the given month.
static Month	previous(Month month) Returns the month preceding the given month.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isAfter

public static boolean isAfter(Month former,
                              Month latter)

Checks whether the given former month follows the given latter month.

Throws:

IllegalArgumentException - if former is null

IllegalArgumentException - if latter is null

Since:

1.0

isBefore

public static boolean isBefore(Month former,
                               Month latter)

Checks whether the given former month precedes the given latter month.

Throws:

IllegalArgumentException - if former is null

IllegalArgumentException - if latter is null

Since:

1.0

isInRange

public static boolean isInRange(Month month,
                                Month startMonth,
                                Month endMonth)

Checks whether the given month is within the range of the given months. Both the start month and the end month are inclusive and the range may wrap around the end of the year.

Throws:

IllegalArgumentException - if month is null

IllegalArgumentException - if startMonth is null

IllegalArgumentException - if endMonth is null

Since:

1.0

next

public static Month next(Month month)

Returns the month following the given month.

Throws:

IllegalArgumentException - if month is null

Since:

1.0

previous

public static Month previous(Month month)

Returns the month preceding the given month.

Throws:

IllegalArgumentException - if month is null

Since:

1.0