Liking cljdoc? Tell your friends :D

jdk.time.chrono.ThaiBuddhistDate

A date in the Thai Buddhist calendar system.

This date operates using the java.time.chrono.Thai Buddhist calendar. This calendar system is primarily used in Thailand. Dates are aligned such that 2484-01-01 (Buddhist) is 1941-01-01 (ISO).

This is a value-based class; use of identity-sensitive operations (including reference equality (==), identity hash code, or synchronization) on instances of ThaiBuddhistDate may have unpredictable results and should be avoided. The equals method should be used for comparisons.

A date in the Thai Buddhist calendar system.

This date operates using the java.time.chrono.Thai Buddhist calendar.
This calendar system is primarily used in Thailand.
Dates are aligned such that 2484-01-01 (Buddhist) is 1941-01-01 (ISO).


This is a value-based
class; use of identity-sensitive operations (including reference equality
(==), identity hash code, or synchronization) on instances of
ThaiBuddhistDate may have unpredictable results and should be avoided.
The equals method should be used for comparisons.
raw docstring

*fromclj

(*from temporal)

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.

temporal - the temporal object to convert, not null - java.time.temporal.TemporalAccessor

returns: the date in Thai Buddhist calendar system, not null - java.time.chrono.ThaiBuddhistDate

throws: java.time.DateTimeException - if unable to convert to a ThaiBuddhistDate

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.

temporal - the temporal object to convert, not null - `java.time.temporal.TemporalAccessor`

returns: the date in Thai Buddhist calendar system, not null - `java.time.chrono.ThaiBuddhistDate`

throws: java.time.DateTimeException - if unable to convert to a ThaiBuddhistDate
raw docstring

*nowclj

(*now)
(*now zone)

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.

zone - the zone ID to use, not null - java.time.ZoneId

returns: the current date using the system clock, not null - java.time.chrono.ThaiBuddhistDate

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.

zone - the zone ID to use, not null - `java.time.ZoneId`

returns: the current date using the system clock, not null - `java.time.chrono.ThaiBuddhistDate`
raw docstring

*ofclj

(*of proleptic-year month day-of-month)

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.

proleptic-year - the Thai Buddhist proleptic-year - int month - the Thai Buddhist month-of-year, from 1 to 12 - int day-of-month - the Thai Buddhist day-of-month, from 1 to 31 - int

returns: the date in Thai Buddhist calendar system, not null - java.time.chrono.ThaiBuddhistDate

throws: java.time.DateTimeException - if the value of any field is out of range, or if the day-of-month is invalid for the month-year

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.

proleptic-year - the Thai Buddhist proleptic-year - `int`
month - the Thai Buddhist month-of-year, from 1 to 12 - `int`
day-of-month - the Thai Buddhist day-of-month, from 1 to 31 - `int`

returns: the date in Thai Buddhist calendar system, not null - `java.time.chrono.ThaiBuddhistDate`

throws: java.time.DateTimeException - if the value of any field is out of range, or if the day-of-month is invalid for the month-year
raw docstring

at-timeclj

(at-time this local-time)

Description copied from interface: ChronoLocalDate

local-time - the local time to use, not null - java.time.LocalTime

returns: the local date-time formed from this date and the specified time, not null - java.time.chrono.ChronoLocalDateTime<java.time.chrono.ThaiBuddhistDate>

Description copied from interface: ChronoLocalDate

local-time - the local time to use, not null - `java.time.LocalTime`

returns: the local date-time formed from this date and the specified time, not null - `java.time.chrono.ChronoLocalDateTime<java.time.chrono.ThaiBuddhistDate>`
raw docstring

equalsclj

(equals this obj)

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.

obj - the object to check, null returns false - java.lang.Object

returns: true if this is equal to the other date - boolean

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.

obj - the object to check, null returns false - `java.lang.Object`

returns: true if this is equal to the other date - `boolean`
raw docstring

get-chronologyclj

(get-chronology this)

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: the Thai Buddhist chronology, not null - java.time.chrono.ThaiBuddhistChronology

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: the Thai Buddhist chronology, not null - `java.time.chrono.ThaiBuddhistChronology`
raw docstring

get-eraclj

(get-era this)

Gets the era applicable at this date.

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

returns: the era applicable at this date, not null - java.time.chrono.ThaiBuddhistEra

Gets the era applicable at this date.

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

