public final class HijrahDate extends Objectimplements ChronoLocalDate , Serializable
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(java.time.chrono.HijrahChronology) method can be used to convert to a new HijrahChronology.
This is a value-based class; use of identity-sensitive operations (including reference equality (==), identity hash code, or synchronization) on instances of HijrahDate may have unpredictable results and should be avoided. The equals method should be used for comparisons.
| Modifier and Type | Method and Description |
|---|---|
ChronoLocalDateTime |
atTime(LocalTime
Combines this date with a time to create a
ChronoLocalDateTime.
|
boolean |
equals(Object
Compares this date to another date, including the chronology.
|
static HijrahDate |
from(TemporalAccessor
Obtains a
HijrahDate of the Islamic Umm Al-Qura calendar from a temporal object.
|
HijrahChronology |
getChronology()
Gets the chronology of this date, which is the Hijrah calendar system.
|
HijrahEra |
getEra()
Gets the era applicable at this date.
|
long |
getLong(TemporalField
Gets the value of the specified field as a
long.
|
int |
hashCode()
A hash code for this date.
|
boolean |
isLeapYear()
Checks if the year is a leap year, according to the Hijrah calendar system rules.
|
int |
lengthOfMonth()
Returns the length of the month represented by this date.
|
int |
lengthOfYear()
Returns the length of the year represented by this date.
|
HijrahDate |
minus(long amountToSubtract, TemporalUnit
Returns an object of the same type as this object with the specified period subtracted.
|
HijrahDate |
minus(TemporalAmount
Returns an object of the same type as this object with an amount subtracted.
|
static HijrahDate |
now()
Obtains the current
HijrahDate of the Islamic Umm Al-Qura calendar in the default time-zone.
|
static HijrahDate |
now(Clock
Obtains the current
HijrahDate of the Islamic Umm Al-Qura calendar from the specified clock.
|
static HijrahDate |
now(ZoneId
Obtains the current
HijrahDate of the Islamic Umm Al-Qura calendar in the specified time-zone.
|
static HijrahDate |
of(int prolepticYear, int month, int dayOfMonth)
Obtains a
HijrahDate of the Islamic Umm Al-Qura calendar from the proleptic-year, month-of-year and day-of-month fields.
|
HijrahDate |
plus(long amountToAdd, TemporalUnit
Returns an object of the same type as this object with the specified period added.
|
HijrahDate |
plus(TemporalAmount
Returns an object of the same type as this object with an amount added.
|
ValueRange |
range(TemporalField
Gets the range of valid values for the specified field.
|
long |
toEpochDay()
Converts this date to the Epoch Day.
|
String |
toString()
Returns a string representation of the object.
|
ChronoPeriod |
until(ChronoLocalDate
Calculates the period between this date and another date as a
ChronoPeriod.
|
long |
until(Temporal
Calculates the amount of time until another date in terms of the specified unit.
|
HijrahDate |
with(TemporalAdjuster
Returns an adjusted object of the same type as this object with the adjustment made.
|
HijrahDate |
with(TemporalField
Returns an object of the same type as this object with the specified field altered.
|
HijrahDate |
withVariant(HijrahChronology
Returns a
HijrahDate with the Chronology requested.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitadjustInto, compareTo, format, isAfter, isBefore, isEqual, isSupported, isSupported, query, timeLineOrder, toString, untilgetpublic static HijrahDatenow()
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.
public static HijrahDatenow(ZoneId zone)
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.
zone - the zone ID to use, not null
public static HijrahDatenow(Clock clock)
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.
clock - the clock to use, not null
DateTimeException - if the current date cannot be obtained
public static HijrahDateof(int prolepticYear, int month, int dayOfMonth)
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.
prolepticYear - the Hijrah proleptic-year
month - the Hijrah month-of-year, from 1 to 12
dayOfMonth - the Hijrah day-of-month, from 1 to 30
DateTimeException - if the value of any field is out of range, or if the day-of-month is invalid for the month-year
public static HijrahDatefrom(TemporalAccessor temporal)
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.
from in interface
ChronoLocalDate
temporal - the temporal object to convert, not null
DateTimeException - if unable to convert to a
HijrahDate
Chronology.date(TemporalAccessor)
public HijrahChronologygetChronology()
The Chronology represents the calendar system in use. The era and other fields in ChronoField are defined by the chronology.
getChronology in interface
ChronoLocalDate
public HijrahEragetEra()
The Hijrah calendar system has one era, 'AH', defined by HijrahEra.
getEra in interface
ChronoLocalDate
public int lengthOfMonth()
This returns the length of the month in days. Month lengths in the Hijrah calendar system vary between 29 and 30 days.
lengthOfMonth in interface
ChronoLocalDate
public int lengthOfYear()
This returns the length of the year in days. A Hijrah calendar system year is typically shorter than that of the ISO calendar system.
lengthOfYear in interface
ChronoLocalDate
public ValueRangerange(TemporalField field)
TemporalAccessor
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.
range in interface
TemporalAccessor
field - the field to query the range for, not null
public long getLong(TemporalFieldfield)
TemporalAccessor
long.
This queries the date-time for the value for 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.
getLong in interface
TemporalAccessor
field - the field to get, not null
public HijrahDatewith(TemporalField field, long newValue)
ChronoLocalDate
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.
with in interface
ChronoLocalDate
with in interface
Temporal
field - the field to set in the result, not null
newValue - the new value of the field in the result
public HijrahDatewith(TemporalAdjuster adjuster)
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 TemporalAdjuster. 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 in interface
ChronoLocalDate
with in interface
Temporal
adjuster - the adjuster to use, not null
DateTimeException - if unable to make the adjustment. For example, if the adjuster requires an ISO chronology
ArithmeticException - if numeric overflow occurs
public HijrahDatewithVariant(HijrahChronology chronology)
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.
chronology - the new HijrahChonology, non-null
public HijrahDateplus(TemporalAmount amount)
This adjusts this temporal, adding according to the rules of the specified amount. The amount is typically a Period but may be any other type implementing the TemporalAmount interface, such as 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 in interface
ChronoLocalDate
plus in interface
Temporal
amount - the amount to add, not null
DateTimeException - if the addition cannot be made
ArithmeticException - if numeric overflow occurs
public HijrahDateminus(TemporalAmount amount)
This adjusts this temporal, subtracting according to the rules of the specified amount. The amount is typically a Period but may be any other type implementing the TemporalAmount interface, such as 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 in interface
ChronoLocalDate
minus in interface
Temporal
amount - the amount to subtract, not null
DateTimeException - if the subtraction cannot be made
ArithmeticException - if numeric overflow occurs
public long toEpochDay()
ChronoLocalDate
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.
toEpochDay in interface
ChronoLocalDate
public boolean isLeapYear()
isLeapYear in interface
ChronoLocalDate
public HijrahDateplus(long amountToAdd, TemporalUnit unit)
ChronoLocalDate
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.
plus in interface
ChronoLocalDate
plus in interface
Temporal
amountToAdd - the amount of the specified unit to add, may be negative
unit - the unit of the period to add, not null
public HijrahDateminus(long amountToSubtract, TemporalUnit unit)
ChronoLocalDate
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.
minus in interface
ChronoLocalDate
minus in interface
Temporal
amountToSubtract - the amount of the specified unit to subtract, may be negative
unit - the unit of the period to subtract, not null
public final ChronoLocalDateTime<HijrahDate > atTime(LocalTime localTime)
ChronoLocalDate
ChronoLocalDateTime.
This returns a ChronoLocalDateTime formed from this date at the specified time. All possible combinations of date and time are valid.
atTime in interface
ChronoLocalDate
localTime - the local time to use, not null
public ChronoPerioduntil(ChronoLocalDate endDate)
ChronoLocalDate
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.
until in interface
ChronoLocalDate
endDate - the end date, exclusive, which may be in any chronology, not null
public boolean equals(Objectobj)
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 as a comparator.
equals in interface
ChronoLocalDate
obj - the object to check, null returns false
Object.hashCode() ,
HashMap
public int hashCode()
hashCode in interface
ChronoLocalDate
Object.equals(java.lang.Object) ,
System.identityHashCode(java.lang.Object)
public long until(TemporalendExclusive, TemporalUnit unit)
ChronoLocalDate
This calculates the amount of time between two ChronoLocalDate objects in terms of a single TemporalUnit. The start and end points are this and the specified date. The result will be negative if the end is before the start. The Temporal passed to this method is converted to a ChronoLocalDate using Chronology. The calculation returns a whole number, representing the number of complete units between the two dates. For example, the amount in days between two dates can be calculated using startDate.until(endDate, DAYS).
There are two equivalent ways of using this method. The first is to invoke this method. The second is to use TemporalUnit:
// these two lines are equivalent amount = start.until(end, MONTHS); amount = MONTHS.between(start, end);The choice should be made based on which makes the code more readable.
The calculation is implemented in this method for ChronoUnit. The units DAYS, WEEKS, MONTHS, YEARS, DECADES, CENTURIES, MILLENNIA and ERAS should be supported by all implementations. Other ChronoUnit values will throw an exception.
If the unit is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.between(Temporal, Temporal) passing this as the first argument and the converted input temporal as the second argument.
This instance is immutable and unaffected by this method call.
until in interface
ChronoLocalDate
until in interface
Temporal
endExclusive - the end date, exclusive, which is converted to a
ChronoLocalDate in the same chronology, not null
unit - the unit to measure the amount in, not null
public StringtoString()
Object
toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
toString in interface
ChronoLocalDate
toString in class
Object