public final Class ThaiBuddhistDate

Overrides default java.time.chrono.ChronoLocalDate.atTime.

Doc from java.time.chrono.ChronoLocalDate.atTime.

Combines this date with a time to create a ChronoLocalDateTime.

This returns a ChronoLocalDateTime formed from this date at the specified time. All possible combinations of date and time are valid.

Annotations

@Override

@SuppressWarnings:unchecked

Overrides java.time.chrono.ChronoLocalDateImpl.equals.

Implements java.time.chrono.ChronoLocalDate.equals.

Compares this date to another date, including the chronology.

Compares this ThaiBuddhistDate with another ensuring that the date is the same.

Only objects of type ThaiBuddhistDate are compared, other types return false. To compare the dates of two TemporalAccessor instances, including dates in two different chronologies, use ChronoField#EPOCH_DAY as a comparator.

Parameters

obj:Object

the object to check, null returns false

Returns:boolean

true if this is equal to the other date

Annotations

@Override

Hides java.time.chrono.ChronoLocalDate.from.

Obtains a ThaiBuddhistDate from a temporal object.

This obtains a date in the Thai Buddhist calendar system based on the specified temporal. A TemporalAccessor represents an arbitrary set of date and time information, which this factory converts to an instance of ThaiBuddhistDate.

The conversion typically uses the EPOCH_DAY field, which is standardized across calendar systems.

This method matches the signature of the functional interface TemporalQuery allowing it to be used as a query via method reference, ThaiBuddhistDate::from.

Parameters

temporal:TemporalAccessor

the temporal object to convert, not null

Returns:ThaiBuddhistDate

the date in Thai Buddhist calendar system, not null

Exceptions

DateTimeException:

if unable to convert to a ThaiBuddhistDate

Implements java.time.chrono.ChronoLocalDate.getChronology.

Gets the chronology of this date, which is the Thai Buddhist calendar system.

The Chronology represents the calendar system in use. The era and other fields in ChronoField are defined by the chronology.

Returns:ThaiBuddhistChronology

the Thai Buddhist chronology, not null

Annotations

@Override

Overrides default java.time.chrono.ChronoLocalDate.getEra.

Gets the era applicable at this date.

The Thai Buddhist calendar system has two eras, 'BE' and 'BEFORE_BE', defined by ThaiBuddhistEra.

Returns:ThaiBuddhistEra

the era applicable at this date, not null

Annotations

@Override

Implements java.time.temporal.TemporalAccessor.getLong.

Doc from java.time.temporal.TemporalAccessor.getLong.

Gets the value of the specified field as a long.

This queries the date-time for the value of the specified field. The returned value may be outside the valid range of values for the field. If the date-time cannot return the value, because the field is unsupported or for some other reason, an exception will be thrown.

Annotations

@Override

Overrides java.time.chrono.ChronoLocalDateImpl.hashCode.

Implements java.time.chrono.ChronoLocalDate.hashCode.

A hash code for this date.

Returns:int

a suitable hash code based only on the Chronology and the date

Annotations

@Override

Implements java.time.chrono.ChronoLocalDate.lengthOfMonth.

Returns the length of the month represented by this date.

This returns the length of the month in days. Month lengths match those of the ISO calendar system.

Returns:int

the length of the month in days

Annotations

@Override

Overrides java.time.chrono.ChronoLocalDateImpl.minus.

Overrides default java.time.chrono.ChronoLocalDate.minus, java.time.temporal.Temporal.minus.

Doc from java.time.chrono.ChronoLocalDate.minus.

Returns an object of the same type as this object with an amount subtracted.

This adjusts this temporal, subtracting according to the rules of the specified amount. The amount is typically a java.time.Period but may be any other type implementing the TemporalAmount interface, such as java.time.Duration.

Some example code indicating how and why this method is used:

 date = date.minus(period);               // subtract a Period instance
 date = date.minus(duration);             // subtract a Duration instance
 date = date.minus(workingDays(6));       // example user-written workingDays method

Note that calling plus followed by minus is not guaranteed to return the same date-time.

Annotations

@Override

Exceptions

DateTimeException:

if the subtraction cannot be made

ArithmeticException:

if numeric overflow occurs

Overrides java.time.chrono.ChronoLocalDateImpl.minus.

Overrides default java.time.chrono.ChronoLocalDate.minus, java.time.temporal.Temporal.minus.

Doc from java.time.chrono.ChronoLocalDate.minus.

Returns an object of the same type as this object with the specified period subtracted.

This method returns a new object based on this one with the specified period subtracted. For example, on a LocalDate, this could be used to subtract a number of years, months or days. The returned object will have the same observable type as this object.

In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st March, then subtracting one month would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.

Annotations

@Override

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

This will query the system clock in the default time-zone to obtain the current date.

Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.

Returns:ThaiBuddhistDate

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

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

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

Parameters

zone:ZoneId

the zone ID to use, not null

Returns:ThaiBuddhistDate

the current date using the system clock, not null

Obtains the current ThaiBuddhistDate from the specified clock.

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

Parameters

clock:Clock

the clock to use, not null

Returns:ThaiBuddhistDate

the current date, not null

Exceptions

DateTimeException:

if the current date cannot be obtained

