public final Class HijrahDate

private int getDayOfWeek()

Gets the day-of-week value.

Returns:int: the day-of-week; computed from the epochday

getDayOfYear back to summary

getDayOfYear	back to summary
private int getDayOfYear() Gets the day-of-year field. This method returns the primitive `int` value for the day-of-year. Returns:int the day-of-year

private int getDayOfYear()

Gets the day-of-year field.

This method returns the primitive int value for the day-of-year.

Returns:int: the day-of-year

getEra back to summary

getEra	back to summary
public HijrahEra getEra() Overrides default java.time.chrono.ChronoLocalDate.getEra. Gets the era applicable at this date. The Hijrah calendar system has one era, 'AH', defined by `HijrahEra`. Returns:HijrahEra the era applicable at this date, not null Annotations @Override

public HijrahEra getEra()

Overrides default java.time.chrono.ChronoLocalDate.getEra.

Gets the era applicable at this date.

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

Returns:HijrahEra

the era applicable at this date, not null

Annotations

@Override

getEraValue	back to summary
private int getEraValue() Gets the Era of this date. Returns:int the Era of this date; computed from epochDay

getEraValue

private int getEraValue()

Gets the Era of this date.

Returns:int: the Era of this date; computed from epochDay

getLong back to summary

getLong	back to summary
public long getLong(TemporalField field) Implements java.time.temporal.TemporalAccessor.getLong. Doc from java.time.temporal.TemporalAccessor.getLong. Gets the value of the specified field as a `long`. This queries the date-time for the value of 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. Parameters field:TemporalField the field to get, not null Returns:long the value for the field Annotations @Override

public long getLong(TemporalField field)

Implements java.time.temporal.TemporalAccessor.getLong.

Doc from java.time.temporal.TemporalAccessor.getLong.

Gets the value of the specified field as a long.

This queries the date-time for the value of 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.

Parameters

field:TemporalField: the field to get, not null

Returns:long

the value for the field

Annotations

@Override

getProlepticMonth	back to summary
private long getProlepticMonth()

hashCode	back to summary
public int hashCode() Overrides java.time.chrono.ChronoLocalDateImpl.hashCode. Implements java.time.chrono.ChronoLocalDate.hashCode. A hash code for this date. Returns:int a suitable hash code based only on the Chronology and the date Annotations @Override

hashCode

public int hashCode()

Overrides java.time.chrono.ChronoLocalDateImpl.hashCode.

Implements java.time.chrono.ChronoLocalDate.hashCode.

A hash code for this date.

Returns:int

a suitable hash code based only on the Chronology and the date

Annotations

@Override

isLeapYear	back to summary
public boolean isLeapYear() Overrides default java.time.chrono.ChronoLocalDate.isLeapYear. Checks if the year is a leap year, according to the Hijrah calendar system rules. Returns:boolean true if this date is in a leap year Annotations @Override

isLeapYear

public boolean isLeapYear()

Overrides default java.time.chrono.ChronoLocalDate.isLeapYear.

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

Returns:boolean

true if this date is in a leap year

Annotations

@Override

lengthOfMonth	back to summary
public int lengthOfMonth() Implements java.time.chrono.ChronoLocalDate.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. Returns:int the length of the month in days Annotations @Override

lengthOfMonth

public int lengthOfMonth()

Implements java.time.chrono.ChronoLocalDate.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.

Returns:int

the length of the month in days

Annotations

@Override

lengthOfYear	back to summary
public int lengthOfYear() Overrides default java.time.chrono.ChronoLocalDate.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. Returns:int the length of the year in days Annotations @Override

lengthOfYear

public int lengthOfYear()

Overrides default java.time.chrono.ChronoLocalDate.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.

Returns:int

the length of the year in days

Annotations

@Override

minus back to summary