returns: the era applicable at this date, not null - `java.time.chrono.ThaiBuddhistEra`
raw docstring

get-longclj

(get-long this field)

Description copied from interface: TemporalAccessor

field - the field to get, not null - java.time.temporal.TemporalField

returns: the value for the field - long

Description copied from interface: TemporalAccessor

field - the field to get, not null - `java.time.temporal.TemporalField`

returns: the value for the field - `long`
raw docstring

hash-codeclj

(hash-code this)

A hash code for this date.

returns: a suitable hash code based only on the Chronology and the date - int

A hash code for this date.

returns: a suitable hash code based only on the Chronology and the date - `int`
raw docstring

length-of-monthclj

(length-of-month this)

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: the length of the month in days - int

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: the length of the month in days - `int`
raw docstring

minusclj

(minus this amount)
(minus this amount-to-add unit)

Description copied from interface: ChronoLocalDate

amount-to-add - the amount of the specified unit to subtract, may be negative - long unit - the unit of the amount to subtract, not null - java.time.temporal.TemporalUnit

returns: an object of the same type with the specified period subtracted, not null - java.time.chrono.ThaiBuddhistDate

Description copied from interface: ChronoLocalDate

amount-to-add - the amount of the specified unit to subtract, may be negative - `long`
unit - the unit of the amount to subtract, not null - `java.time.temporal.TemporalUnit`

returns: an object of the same type with the specified period subtracted, not null - `java.time.chrono.ThaiBuddhistDate`
raw docstring

plusclj

(plus this amount)
(plus this amount-to-add unit)

Description copied from interface: ChronoLocalDate

amount-to-add - the amount of the specified unit to add, may be negative - long unit - the unit of the amount to add, not null - java.time.temporal.TemporalUnit

returns: an object of the same type with the specified period added, not null - java.time.chrono.ThaiBuddhistDate

Description copied from interface: ChronoLocalDate

amount-to-add - the amount of the specified unit to add, may be negative - `long`
unit - the unit of the amount to add, not null - `java.time.temporal.TemporalUnit`

returns: an object of the same type with the specified period added, not null - `java.time.chrono.ThaiBuddhistDate`
raw docstring

rangeclj

(range this field)

Description copied from interface: TemporalAccessor

field - the field to query the range for, not null - java.time.temporal.TemporalField

returns: the range of valid values for the field, not null - java.time.temporal.ValueRange

Description copied from interface: TemporalAccessor

field - the field to query the range for, not null - `java.time.temporal.TemporalField`

returns: the range of valid values for the field, not null - `java.time.temporal.ValueRange`
raw docstring

to-epoch-dayclj

(to-epoch-day this)

Description copied from interface: ChronoLocalDate

returns: the Epoch Day equivalent to this date - long

Description copied from interface: ChronoLocalDate

returns: the Epoch Day equivalent to this date - `long`
raw docstring

to-stringclj

(to-string this)

Description copied from class: Object

returns: a string representation of the object. - java.lang.String

Description copied from class: Object

returns: a string representation of the object. - `java.lang.String`
raw docstring

untilclj

(until this end-date)
(until this end-exclusive unit)

Description copied from interface: ChronoLocalDate

end-exclusive - the end date, exclusive, which is converted to a ChronoLocalDate in the same chronology, not null - java.time.temporal.Temporal unit - the unit to measure the amount in, not null - java.time.temporal.TemporalUnit

returns: the amount of time between this date and the end date - long

Description copied from interface: ChronoLocalDate

end-exclusive - the end date, exclusive, which is converted to a ChronoLocalDate in the same chronology, not null - `java.time.temporal.Temporal`
unit - the unit to measure the amount in, not null - `java.time.temporal.TemporalUnit`

returns: the amount of time between this date and the end date - `long`
raw docstring

withclj

(with this adjuster)
(with this field new-value)

Description copied from interface: ChronoLocalDate

field - the field to set in the result, not null - java.time.temporal.TemporalField new-value - the new value of the field in the result - long

returns: an object of the same type with the specified field set, not null - java.time.chrono.ThaiBuddhistDate

Description copied from interface: ChronoLocalDate

field - the field to set in the result, not null - `java.time.temporal.TemporalField`
new-value - the new value of the field in the result - `long`

returns: an object of the same type with the specified field set, not null - `java.time.chrono.ThaiBuddhistDate`
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close