- java.lang.Object
-
- java.time.chrono.HijrahDate
-
- All Implemented Interfaces:
Serializable,Comparable<ChronoLocalDate>,ChronoLocalDate,Temporal,TemporalAccessor,TemporalAdjuster
public final class HijrahDate extends Object implements ChronoLocalDate, Serializable
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
HijrahChronologyfor 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 ofHijrahDatemay have unpredictable results and should be avoided. Theequalsmethod should be used for comparisons.- Implementation Requirements:
- This class is immutable and thread-safe.
- Since:
- 1.8
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object obj)Compares this date to another date, including the chronology.static HijrahDatefrom(TemporalAccessor temporal)Obtains aHijrahDateof the Islamic Umm Al-Qura calendar from a temporal object.HijrahChronologygetChronology()Gets the chronology of this date, which is the Hijrah calendar system.HijrahEragetEra()Gets the era applicable at this date.inthashCode()A hash code for this date.booleanisLeapYear()Checks if the year is a leap year, according to the Hijrah calendar system rules.intlengthOfMonth()Returns the length of the month represented by this date.intlengthOfYear()Returns the length of the year represented by this date.HijrahDateminus(TemporalAmount amount)Returns an object of the same type as this object with an amount subtracted.static HijrahDatenow()Obtains the currentHijrahDateof the Islamic Umm Al-Qura calendar in the default time-zone.static HijrahDatenow(Clock clock)Obtains the currentHijrahDateof the Islamic Umm Al-Qura calendar from the specified clock.static HijrahDatenow(ZoneId zone)Obtains the currentHijrahDateof the Islamic Umm Al-Qura calendar in the specified time-zone.static HijrahDateof(int prolepticYear, int month, int dayOfMonth)Obtains aHijrahDateof the Islamic Umm Al-Qura calendar from the proleptic-year, month-of-year and day-of-month fields.HijrahDateplus(TemporalAmount amount)Returns an object of the same type as this object with an amount added.StringtoString()Returns a string representation of the object.longuntil(Temporal endExclusive, TemporalUnit unit)Calculates the amount of time until another date in terms of the specified unit.HijrahDatewith(TemporalAdjuster adjuster)Returns an adjusted object of the same type as this object with the adjustment made.HijrahDatewithVariant(HijrahChronology chronology)Returns aHijrahDatewith the Chronology requested.-
Methods declared in class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods declared in interface java.time.chrono.ChronoLocalDate
adjustInto, atTime, compareTo, format, isAfter, isBefore, isEqual, isSupported, isSupported, minus, plus, query, toEpochDay, toString, until, until, with
-
Methods declared in interface java.time.temporal.TemporalAccessor
get, getLong, range
-
-
-
-
Method Detail
-
now
public static HijrahDate now()
Obtains the currentHijrahDateof the Islamic Umm Al-Qura calendar in the default time-zone.This will query the
system clockin 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:
- the current date using the system clock and default time-zone, not null
-
now
public static HijrahDate now(ZoneId zone)
Obtains the currentHijrahDateof the Islamic Umm Al-Qura calendar in the specified time-zone.This will query the
system clockto 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- the zone ID to use, not null- Returns:
- the current date using the system clock, not null
-
now
public static HijrahDate now(Clock clock)
Obtains the currentHijrahDateof 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- the clock to use, not null- Returns:
- the current date, not null
- Throws:
DateTimeException- if the current date cannot be obtained
-
of
public static HijrahDate of(int prolepticYear, int month, int dayOfMonth)
Obtains aHijrahDateof the Islamic Umm Al-Qura calendar from the proleptic-year, month-of-year and day-of-month fields.This returns a
HijrahDatewith the specified fields. The day must be valid for the year and month, otherwise an exception will be thrown.- Parameters:
prolepticYear- the Hijrah proleptic-yearmonth- the Hijrah month-of-year, from 1 to 12dayOfMonth- the Hijrah day-of-month, from 1 to 30- Returns:
- the date in Hijrah calendar system, not null
- Throws:
DateTimeException- if the value of any field is out of range, or if the day-of-month is invalid for the month-year
-
from
public static HijrahDate from(TemporalAccessor temporal)
Obtains aHijrahDateof 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
TemporalAccessorrepresents an arbitrary set of date and time information, which this factory converts to an instance ofHijrahDate.The conversion typically uses the
EPOCH_DAYfield, which is standardized across calendar systems.This method matches the signature of the functional interface
TemporalQueryallowing it to be used as a query via method reference,HijrahDate::from.- Parameters:
temporal- the temporal object to convert, not null- Returns:
- the date in Hijrah calendar system, not null
- Throws:
DateTimeException- if unable to convert to aHijrahDate- See Also:
Chronology.date(TemporalAccessor)
-
getChronology
public HijrahChronology getChronology()
Gets the chronology of this date, which is the Hijrah calendar system.The
Chronologyrepresents the calendar system in use. The era and other fields inChronoFieldare defined by the chronology.- Specified by:
getChronologyin interfaceChronoLocalDate- Returns:
- the Hijrah chronology, not null
-
getEra
public HijrahEra getEra()
Gets the era applicable at this date.The Hijrah calendar system has one era, 'AH', defined by
HijrahEra.- Specified by:
getErain interfaceChronoLocalDate- Returns:
- the era applicable at this date, not null
-
lengthOfMonth
public int lengthOfMonth()
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.
- Specified by:
lengthOfMonthin interfaceChronoLocalDate- Returns:
- the length of the month in days
-
lengthOfYear
public int lengthOfYear()
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.
- Specified by:
lengthOfYearin interfaceChronoLocalDate- Returns:
- the length of the year in days
-
with
public HijrahDate with(TemporalAdjuster adjuster)
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
- Specified by:
within interfaceChronoLocalDate- Specified by:
within interfaceTemporal- Parameters:
adjuster- the adjuster to use, not null- Returns:
- an object of the same type with the specified adjustment made, not null
- Throws:
DateTimeException- if unable to make the adjustment. For example, if the adjuster requires an ISO chronologyArithmeticException- if numeric overflow occurs
-
withVariant
public HijrahDate withVariant(HijrahChronology chronology)
Returns aHijrahDatewith 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- the new HijrahChonology, non-null- Returns:
- a HijrahDate with the requested HijrahChronology, non-null
-
plus
public HijrahDate plus(TemporalAmount amount)
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
Periodbut may be any other type implementing theTemporalAmountinterface, such asDuration.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
plusfollowed byminusis not guaranteed to return the same date-time.- Specified by:
plusin interfaceChronoLocalDate- Specified by:
plusin interfaceTemporal- Parameters:
amount- the amount to add, not null- Returns:
- an object of the same type with the specified adjustment made, not null
- Throws:
DateTimeException- if the addition cannot be madeArithmeticException- if numeric overflow occurs
-
minus
public HijrahDate minus(TemporalAmount amount)
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
Periodbut may be any other type implementing theTemporalAmountinterface, such asDuration.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
plusfollowed byminusis not guaranteed to return the same date-time.- Specified by:
minusin interfaceChronoLocalDate- Specified by:
minusin interfaceTemporal- Parameters:
amount- the amount to subtract, not null- Returns:
- an object of the same type with the specified adjustment made, not null
- Throws:
DateTimeException- if the subtraction cannot be madeArithmeticException- if numeric overflow occurs
-
isLeapYear
public boolean isLeapYear()
Checks if the year is a leap year, according to the Hijrah calendar system rules.- Specified by:
isLeapYearin interfaceChronoLocalDate- Returns:
- true if this date is in a leap year
-
equals
public boolean equals(Object obj)
Compares this date to another date, including the chronology.Compares this
HijrahDatewith another ensuring that the date is the same.Only objects of type
HijrahDateare compared, other types return false. To compare the dates of twoTemporalAccessorinstances, including dates in two different chronologies, useChronoField.EPOCH_DAYas a comparator.- Specified by:
equalsin interfaceChronoLocalDate- Parameters:
obj- the object to check, null returns false- Returns:
- true if this is equal to the other date and the Chronologies are equal
- See Also:
Object.hashCode(),HashMap
-
hashCode
public int hashCode()
A hash code for this date.- Specified by:
hashCodein interfaceChronoLocalDate- Returns:
- a suitable hash code based only on the Chronology and the date
- See Also:
Object.equals(java.lang.Object),System.identityHashCode(java.lang.Object)
-
until
public long until(Temporal endExclusive, TemporalUnit unit)
Description copied from interface:ChronoLocalDateCalculates the amount of time until another date in terms of the specified unit.This calculates the amount of time between two
ChronoLocalDateobjects in terms of a singleTemporalUnit. The start and end points arethisand the specified date. The result will be negative if the end is before the start. TheTemporalpassed to this method is converted to aChronoLocalDateusingChronology.date(TemporalAccessor). 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 usingstartDate.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.between(Temporal, Temporal):// 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 unitsDAYS,WEEKS,MONTHS,YEARS,DECADES,CENTURIES,MILLENNIAandERASshould be supported by all implementations. OtherChronoUnitvalues will throw an exception.If the unit is not a
ChronoUnit, then the result of this method is obtained by invokingTemporalUnit.between(Temporal, Temporal)passingthisas the first argument and the converted input temporal as the second argument.This instance is immutable and unaffected by this method call.
- Specified by:
untilin interfaceChronoLocalDate- Specified by:
untilin interfaceTemporal- Parameters:
endExclusive- the end date, exclusive, which is converted to aChronoLocalDatein the same chronology, not nullunit- the unit to measure the amount in, not null- Returns:
- the amount of time between this date and the end date
-
toString
public String toString()
Description copied from class:ObjectReturns a string representation of the object. In general, thetoStringmethod 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
toStringmethod for classObjectreturns 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())
- Specified by:
toStringin interfaceChronoLocalDate- Overrides:
toStringin classObject- Returns:
- a string representation of the object.
-
-