minus	back to summary
public HijrahDate minus(TemporalAmount amount) Overrides java.time.chrono.ChronoLocalDateImpl.minus. Overrides default java.time.chrono.ChronoLocalDate.minus, java.time.temporal.Temporal.minus. Doc from java.time.chrono.ChronoLocalDate.minus. 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 Doc from java.time.temporal.Temporal.minus. the amount to subtract, not null Returns:HijrahDate Doc from java.time.temporal.Temporal.minus. an object of the same type with the specified adjustment made, not null Annotations @Override Exceptions DateTimeException: if the subtraction cannot be made ArithmeticException: if numeric overflow occurs

public HijrahDate minus(TemporalAmount amount)

Overrides java.time.chrono.ChronoLocalDateImpl.minus.

Overrides default java.time.chrono.ChronoLocalDate.minus, java.time.temporal.Temporal.minus.

Doc from java.time.chrono.ChronoLocalDate.minus.

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

Returns:HijrahDate

an object of the same type with the specified adjustment made, not null

Annotations

@Override

Exceptions

DateTimeException:: if the subtraction cannot be made
ArithmeticException:: if numeric overflow occurs

minus back to summary

minus	back to summary
public HijrahDate minus(long amountToSubtract, TemporalUnit unit) Overrides java.time.chrono.ChronoLocalDateImpl.minus. Overrides default java.time.chrono.ChronoLocalDate.minus, java.time.temporal.Temporal.minus. Doc from java.time.chrono.ChronoLocalDate.minus. Returns an object of the same type as this object with the specified period subtracted. 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. Parameters amountToSubtract:long Doc from java.time.temporal.Temporal.minus. the amount of the specified unit to subtract, may be negative unit:TemporalUnit Doc from java.time.temporal.Temporal.minus. the unit of the amount to subtract, not null Returns:HijrahDate Doc from java.time.temporal.Temporal.minus. an object of the same type with the specified period subtracted, not null Annotations @Override

public HijrahDate minus(long amountToSubtract, TemporalUnit unit)

Overrides java.time.chrono.ChronoLocalDateImpl.minus.

Overrides default java.time.chrono.ChronoLocalDate.minus, java.time.temporal.Temporal.minus.

Doc from java.time.chrono.ChronoLocalDate.minus.

Returns an object of the same type as this object with the specified period subtracted.

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.

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

Returns:HijrahDate

an object of the same type with the specified period subtracted, not null

Annotations

@Override

minusDays back to summary

minusDays	back to summary
pack-priv HijrahDate minusDays(long daysToSubtract) Overrides java.time.chrono.ChronoLocalDateImpl.minusDays. Doc from java.time.chrono.ChronoLocalDateImpl.minusDays. Returns a copy of this date with the specified number of days subtracted. This subtracts the specified period in days to the date. The default implementation uses `plusDays(long)`. This instance is immutable and unaffected by this method call. Parameters daysToSubtract:long the days to subtract, may be negative Returns:HijrahDate a date based on this one with the days subtracted, not null Annotations @Override

pack-priv HijrahDate minusDays(long daysToSubtract)

Overrides java.time.chrono.ChronoLocalDateImpl.minusDays.

Doc from java.time.chrono.ChronoLocalDateImpl.minusDays.

Returns a copy of this date with the specified number of days subtracted.

This subtracts the specified period in days to the date.

The default implementation uses plusDays(long).

This instance is immutable and unaffected by this method call.

Parameters

daysToSubtract:long: the days to subtract, may be negative

Returns:HijrahDate

a date based on this one with the days subtracted, not null

Annotations

@Override

minusMonths back to summary

minusMonths	back to summary
pack-priv HijrahDate minusMonths(long monthsToSubtract) Overrides java.time.chrono.ChronoLocalDateImpl.minusMonths. Doc from java.time.chrono.ChronoLocalDateImpl.minusMonths. Returns a copy of this date with the specified number of months subtracted. This subtracts the specified period in months to the date. In some cases, subtracting months can cause the resulting date to become invalid. If this occurs, then other fields, typically the day-of-month, will be adjusted to ensure that the result is valid. Typically this will select the last valid day of the month. The default implementation uses `plusMonths(long)`. This instance is immutable and unaffected by this method call. Parameters monthsToSubtract:long the months to subtract, may be negative Returns:HijrahDate a date based on this one with the months subtracted, not null Annotations @Override

