HijrahDate

atTime

fun atTime(localTime: LocalTime!): ChronoLocalDateTime<HijrahDate!>!

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.

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.

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.

getEra

fun getEra(): HijrahEra!

Gets the era applicable at this date.

The Hijrah calendar system has one era, 'AH', defined by HijrahEra.

getLong

fun getLong(field: TemporalField!): Long

hashCode

fun hashCode(): Int

A hash code for this date.

isLeapYear

fun isLeapYear(): Boolean

Checks if the year is a leap year, according to the Hijrah calendar system rules.

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.

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.

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.

minus

fun minus(
    amountToSubtract: Long, 
    unit: TemporalUnit!
): HijrahDate!

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.

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.

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.

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.

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.

plus

fun plus(
    amountToAdd: Long, 
    unit: TemporalUnit!
): HijrahDate!

range

fun range(field: TemporalField!): ValueRange!

toEpochDay

fun toEpochDay(): Long

toString

fun toString(): String

until

fun until(endDate: ChronoLocalDate!): ChronoPeriod!

until

fun until(
    endExclusive: Temporal!, 
    unit: TemporalUnit!
): Long

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
  

with

fun with(
    field: TemporalField!, 
    newValue: Long
): HijrahDate!

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.