Obtains a ThaiBuddhistDate representing a date in the Thai Buddhist calendar system from the proleptic-year, month-of-year and day-of-month fields.

This returns a ThaiBuddhistDate with the specified fields. The day must be valid for the year and month, otherwise an exception will be thrown.

Parameters

prolepticYear:int

the Thai Buddhist proleptic-year

month:int

the Thai Buddhist month-of-year, from 1 to 12

dayOfMonth:int

the Thai Buddhist day-of-month, from 1 to 31

Returns:ThaiBuddhistDate

the date in Thai Buddhist calendar system, not null

Exceptions

DateTimeException:

if the value of any field is out of range, or if the day-of-month is invalid for the month-year

Overrides java.time.chrono.ChronoLocalDateImpl.plus.

Overrides default java.time.chrono.ChronoLocalDate.plus, java.time.temporal.Temporal.plus.

Doc from java.time.chrono.ChronoLocalDate.plus.

Returns an object of the same type as this object with an amount added.

This adjusts this temporal, adding according to the rules of the specified amount. The amount is typically a java.time.Period but may be any other type implementing the TemporalAmount interface, such as java.time.Duration.

Some example code indicating how and why this method is used:

 date = date.plus(period);                // add a Period instance
 date = date.plus(duration);              // add a Duration instance
 date = date.plus(workingDays(6));        // example user-written workingDays method

Note that calling plus followed by minus is not guaranteed to return the same date-time.

Annotations

@Override

Exceptions

DateTimeException:

if the addition cannot be made

ArithmeticException:

if numeric overflow occurs

Overrides java.time.chrono.ChronoLocalDateImpl.plus.

Overrides default java.time.chrono.ChronoLocalDate.plus.

Implements java.time.temporal.Temporal.plus.

Doc from java.time.chrono.ChronoLocalDate.plus.

Returns an object of the same type as this object with the specified period added.

This method returns a new object based on this one with the specified period added. For example, on a LocalDate, this could be used to add a number of years, months or days. The returned object will have the same observable type as this object.

In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st January, then adding one month would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.

Annotations

@Override

Overrides default java.time.temporal.TemporalAccessor.range.

Doc from java.time.temporal.TemporalAccessor.range.

Gets the range of valid values for the specified field.

All fields can be expressed as a long integer. This method returns an object that describes the valid range for that value. The value of this temporal object is used to enhance the accuracy of the returned range. If the date-time cannot return the range, because the field is unsupported or for some other reason, an exception will be thrown.

Note that the result only describes the minimum and maximum valid values and it is important not to read too much into them. For example, there could be values within the range that are invalid for the field.

Annotations

@Override

Overrides default java.time.chrono.ChronoLocalDate.toEpochDay.

Doc from java.time.chrono.ChronoLocalDate.toEpochDay.

Converts this date to the Epoch Day.

The Epoch Day count is a simple incrementing count of days where day 0 is 1970-01-01 (ISO). This definition is the same for all chronologies, enabling conversion.

This default implementation queries the EPOCH_DAY field.

Annotations

@Override

Implements java.time.chrono.ChronoLocalDate.until.

Doc from java.time.chrono.ChronoLocalDate.until.

Calculates the period between this date and another date as a ChronoPeriod.

This calculates the period between two dates. All supplied chronologies calculate the period using years, months and days, however the ChronoPeriod API allows the period to be represented using other units.

The start and end points are this and the specified date. The result will be negative if the end is before the start. The negative sign will be the same in each of year, month and day.

The calculation is performed using the chronology of this date. If necessary, the input date will be converted to match.

This instance is immutable and unaffected by this method call.

Annotations

@Override

Overrides java.time.chrono.ChronoLocalDateImpl.with.

Overrides default java.time.chrono.ChronoLocalDate.with.

Implements java.time.temporal.Temporal.with.

Doc from java.time.chrono.ChronoLocalDate.with.

Returns an object of the same type as this object with the specified field altered.

This returns a new object based on this one with the value for the specified field changed. For example, on a LocalDate, this could be used to set the year, month or day-of-month. The returned object will have the same observable type as this object.

In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st January, then changing the month to February would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.

Annotations

@Override

Overrides java.time.chrono.ChronoLocalDateImpl.with.

Overrides default java.time.chrono.ChronoLocalDate.with, java.time.temporal.Temporal.with.

Doc from java.time.chrono.ChronoLocalDate.with.

Returns an adjusted object of the same type as this object with the adjustment made.

This adjusts this date-time according to the rules of the specified adjuster. A simple adjuster might simply set the one of the fields, such as the year field. A more complex adjuster might set the date to the last day of the month. A selection of common adjustments is provided in TemporalAdjusters. These include finding the "last day of the month" and "next Wednesday". The adjuster is responsible for handling special cases, such as the varying lengths of month and leap years.

Some example code indicating how and why this method is used:

 date = date.with(Month.JULY);        // most key classes implement TemporalAdjuster
 date = date.with(lastDayOfMonth());  // static import from Adjusters
 date = date.with(next(WEDNESDAY));   // static import from Adjusters and DayOfWeek

Annotations

@Override

Exceptions

DateTimeException:

if unable to make the adjustment

ArithmeticException:

if numeric overflow occurs