pack-priv HijrahDate minusMonths(long monthsToSubtract)

Overrides java.time.chrono.ChronoLocalDateImpl.minusMonths.

Doc from java.time.chrono.ChronoLocalDateImpl.minusMonths.

Returns a copy of this date with the specified number of months subtracted.

This subtracts the specified period in months to the date. In some cases, subtracting months can cause the resulting date to become invalid. If this occurs, then other fields, typically the day-of-month, will be adjusted to ensure that the result is valid. Typically this will select the last valid day of the month.

The default implementation uses plusMonths(long).

This instance is immutable and unaffected by this method call.

Parameters

monthsToSubtract:long: the months to subtract, may be negative

Returns:HijrahDate

a date based on this one with the months subtracted, not null

Annotations

@Override

minusWeeks back to summary

minusWeeks	back to summary
pack-priv HijrahDate minusWeeks(long weeksToSubtract) Overrides java.time.chrono.ChronoLocalDateImpl.minusWeeks. Doc from java.time.chrono.ChronoLocalDateImpl.minusWeeks. Returns a copy of this date with the specified number of weeks subtracted. This subtracts the specified period in weeks to the date. In some cases, subtracting weeks can cause the resulting date to become invalid. If this occurs, then other fields will be adjusted to ensure that the result is valid. The default implementation uses `plusWeeks(long)`. This instance is immutable and unaffected by this method call. Parameters weeksToSubtract:long the weeks to subtract, may be negative Returns:HijrahDate a date based on this one with the weeks subtracted, not null Annotations @Override

pack-priv HijrahDate minusWeeks(long weeksToSubtract)

Overrides java.time.chrono.ChronoLocalDateImpl.minusWeeks.

Doc from java.time.chrono.ChronoLocalDateImpl.minusWeeks.

Returns a copy of this date with the specified number of weeks subtracted.

This subtracts the specified period in weeks to the date. In some cases, subtracting weeks can cause the resulting date to become invalid. If this occurs, then other fields will be adjusted to ensure that the result is valid.

The default implementation uses plusWeeks(long).

This instance is immutable and unaffected by this method call.

Parameters

weeksToSubtract:long: the weeks to subtract, may be negative

Returns:HijrahDate

a date based on this one with the weeks subtracted, not null

Annotations

@Override

minusYears back to summary

minusYears	back to summary
pack-priv HijrahDate minusYears(long yearsToSubtract) Overrides java.time.chrono.ChronoLocalDateImpl.minusYears. Doc from java.time.chrono.ChronoLocalDateImpl.minusYears. Returns a copy of this date with the specified number of years subtracted. This subtracts the specified period in years to the date. In some cases, subtracting years can cause the resulting date to become invalid. If this occurs, then other fields, typically the day-of-month, will be adjusted to ensure that the result is valid. Typically this will select the last valid day of the month. The default implementation uses `plusYears(long)`. This instance is immutable and unaffected by this method call. Parameters yearsToSubtract:long the years to subtract, may be negative Returns:HijrahDate a date based on this one with the years subtracted, not null Annotations @Override

pack-priv HijrahDate minusYears(long yearsToSubtract)

Overrides java.time.chrono.ChronoLocalDateImpl.minusYears.

Doc from java.time.chrono.ChronoLocalDateImpl.minusYears.

Returns a copy of this date with the specified number of years subtracted.

This subtracts the specified period in years to the date. In some cases, subtracting years can cause the resulting date to become invalid. If this occurs, then other fields, typically the day-of-month, will be adjusted to ensure that the result is valid. Typically this will select the last valid day of the month.

The default implementation uses plusYears(long).

This instance is immutable and unaffected by this method call.

Parameters

