Class BSLocalDate

Checks if this date is after the specified date.

This checks to see if this date represents a point on the local time-line after the other date.

   const a = ILocalDate.ofBS(2077, 6, 20)
   const b = ILocalDate.ofBS(2077, 7, 1)
  a.after(b) == false
  a.after(a) == false
  b.after(a) == true

Returns

true if this date is after the specified date

Checks if this date is before the specified date.

This checks to see if this date represents a point on the local time-line before the other date.

   const a = ILocalDate.ofBS(2077, 6, 20)
   const b = ILocalDate.ofBS(2077, 7, 1)
  a.before(b) == true
  a.before(a) == false
  b.before(a) == false

This method only considers the position of the two dates on the local time-line. It does not take into account the chronology, or calendar system. This is different from the comparison in [#compareTo(ChronoLocalDate)](../modules.html), but is the same approach as ChronoLocalDate#timeLineOrder().

Returns

true if this date is before the specified date

Compares this date to another date.

The comparison is primarily based on the date, from earliest to latest. It is "consistent with equals", as defined by Comparable.

If all the dates being compared are instances of {@code ILocalDate}, then the comparison will be entirely based on the date.

Returns

the comparator value, negative if less, positive if greater

Checks if this date is equal to another date.

Compares this {@code ILocalDate} with another ensuring that the date is the same.

Only objects of type {@code ILocalDate} are compared, other types return false.

Returns

true if this is equal to the other date

A hash code for this date.

Returns

a suitable hash code

Returns a copy of this {@code ILocalDate} with the specified number of days subtracted.

This method subtracts the specified amount from the days field decrementing the month and year fields as necessary to ensure the result remains valid. The result is only invalid if the maximum/minimum year is exceeded.

For example, 2009-01-01 minus one day would result in 2008-12-31.

This instance is immutable and unaffected by this method call.

Returns

a {@code ILocalDate} based on this date with the days subtracted

Returns a copy of this {@code ILocalDate} with the specified number of months subtracted.

This method subtracts the specified amount from the months field in three steps:

1. Subtract the input months from the month-of-year field
2. Check if the resulting date would be invalid
3. Adjust the day-of-month to the last valid day if necessary

For example, 2007-03-31 minus one month would result in the invalid date 2007-02-31. Instead of returning an invalid result, the last valid day of the month, 2007-02-28, is selected instead.

This instance is immutable and unaffected by this method call.

Returns

a {@code ILocalDate} based on this date with the months subtracted

Returns a copy of this {@code ILocalDate} with the specified number of years subtracted.

This method subtracts the specified amount from the years field in three steps:

1. Subtract the input years from the year field
2. Check if the resulting date would be invalid
3. Adjust the day-of-month to the last valid day if necessary

For example, 2008-02-29 (leap year) minus one year would result in the invalid date 2007-02-29 (standard year). Instead of returning an invalid result, the last valid day of the month, 2007-02-28, is selected instead.

This instance is immutable and unaffected by this method call.

Returns

a {@code ILocalDate} based on this date with the years subtracted

Returns a copy of this {@code ILocalDate} with the specified number of days added.

This method adds the specified amount to the days field incrementing the month and year fields as necessary to ensure the result remains valid. The result is only invalid if the maximum/minimum year is exceeded.

For example, 2008-12-31 plus one day would result in 2009-01-01.

This instance is immutable and unaffected by this method call.

Returns

a {@code ILocalDate} based on this date with the days added

Returns a copy of this {@code ILocalDate} with the specified number of months added.

This method adds the specified amount to the months field in three steps:

1. Add the input months to the month-of-year field
2. Check if the resulting date would be invalid
3. Adjust the day-of-month to the last valid day if necessary

For example, 2007-03-31 plus one month would result in the invalid date 2007-04-31. Instead of returning an invalid result, the last valid day of the month, 2007-04-30, is selected instead.

This instance is immutable and unaffected by this method call.

Returns

a {@code ILocalDate} based on this date with the months added

Returns a copy of this {@code ILocalDate} with the specified number of years added.

This method adds the specified amount to the years field in three steps:

1. Add the input years to the year field
2. Check if the resulting date would be invalid
3. Adjust the day-of-month to the last valid day if necessary

For example, 2008-02-29 (leap year) plus one year would result in the invalid date 2009-02-29 (standard year). Instead of returning an invalid result, the last valid day of the month, 2009-02-28, is selected instead.

This instance is immutable and unaffected by this method call.

Returns

a {@code ILocalDate} based on this date with the years added

Returns the start week of month, taking account of the weekOfMonth.

This returns the start weekDay of current month. For example, a month started with Sunday would return 0.

Returns

the starting day of month

Outputs this date as a {@code String}, such as {@code 2007-12-03 (BS)}.

The output will be in the ISO-8601 format {@code uuuu-MM-dd}.

Returns

a string representation of this date, not null

Obtains an instance of {@code ILocalDate} from a year, month and day.

This returns a {@code ILocalDate} with the specified year, month and day-of-month. The day must be valid for the year and month, otherwise an exception will be thrown.

Returns

the local date, not null