agi.foundation.time

(agi.foundation.core-2024r3.jar)

Class YearMonthDay

java.lang.Object

agi.foundation.time.YearMonthDay

All Implemented Interfaces:

IEquatable<YearMonthDay>, ImmutableValueType, ValueType, Comparable<YearMonthDay>

public final class YearMonthDay
extends Object
implements Comparable<YearMonthDay>, IEquatable<YearMonthDay>, ImmutableValueType

Represents a calendar year, month, and day.

Constructor Summary

Constructors

Constructor and Description
YearMonthDay() Initializes a new instance.
YearMonthDay(int astronomicalJulianDayNumber) Initializes a YearMonthDay in the Gregorian calendar from the provided astronomical Julian day number, assuming the beginning of the Julian day (noon).
YearMonthDay(int year, int dayOfYear) Initializes a YearMonthDay from the provided values.
YearMonthDay(int year, int month, int day) Initializes a YearMonthDay from the provided values.
YearMonthDay(JulianDate date) Initializes a new instance from a JulianDate.

Method Summary

Modifier and Type	Method and Description
int	compareTo(YearMonthDay other) Compares this instance with another instance of the same type.
static int	daysInMonth(int year, int month) Provides the number of days in the month of the indicated year.
static int	daysInYear(int year) Provides the number of days in the indicated year.
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
static boolean	equals(YearMonthDay left, YearMonthDay right) Returns true if the two instances are exactly equal.
boolean	equalsType(YearMonthDay other) Indicates whether another instance of this type is exactly equal to this instance.
int	getDay() Gets the day of the month (in the range 1 through the number of days in the month).
DayOfWeek	getDayOfWeek() Gets the day of the week represented by this instance.
int	getDayOfYear() Gets the day of the year (in the range 1 through the number of days in the year).
int	getJulianDayNumber() Gets the Julian day number for this YearMonthDay instance, assuming noon on this day.
int	getMonth() Gets the month of the year (in the range 1 through 12).
int	getYear() Gets the year.
static boolean	greaterThan(YearMonthDay left, YearMonthDay right) Returns true if left is greater than right.
static boolean	greaterThanOrEqual(YearMonthDay left, YearMonthDay right) Returns true if left is greater than or equal to right.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
static boolean	isLeapYear(int year) Indicates whether the year in question is a leap year.
static boolean	isValidDate(int year, int month, int day) Indicates whether the year, month, and day are a valid representation.
static boolean	lessThan(YearMonthDay left, YearMonthDay right) Returns true if left is less than right.
static boolean	lessThanOrEqual(YearMonthDay left, YearMonthDay right) Returns true if left is less than or equal to right.
static boolean	notEquals(YearMonthDay left, YearMonthDay right) Returns true if the two instances are not exactly equal.
String	toString() Returns a string formatted as Year:Month:Day

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

YearMonthDay

public YearMonthDay()

Initializes a new instance.

YearMonthDay

public YearMonthDay(int year,
                    int month,
                    int day)

Initializes a YearMonthDay from the provided values.

Parameters:

year - The year.

month - The month of the year (in the range 1 through 12)

day - The day of the month (in the range 1 through the number of days in month)

Throws:

ArgumentException - Thrown when the year, month, or day is outside of its acceptable range.

YearMonthDay

public YearMonthDay(int year,
                    int dayOfYear)

Initializes a YearMonthDay from the provided values.

Parameters:

year - The year.

dayOfYear - The day of the year (in the range 1 through the number of days in the year).

YearMonthDay

public YearMonthDay(int astronomicalJulianDayNumber)

Initializes a YearMonthDay in the Gregorian calendar from the provided astronomical Julian day number, assuming the beginning of the Julian day (noon).

Parameters:

astronomicalJulianDayNumber - The astronomical Julian day number.

YearMonthDay

public YearMonthDay(@Nonnull
                    JulianDate date)

Initializes a new instance from a JulianDate.