yearsToSubtract:long: the years to subtract, may be negative

Returns:HijrahDate

a date based on this one with the years subtracted, not null

Annotations

@Override

now back to summary

now	back to summary
public static HijrahDate now() 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. Returns:HijrahDate the current date using the system clock and default time-zone, not null

public static HijrahDate now()

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.

Returns:HijrahDate: the current date using the system clock and default time-zone, not null

now back to summary

now	back to summary
public static HijrahDate now(ZoneId zone) 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 Returns:HijrahDate the current date using the system clock, not null

public static HijrahDate now(ZoneId zone)

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

Returns:HijrahDate

the current date using the system clock, not null

now back to summary

now	back to summary
public static HijrahDate now(Clock clock) 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 Returns:HijrahDate the current date, not null Exceptions DateTimeException: if the current date cannot be obtained

public static HijrahDate now(Clock clock)

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

Returns:HijrahDate

the current date, not null

Exceptions

DateTimeException:: if the current date cannot be obtained

of back to summary

of	back to summary
pack-priv static HijrahDate of(HijrahChronology chrono, int prolepticYear, int monthOfYear, int dayOfMonth) Obtains an instance of `HijrahDate` from the Hijrah proleptic year, month-of-year and day-of-month. Parameters prolepticYear:int the proleptic year to represent in the Hijrah calendar monthOfYear:int the month-of-year to represent, from 1 to 12 dayOfMonth:int the day-of-month to represent, from 1 to 30 Returns:HijrahDate the Hijrah date, never null Exceptions DateTimeException: if the value of any field is out of range

pack-priv static HijrahDate of(HijrahChronology chrono, int prolepticYear, int monthOfYear, int dayOfMonth)

Obtains an instance of HijrahDate from the Hijrah proleptic year, month-of-year and day-of-month.

Parameters

prolepticYear:int: the proleptic year to represent in the Hijrah calendar
monthOfYear:int: the month-of-year to represent, from 1 to 12
dayOfMonth:int: the day-of-month to represent, from 1 to 30

Returns:HijrahDate

the Hijrah date, never null

Exceptions

DateTimeException:: if the value of any field is out of range

of back to summary

of	back to summary
public 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. 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 Returns:HijrahDate the date in Hijrah calendar system, not null Exceptions 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 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.

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

Returns:HijrahDate

the date in Hijrah calendar system, not null

Exceptions

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

ofEpochDay	back to summary
pack-priv static HijrahDate ofEpochDay(HijrahChronology chrono, long epochDay) Returns a HijrahDate for the chronology and epochDay. Parameters chrono:HijrahChronology The Hijrah chronology epochDay:long the epoch day Returns:HijrahDate a HijrahDate for the epoch day; non-null

ofEpochDay

pack-priv static HijrahDate ofEpochDay(HijrahChronology chrono, long epochDay)

Returns a HijrahDate for the chronology and epochDay.

Parameters

chrono:HijrahChronology: The Hijrah chronology
epochDay:long: the epoch day

Returns:HijrahDate

a HijrahDate for the epoch day; non-null

plus back to summary

plus	back to summary
public HijrahDate plus(TemporalAmount amount) Overrides java.time.chrono.ChronoLocalDateImpl.plus. Overrides default java.time.chrono.ChronoLocalDate.plus, java.time.temporal.Temporal.plus. Doc from java.time.chrono.ChronoLocalDate.plus. 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 Doc from java.time.temporal.Temporal.plus. the amount to add, not null Returns:HijrahDate Doc from java.time.temporal.Temporal.plus. an object of the same type with the specified adjustment made, not null Annotations @Override Exceptions DateTimeException: if the addition cannot be made ArithmeticException: if numeric overflow occurs

public HijrahDate plus(TemporalAmount amount)

Overrides java.time.chrono.ChronoLocalDateImpl.plus.

Overrides default java.time.chrono.ChronoLocalDate.plus, java.time.temporal.Temporal.plus.

