HijrahDate
class HijrahDate : ChronoLocalDate, Temporal, TemporalAdjuster, Serializable
kotlin.Any | |
↳ | java.time.chrono.HijrahDate |
A date in the Hijrah calendar system.
This date operates using one of several variants of the Hijrah calendar.
The Hijrah calendar has a different total of days in a year than Gregorian calendar, and the length of each month is based on the period of a complete revolution of the moon around the earth (as between successive new moons). Refer to the HijrahChronology
for details of supported variants.
Each HijrahDate is created bound to a particular HijrahChronology, The same chronology is propagated to each HijrahDate computed from the date. To use a different Hijrah variant, its HijrahChronology can be used to create new HijrahDate instances. Alternatively, the withVariant
method can be used to convert to a new HijrahChronology.
Summary
Public methods | |
---|---|
ChronoLocalDateTime<HijrahDate!>! | |
Boolean |
Compares this date to another date, including the chronology. |
static HijrahDate! |
from(temporal: TemporalAccessor!) Obtains a |
HijrahChronology! |
Gets the chronology of this date, which is the Hijrah calendar system. |
HijrahEra! |
getEra() Gets the era applicable at this date. |
Long |
getLong(field: TemporalField!) |
Int |
hashCode() A hash code for this date. |
Boolean |
Checks if the year is a leap year, according to the Hijrah calendar system rules. |
Int |
Returns the length of the month represented by this date. |
Int |
Returns the length of the year represented by this date. |
HijrahDate! |
minus(amount: TemporalAmount!) Returns an object of the same type as this object with an amount subtracted. |
HijrahDate! |
minus(amountToSubtract: Long, unit: TemporalUnit!) |
static HijrahDate! |
now() Obtains the current |
static HijrahDate! |
Obtains the current |
static HijrahDate! |
Obtains the current |
static HijrahDate! |
Obtains a |
HijrahDate! |
plus(amount: TemporalAmount!) Returns an object of the same type as this object with an amount added. |
HijrahDate! |
plus(amountToAdd: Long, unit: TemporalUnit!) |
ValueRange! |
range(field: TemporalField!) |
Long | |
String |
toString() |
ChronoPeriod! |
until(endDate: ChronoLocalDate!) |
Long |
until(endExclusive: Temporal!, unit: TemporalUnit!) |
HijrahDate! |
with(field: TemporalField!, newValue: Long) |
HijrahDate! |
with(adjuster: TemporalAdjuster!) Returns an adjusted object of the same type as this object with the adjustment made. |
HijrahDate! |
withVariant(chronology: HijrahChronology!) Returns a |
Inherited functions | |
---|---|
Public methods
atTime
fun atTime(localTime: LocalTime!): ChronoLocalDateTime<HijrahDate!>!
Parameters | |
---|---|
localTime |
LocalTime!: the local time to use, not null |
Return | |
---|---|
ChronoLocalDateTime<HijrahDate!>! |
the local date-time formed from this date and the specified time, not null |
equals
fun equals(other: Any?): Boolean
Compares this date to another date, including the chronology.
Compares this HijrahDate
with another ensuring that the date is the same.
Only objects of type HijrahDate
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 |
the object to check, null returns false |
Return | |
---|---|
Boolean |
true if this is equal to the other date and the Chronologies are equal |
from
static fun from(temporal: TemporalAccessor!): HijrahDate!
Obtains a HijrahDate
of the Islamic Umm Al-Qura calendar from a temporal object.
This obtains a date in the Hijrah 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 HijrahDate
.
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, HijrahDate::from
.
Parameters | |
---|---|
temporal |
TemporalAccessor!: the temporal object to convert, not null |
Return | |
---|---|
HijrahDate! |
the date in Hijrah calendar system, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if unable to convert to a HijrahDate |
getChronology
fun getChronology(): HijrahChronology!
Gets the chronology of this date, which is the Hijrah calendar system.
The Chronology
represents the calendar system in use. The era and other fields in ChronoField
are defined by the chronology.
Return | |
---|---|
HijrahChronology! |
the Hijrah chronology, not null |
getEra
fun getEra(): HijrahEra!
Gets the era applicable at this date.
The Hijrah calendar system has one era, 'AH', defined by HijrahEra
.
Return | |
---|---|
HijrahEra! |
the era applicable at this date, not null |
getLong
fun getLong(field: TemporalField!): Long
Parameters | |
---|---|
field |
TemporalField!: the field to get, not null |
Return | |
---|---|
Long |
the value for the field |
Exceptions | |
---|---|
java.time.DateTimeException |
if a value for the field cannot be obtained |
java.time.temporal.UnsupportedTemporalTypeException |
if the field is not supported |
java.lang.ArithmeticException |
if numeric overflow occurs |
hashCode
fun hashCode(): Int
A hash code for this date.
Return | |
---|---|
Int |
a suitable hash code based only on the Chronology and the date |
isLeapYear
fun isLeapYear(): Boolean
Checks if the year is a leap year, according to the Hijrah calendar system rules.
Return | |
---|---|
Boolean |
true if this date is in a leap year |
lengthOfMonth
fun lengthOfMonth(): Int
Returns the length of the month represented by this date.
This returns the length of the month in days. Month lengths in the Hijrah calendar system vary between 29 and 30 days.
Return | |
---|---|
Int |
the length of the month in days |
lengthOfYear
fun lengthOfYear(): Int
Returns the length of the year represented by this date.
This returns the length of the year in days. A Hijrah calendar system year is typically shorter than that of the ISO calendar system.
Return | |
---|---|
Int |
the length of the year in days |
minus
fun minus(amount: TemporalAmount!): HijrahDate!
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.
Parameters | |
---|---|
amount |
TemporalAmount!: the amount to subtract, not null |
Return | |
---|---|
HijrahDate! |
an object of the same type with the specified adjustment made, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the subtraction cannot be made |
java.lang.ArithmeticException |
if numeric overflow occurs |
minus
fun minus(
amountToSubtract: Long,
unit: TemporalUnit!
): HijrahDate!
Parameters | |
---|---|
amountToSubtract |
Long: the amount of the specified unit to subtract, may be negative |
unit |
TemporalUnit!: the unit of the amount to subtract, not null |
Return | |
---|---|
HijrahDate! |
an object of the same type with the specified period subtracted, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the unit cannot be subtracted |
java.time.temporal.UnsupportedTemporalTypeException |
if the unit is not supported |
java.lang.ArithmeticException |
if numeric overflow occurs |
now
static fun now(): HijrahDate!
Obtains the current HijrahDate
of the Islamic Umm Al-Qura calendar 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.
Return | |
---|---|
HijrahDate! |
the current date using the system clock and default time-zone, not null |
now
static fun now(zone: ZoneId!): HijrahDate!
Obtains the current HijrahDate
of the Islamic Umm Al-Qura calendar 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 |
Return | |
---|---|
HijrahDate! |
the current date using the system clock, not null |
now
static fun now(clock: Clock!): HijrahDate!
Obtains the current HijrahDate
of the Islamic Umm Al-Qura calendar 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 |
Return | |
---|---|
HijrahDate! |
the current date, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the current date cannot be obtained |
of
static fun of(
prolepticYear: Int,
month: Int,
dayOfMonth: Int
): HijrahDate!
Obtains a HijrahDate
of the Islamic Umm Al-Qura calendar from the proleptic-year, month-of-year and day-of-month fields.
This returns a HijrahDate
with the specified fields. The day must be valid for the year and month, otherwise an exception will be thrown.
Parameters | |
---|---|
prolepticYear |
Int: the Hijrah proleptic-year |
month |
Int: the Hijrah month-of-year, from 1 to 12 |
dayOfMonth |
Int: the Hijrah day-of-month, from 1 to 30 |
Return | |
---|---|
HijrahDate! |
the date in Hijrah calendar system, not null |
Exceptions | |
---|---|
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 |
plus
fun plus(amount: TemporalAmount!): HijrahDate!
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.
Parameters | |
---|---|
amount |
TemporalAmount!: the amount to add, not null |
Return | |
---|---|
HijrahDate! |
an object of the same type with the specified adjustment made, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the addition cannot be made |
java.lang.ArithmeticException |
if numeric overflow occurs |
plus
fun plus(
amountToAdd: Long,
unit: TemporalUnit!
): HijrahDate!
Parameters | |
---|---|
amountToAdd |
Long: the amount of the specified unit to add, may be negative |
unit |
TemporalUnit!: the unit of the amount to add, not null |
Return | |
---|---|
HijrahDate! |
an object of the same type with the specified period added, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the unit cannot be added |
java.time.temporal.UnsupportedTemporalTypeException |
if the unit is not supported |
java.lang.ArithmeticException |
if numeric overflow occurs |
range
fun range(field: TemporalField!): ValueRange!
Parameters | |
---|---|
field |
TemporalField!: the field to query the range for, not null |
Return | |
---|---|
ValueRange! |
the range of valid values for the field, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the range for the field cannot be obtained |
java.time.temporal.UnsupportedTemporalTypeException |
if the field is not supported |
toEpochDay
fun toEpochDay(): Long
Return | |
---|---|
Long |
the Epoch Day equivalent to this date |
until
fun until(endDate: ChronoLocalDate!): ChronoPeriod!
Parameters | |
---|---|
endDateExclusive |
the end date, exclusive, which may be in any chronology, not null |
Return | |
---|---|
ChronoPeriod! |
the period between this date and the end date, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the period cannot be calculated |
java.lang.ArithmeticException |
if numeric overflow occurs |
until
fun until(
endExclusive: Temporal!,
unit: TemporalUnit!
): Long
Parameters | |
---|---|
endExclusive |
Temporal!: the end temporal, exclusive, converted to be of the same type as this object, not null |
unit |
TemporalUnit!: the unit to measure the amount in, not null |
Return | |
---|---|
Long |
the amount of time between this temporal object and the specified one in terms of the unit; positive if the specified object is later than this one, negative if it is earlier than this one |
Exceptions | |
---|---|
java.time.DateTimeException |
if the amount cannot be calculated, or the end temporal cannot be converted to the same type as this temporal |
java.time.temporal.UnsupportedTemporalTypeException |
if the unit is not supported |
java.lang.ArithmeticException |
if numeric overflow occurs |
with
fun with(
field: TemporalField!,
newValue: Long
): HijrahDate!
Parameters | |
---|---|
field |
TemporalField!: the field to set in the result, not null |
newValue |
Long: the new value of the field in the result |
Return | |
---|---|
HijrahDate! |
an object of the same type with the specified field set, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if the field cannot be set |
java.time.temporal.UnsupportedTemporalTypeException |
if the field is not supported |
java.lang.ArithmeticException |
if numeric overflow occurs |
with
fun with(adjuster: TemporalAdjuster!): HijrahDate!
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
Parameters | |
---|---|
adjuster |
TemporalAdjuster!: the adjuster to use, not null |
Return | |
---|---|
HijrahDate! |
an object of the same type with the specified adjustment made, not null |
Exceptions | |
---|---|
java.time.DateTimeException |
if unable to make the adjustment. For example, if the adjuster requires an ISO chronology |
java.lang.ArithmeticException |
if numeric overflow occurs |
withVariant
fun withVariant(chronology: HijrahChronology!): HijrahDate!
Returns a HijrahDate
with the Chronology requested.
The year, month, and day are checked against the new requested HijrahChronology. If the chronology has a shorter month length for the month, the day is reduced to be the last day of the month.
Parameters | |
---|---|
chronology |
HijrahChronology!: the new HijrahChonology, non-null |
Return | |
---|---|
HijrahDate! |
a HijrahDate with the requested HijrahChronology, non-null |