Parameters:

date - The date.

Method Detail

getYear

public final int getYear()

Gets the year.

getMonth

public final int getMonth()

Gets the month of the year (in the range 1 through 12).

getDay

public final int getDay()

Gets the day of the month (in the range 1 through the number of days in the month).

getDayOfYear

public final int getDayOfYear()

Gets the day of the year (in the range 1 through the number of days in the year).

getDayOfWeek

@Nonnull
public final DayOfWeek getDayOfWeek()

Gets the day of the week represented by this instance.

Returns:

A DayOfWeek (get) enumerated constant that indicates the day of the week. This property value ranges from zero, indicating Sunday, to six, indicating Saturday.

getJulianDayNumber

public final int getJulianDayNumber()

Gets the Julian day number for this YearMonthDay instance, assuming noon on this day.

isLeapYear

public static boolean isLeapYear(int year)

Indicates whether the year in question is a leap year.

Parameters:

year - The year.

Returns:

true if year is a leap year and false if it is not.

daysInMonth

public static int daysInMonth(int year,
                              int month)

Provides the number of days in the month of the indicated year.

Parameters:

year - The year.

month - The month of the year.

Returns:

The number of days in the month.

daysInYear

public static int daysInYear(int year)

Provides the number of days in the indicated year.

Parameters:

year - The year.

Returns:

The number of days in the year (365 for a common year and 366 for a leap year).

isValidDate

public static boolean isValidDate(int year,
                                  int month,
                                  int day)

Indicates whether the year, month, and day are a valid representation.

Parameters:

year - The year.

month - The month of the year (in the range 1 through 12)

day - The day of the month (in the range 1 through the number of days in month)

Returns:

true if the representation is valid and false if it is not.

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

equalsType

public final boolean equalsType(@Nonnull
                                YearMonthDay other)

Indicates whether another instance of this type is exactly equal to this instance.

Specified by:

equalsType in interface IEquatable<YearMonthDay>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

toString

public String toString()

Returns a string formatted as Year:Month:Day

Overrides:

toString in class Object

Returns:

The string.

compareTo

public final int compareTo(@Nonnull
                           YearMonthDay other)

Compares this instance with another instance of the same type.

Specified by:

compareTo in interface Comparable<YearMonthDay>

Parameters:

other - An object to compare with this instance.

Returns:

A value indicating the relative order of the objects being compared. The return value has these meanings:

Value	Meaning
Less than zero	This instance is less than other.
Zero	This instance is equal to other.
Greater than zero	This instance is greater than other.

equals

public static boolean equals(@Nonnull
                             YearMonthDay left,
                             @Nonnull
                             YearMonthDay right)

Returns true if the two instances are exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left represents the same value as right; otherwise false.

notEquals

public static boolean notEquals(@Nonnull
                                YearMonthDay left,
                                @Nonnull
                                YearMonthDay right)

Returns true if the two instances are not exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left does not represent the same value as right; otherwise false.

lessThan

public static boolean lessThan(@Nonnull
                               YearMonthDay left,
                               @Nonnull
                               YearMonthDay right)

Returns true if left is less than right.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left is less than right; otherwise false.

greaterThan

public static boolean greaterThan(@Nonnull
                                  YearMonthDay left,
                                  @Nonnull
                                  YearMonthDay right)

Returns true if left is greater than right.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left is greater than right; otherwise false.

lessThanOrEqual

public static boolean lessThanOrEqual(@Nonnull
                                      YearMonthDay left,
                                      @Nonnull
                                      YearMonthDay right)

Returns true if left is less than or equal to right.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left is less than or equal to right; otherwise false.

greaterThanOrEqual

public static boolean greaterThanOrEqual(@Nonnull
                                         YearMonthDay left,
                                         @Nonnull
                                         YearMonthDay right)

Returns true if left is greater than or equal to right.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left is greater than or equal to right; otherwise false.