Doc from java.time.chrono.ChronoLocalDate.plus.

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

Returns:HijrahDate

an object of the same type with the specified adjustment made, not null

Annotations

@Override

Exceptions

DateTimeException:: if the addition cannot be made
ArithmeticException:: if numeric overflow occurs

plus back to summary

plus	back to summary
public HijrahDate plus(long amountToAdd, TemporalUnit unit) Overrides java.time.chrono.ChronoLocalDateImpl.plus. Overrides default java.time.chrono.ChronoLocalDate.plus. Implements java.time.temporal.Temporal.plus. Doc from java.time.chrono.ChronoLocalDate.plus. Returns an object of the same type as this object with the specified period added. 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. Parameters amountToAdd:long Doc from java.time.temporal.Temporal.plus. the amount of the specified unit to add, may be negative unit:TemporalUnit Doc from java.time.temporal.Temporal.plus. the unit of the amount to add, not null Returns:HijrahDate Doc from java.time.temporal.Temporal.plus. an object of the same type with the specified period added, not null Annotations @Override

public HijrahDate plus(long amountToAdd, TemporalUnit unit)

Overrides java.time.chrono.ChronoLocalDateImpl.plus.

Overrides default java.time.chrono.ChronoLocalDate.plus.

Implements java.time.temporal.Temporal.plus.

Doc from java.time.chrono.ChronoLocalDate.plus.

Returns an object of the same type as this object with the specified period added.

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.

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

Returns:HijrahDate

an object of the same type with the specified period added, not null

Annotations

@Override

plusDays	back to summary
pack-priv HijrahDate plusDays(long days) Implements abstract java.time.chrono.ChronoLocalDateImpl.plusDays. Doc from java.time.chrono.ChronoLocalDateImpl.plusDays. Returns a copy of this date with the specified number of days added. This adds the specified period in days to the date. This instance is immutable and unaffected by this method call. Parameters days:long the days to add, may be negative Returns:HijrahDate a date based on this one with the days added, not null Annotations @Override

plusDays

pack-priv HijrahDate plusDays(long days)

Implements abstract java.time.chrono.ChronoLocalDateImpl.plusDays.

Doc from java.time.chrono.ChronoLocalDateImpl.plusDays.

Returns a copy of this date with the specified number of days added.

This adds the specified period in days to the date.

This instance is immutable and unaffected by this method call.

Parameters

days:long: the days to add, may be negative

Returns:HijrahDate

a date based on this one with the days added, not null

Annotations

@Override

plusMonths	back to summary
pack-priv HijrahDate plusMonths(long monthsToAdd) Implements abstract java.time.chrono.ChronoLocalDateImpl.plusMonths. Doc from java.time.chrono.ChronoLocalDateImpl.plusMonths. Returns a copy of this date with the specified number of months added. This adds the specified period in months to the date. In some cases, adding months can cause the resulting date to become invalid. If this occurs, then other fields, typically the day-of-month, will be adjusted to ensure that the result is valid. Typically this will select the last valid day of the month. This instance is immutable and unaffected by this method call. Parameters monthsToAdd:long the months to add, may be negative Returns:HijrahDate a date based on this one with the months added, not null Annotations @Override

plusMonths

pack-priv HijrahDate plusMonths(long monthsToAdd)

Implements abstract java.time.chrono.ChronoLocalDateImpl.plusMonths.

Doc from java.time.chrono.ChronoLocalDateImpl.plusMonths.

Returns a copy of this date with the specified number of months added.

This adds the specified period in months to the date. In some cases, adding months can cause the resulting date to become invalid. If this occurs, then other fields, typically the day-of-month, will be adjusted to ensure that the result is valid. Typically this will select the last valid day of the month.

This instance is immutable and unaffected by this method call.

Parameters

monthsToAdd:long: the months to add, may be negative

Returns:HijrahDate

a date based on this one with the months added, not null

Annotations

@Override

plusWeeks back to summary

plusWeeks	back to summary
pack-priv HijrahDate plusWeeks(long weeksToAdd) Overrides java.time.chrono.ChronoLocalDateImpl.plusWeeks. Doc from java.time.chrono.ChronoLocalDateImpl.plusWeeks. Returns a copy of this date with the specified number of weeks added. This adds the specified period in weeks to the date. In some cases, adding weeks can cause the resulting date to become invalid. If this occurs, then other fields will be adjusted to ensure that the result is valid. The default implementation uses `plusDays(long)` using a 7 day week. This instance is immutable and unaffected by this method call. Parameters weeksToAdd:long the weeks to add, may be negative Returns:HijrahDate a date based on this one with the weeks added, not null Annotations @Override

pack-priv HijrahDate plusWeeks(long weeksToAdd)

Overrides java.time.chrono.ChronoLocalDateImpl.plusWeeks.

Doc from java.time.chrono.ChronoLocalDateImpl.plusWeeks.

Returns a copy of this date with the specified number of weeks added.

This adds the specified period in weeks to the date. In some cases, adding weeks can cause the resulting date to become invalid. If this occurs, then other fields will be adjusted to ensure that the result is valid.

The default implementation uses plusDays(long) using a 7 day week.

This instance is immutable and unaffected by this method call.

Parameters

weeksToAdd:long: the weeks to add, may be negative

Returns:HijrahDate

a date based on this one with the weeks added, not null

Annotations

@Override

plusYears	back to summary
pack-priv HijrahDate plusYears(long years) Implements abstract java.time.chrono.ChronoLocalDateImpl.plusYears. Doc from java.time.chrono.ChronoLocalDateImpl.plusYears. Returns a copy of this date with the specified number of years added. This adds the specified period in years to the date. In some cases, adding years can cause the resulting date to become invalid. If this occurs, then other fields, typically the day-of-month, will be adjusted to ensure that the result is valid. Typically this will select the last valid day of the month. This instance is immutable and unaffected by this method call. Parameters years:long the years to add, may be negative Returns:HijrahDate a date based on this one with the years added, not null Annotations @Override

plusYears

pack-priv HijrahDate plusYears(long years)

Implements abstract java.time.chrono.ChronoLocalDateImpl.plusYears.

Doc from java.time.chrono.ChronoLocalDateImpl.plusYears.

Returns a copy of this date with the specified number of years added.

This adds the specified period in years to the date. In some cases, adding years can cause the resulting date to become invalid. If this occurs, then other fields, typically the day-of-month, will be adjusted to ensure that the result is valid. Typically this will select the last valid day of the month.

This instance is immutable and unaffected by this method call.

Parameters

years:long: the years to add, may be negative

Returns:HijrahDate

a date based on this one with the years added, not null

Annotations

@Override

range back to summary

range	back to summary
public ValueRange range(TemporalField field) Overrides default java.time.temporal.TemporalAccessor.range. Doc from java.time.temporal.TemporalAccessor.range. Gets the range of valid values for the specified field. 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. Parameters field:TemporalField the field to query the range for, not null Returns:ValueRange the range of valid values for the field, not null Annotations @Override

public ValueRange range(TemporalField field)

Overrides default java.time.temporal.TemporalAccessor.range.

Doc from java.time.temporal.TemporalAccessor.range.

Gets the range of valid values for the specified field.

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.

Parameters

field:TemporalField: the field to query the range for, not null

Returns:ValueRange

the range of valid values for the field, not null

Annotations

@Override

readExternal	back to summary
pack-priv static HijrahDate readExternal(ObjectInput in) throws IOException, ClassNotFoundException

readObject	back to summary
private void readObject(ObjectInputStream s) throws InvalidObjectException Defend against malicious streams. Parameters s:ObjectInputStream the stream to read Annotations @Serial Exceptions InvalidObjectException: always

readObject

private void readObject(ObjectInputStream s) throws InvalidObjectException

Defend against malicious streams.

Parameters

s:ObjectInputStream: the stream to read

Annotations

@Serial

Exceptions

InvalidObjectException:: always

resolvePreviousValid	back to summary
private HijrahDate resolvePreviousValid(int prolepticYear, int month, int day)

toEpochDay back to summary

toEpochDay	back to summary
public long toEpochDay() Overrides default java.time.chrono.ChronoLocalDate.toEpochDay. Doc from java.time.chrono.ChronoLocalDate.toEpochDay. Converts this date to the Epoch Day. 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. Returns:long the Epoch Day equivalent to this date Annotations @Override

public long toEpochDay()

Overrides default java.time.chrono.ChronoLocalDate.toEpochDay.

Doc from java.time.chrono.ChronoLocalDate.toEpochDay.

Converts this date to the Epoch Day.

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.

Returns:long

the Epoch Day equivalent to this date

Annotations

@Override

until back to summary

until	back to summary
public ChronoPeriod until(ChronoLocalDate endDate) Implements java.time.chrono.ChronoLocalDate.until. Doc from java.time.chrono.ChronoLocalDate.until. Calculates the period between this date and another date as a `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. Parameters endDate:ChronoLocalDate the end date, exclusive, which may be in any chronology, not null Returns:ChronoPeriod the period between this date and the end date, not null Annotations @Override

public ChronoPeriod until(ChronoLocalDate endDate)

Implements java.time.chrono.ChronoLocalDate.until.

Doc from java.time.chrono.ChronoLocalDate.until.

Calculates the period between this date and another date as a 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.

Parameters

endDate:ChronoLocalDate: the end date, exclusive, which may be in any chronology, not null

Returns:ChronoPeriod

the period between this date and the end date, not null

Annotations

@Override

with back to summary

with	back to summary
public HijrahDate with(TemporalField field, long newValue) Overrides java.time.chrono.ChronoLocalDateImpl.with. Overrides default java.time.chrono.ChronoLocalDate.with. Implements java.time.temporal.Temporal.with. Doc from java.time.chrono.ChronoLocalDate.with. Returns an object of the same type as this object with the specified field altered. 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. Parameters field:TemporalField Doc from java.time.temporal.Temporal.with. the field to set in the result, not null newValue:long Doc from java.time.temporal.Temporal.with. the new value of the field in the result Returns:HijrahDate Doc from java.time.temporal.Temporal.with. an object of the same type with the specified field set, not null Annotations @Override

public HijrahDate with(TemporalField field, long newValue)

Overrides java.time.chrono.ChronoLocalDateImpl.with.

Overrides default java.time.chrono.ChronoLocalDate.with.

Implements java.time.temporal.Temporal.with.

Doc from java.time.chrono.ChronoLocalDate.with.

Returns an object of the same type as this object with the specified field altered.

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.

Parameters

field:TemporalField

the field to set in the result, not null

newValue:long

the new value of the field in the result

Returns:HijrahDate

an object of the same type with the specified field set, not null

Annotations

@Override

with back to summary

with	back to summary
public HijrahDate with(TemporalAdjuster adjuster) Overrides java.time.chrono.ChronoLocalDateImpl.with. Overrides default java.time.chrono.ChronoLocalDate.with, java.time.temporal.Temporal.with. Doc from java.time.chrono.ChronoLocalDate.with. 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 Doc from java.time.temporal.Temporal.with. the adjuster to use, not null Returns:HijrahDate Doc from java.time.temporal.Temporal.with. an object of the same type with the specified adjustment made, not null Annotations @Override Exceptions DateTimeException: if unable to make the adjustment. For example, if the adjuster requires an ISO chronology ArithmeticException: if numeric overflow occurs

public HijrahDate with(TemporalAdjuster adjuster)

Overrides java.time.chrono.ChronoLocalDateImpl.with.

Overrides default java.time.chrono.ChronoLocalDate.with, java.time.temporal.Temporal.with.

Doc from java.time.chrono.ChronoLocalDate.with.

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

Returns:HijrahDate