HijrahDate

java.lang.Object
- java.time.chrono.HijrahDate

所有已实现的接口:

Serializable, Comparable<ChronoLocalDate>, ChronoLocalDate, Temporal, TemporalAccessor, TemporalAdjuster
```
public final class HijrahDate
extends Object
implements ChronoLocalDate, Temporal, TemporalAdjuster, Serializable
```
A date in the Hijrah calendar system.
This date operates using one of several variants of the HijrahChronology.
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.

从以下版本开始:

1.8

另请参阅:

序列化表格

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`ChronoLocalDateTime<HijrahDate>`	`atTime(LocalTime localTime)`	Combines this date with a time to create a `ChronoLocalDateTime`.
`boolean`	`equals(Object obj)`	Compares this date to another date, including the chronology.
`static HijrahDate`	`from(TemporalAccessor temporal)`	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 field)`	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 unit)`	Returns an object of the same type as this object with the specified period subtracted.
`HijrahDate`	`minus(TemporalAmount amount)`	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 clock)`	Obtains the current `HijrahDate` of the Islamic Umm Al-Qura calendar from the specified clock.
`static HijrahDate`	`now(ZoneId zone)`	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 unit)`	Returns an object of the same type as this object with the specified period added.
`HijrahDate`	`plus(TemporalAmount amount)`	Returns an object of the same type as this object with an amount added.
`ValueRange`	`range(TemporalField field)`	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 endDate)`	Calculates the period between this date and another date as a `ChronoPeriod`.
`long`	`until(Temporal endExclusive, TemporalUnit unit)`	Calculates the amount of time until another date in terms of the specified unit.
`HijrahDate`	`with(TemporalAdjuster adjuster)`	Returns an adjusted object of the same type as this object with the adjustment made.
`HijrahDate`	`with(TemporalField field, long newValue)`	Returns an object of the same type as this object with the specified field altered.
`HijrahDate`	`withVariant(HijrahChronology chronology)`	Returns a `HijrahDate` with the Chronology requested.

从接口继承的方法 java.time.chrono.ChronoLocalDate
adjustInto, compareTo, format, isAfter, isBefore, isEqual, isSupported, isSupported, query, timeLineOrder

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 java.time.temporal.TemporalAccessor
get

- 方法详细资料
  - now
```
public static HijrahDate now()
```
    Obtains the current HijrahDate of the Islamic Umm Al-Qura calendar in the default time-zone.
    This will query the Clock#systemDefaultZone() 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.
    
    返回:
    
    the current date using the system clock and default time-zone, not null
  - now
```
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 Clock#system(ZoneId) 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
    
    返回:
    
    the current date using the system clock, not null
  - now
```
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 Clock.
    
    参数:
    
    clock - the clock to use, not null
    
    返回:
    
    the current date, not null
    
    抛出:
    
    DateTimeException - if the current date cannot be obtained
  - of
```
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.
    
    参数:
    
    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
    
    返回:
    
    the date in Hijrah calendar system, not null
    
    抛出:
    
    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 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 ChronoField#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.
    
    参数:
    
    temporal - the temporal object to convert, not null
    
    返回:
    
    the date in Hijrah calendar system, not null
    
    抛出:
    
    DateTimeException - if unable to convert to a HijrahDate
    
    另请参阅:
    
    Chronology.date(TemporalAccessor)
  - getChronology
```
public HijrahChronology getChronology()
```
    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.
    
    指定者:
    
    getChronology 在接口中 ChronoLocalDate
    
    返回:
    
    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.
    
    指定者:
    
    getEra 在接口中 ChronoLocalDate
    
    返回:
    
    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.
    
    指定者:
    
    lengthOfMonth 在接口中 ChronoLocalDate
    
    返回:
    
    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.
    
    指定者:
    
    lengthOfYear 在接口中 ChronoLocalDate
    
    返回:
    
    the length of the year in days
  - range
```
public ValueRange range(TemporalField field)
```
    从接口复制的说明: TemporalAccessor
    
    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.
    
    指定者:
    
    range 在接口中 TemporalAccessor
    
    参数:
    
    field - the field to query the range for, not null
    
    返回:
    
    the range of valid values for the field, not null
  - getLong
```
public long getLong(TemporalField field)
```
    从接口复制的说明: TemporalAccessor
    
    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.
    
    指定者:
    
    getLong 在接口中 TemporalAccessor
    
    参数:
    
    field - the field to get, not null
    
    返回:
    
    the value for the field
  - with
```
public HijrahDate with(TemporalField field,
                       long newValue)
```
    从接口复制的说明: ChronoLocalDate
    
    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.
    
    指定者:
    
    with 在接口中 ChronoLocalDate
    
    指定者:
    
    with 在接口中 Temporal
    
    参数:
    
    field - the field to set in the result, not null
    
    newValue - the new value of the field in the result
    
    返回:
    
    an object of the same type with the specified field set, not null
  - 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
 
```
    指定者:
    
    with 在接口中 ChronoLocalDate
    
    指定者:
    
    with 在接口中 Temporal
    
    参数:
    
    adjuster - the adjuster to use, not null
    
    返回:
    
    an object of the same type with the specified adjustment made, not null
    
    抛出:
    
    DateTimeException - if unable to make the adjustment. For example, if the adjuster requires an ISO chronology
    
    ArithmeticException - if numeric overflow occurs
  - withVariant
```
public HijrahDate withVariant(HijrahChronology chronology)
```
    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.
    
    参数:
    
    chronology - the new HijrahChonology, non-null
    
    返回:
    
    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 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 在接口中 ChronoLocalDate
    
    指定者:
    
    plus 在接口中 Temporal
    
    参数:
    
    amount - the amount to add, not null
    
    返回:
    
    an object of the same type with the specified adjustment made, not null
    
    抛出:
    
    DateTimeException - if the addition cannot be made
    
    ArithmeticException - 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 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 在接口中 ChronoLocalDate
    
    指定者:
    
    minus 在接口中 Temporal
    
    参数:
    
    amount - the amount to subtract, not null
    
    返回:
    
    an object of the same type with the specified adjustment made, not null
    
    抛出:
    
    DateTimeException - if the subtraction cannot be made
    
    ArithmeticException - if numeric overflow occurs
  - toEpochDay
```
public long toEpochDay()
```
    从接口复制的说明: ChronoLocalDate
    
    Converts this date to the Epoch Day.
    The ChronoField#EPOCH_DAY 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 在接口中 ChronoLocalDate
    
    返回:
    
    the Epoch Day equivalent to this date
  - isLeapYear
```
public boolean isLeapYear()
```
    Checks if the year is a leap year, according to the Hijrah calendar system rules.
    
    指定者:
    
    isLeapYear 在接口中 ChronoLocalDate
    
    返回:
    
    true if this date is in a leap year
  - plus
```
public HijrahDate plus(long amountToAdd,
                       TemporalUnit unit)
```
    从接口复制的说明: ChronoLocalDate
    
    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.
    
    指定者:
    
    plus 在接口中 ChronoLocalDate
    
    指定者:
    
    plus 在接口中 Temporal
    
    参数:
    
    amountToAdd - the amount of the specified unit to add, may be negative
    
    unit - the unit of the amount to add, not null
    
    返回:
    
    an object of the same type with the specified period added, not null
  - minus
```
public HijrahDate minus(long amountToSubtract,
                        TemporalUnit unit)
```
    从接口复制的说明: ChronoLocalDate
    
    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.
    
    指定者:
    
    minus 在接口中 ChronoLocalDate
    
    指定者:
    
    minus 在接口中 Temporal
    
    参数:
    
    amountToSubtract - the amount of the specified unit to subtract, may be negative
    
    unit - the unit of the amount to subtract, not null
    
    返回:
    
    an object of the same type with the specified period subtracted, not null
  - atTime
```
public ChronoLocalDateTime<HijrahDate> atTime(LocalTime localTime)
```
    从接口复制的说明: ChronoLocalDate
    
    Combines this date with a time to create a ChronoLocalDateTime.
    This returns a ChronoLocalDateTime formed from this date at the specified time. All possible combinations of date and time are valid.
    
    指定者:
    
    atTime 在接口中 ChronoLocalDate
    
    参数:
    
    localTime - the local time to use, not null
    
    返回:
    
    the local date-time formed from this date and the specified time, not null
  - until
```
public ChronoPeriod until(ChronoLocalDate endDate)
```
    从接口复制的说明: ChronoLocalDate
    
    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.
    
    指定者:
    
    until 在接口中 ChronoLocalDate
    
    参数:
    
    endDate - the end date, exclusive, which may be in any chronology, not null
    
    返回:
    
    the period between this date and the end date, not null
  - equals
```
public boolean equals(Object obj)
```
    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.
    
    指定者:
    
    equals 在接口中 ChronoLocalDate
    
    覆盖:
    
    equals 在类中 Object
    
    参数:
    
    obj - the object to check, null returns false
    
    返回:
    
    true if this is equal to the other date and the Chronologies are equal
    
    另请参阅:
    
    Object.hashCode(), HashMap
  - hashCode
```
public int hashCode()
```
    A hash code for this date.
    
    指定者:
    
    hashCode 在接口中 ChronoLocalDate
    
    覆盖:
    
    hashCode 在类中 Object
    
    返回:
    
    a suitable hash code based only on the Chronology and the date
    
    另请参阅:
    
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
  - until
```
public long until(Temporal endExclusive,
                  TemporalUnit unit)
```
    从接口复制的说明: ChronoLocalDate
    Calculates the amount of time until another date in terms of the specified unit.
    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#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 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#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 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 在接口中 ChronoLocalDate
    
    指定者:
    
    until 在接口中 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
    
    返回:
    
    the amount of time between this date and the end date
  - toString
```
public String toString()
```
    从类复制的说明: Object
    Returns a string representation of the object. In general, the 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 在接口中 ChronoLocalDate
    
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    a string representation of the object.

类 HijrahDate

方法概要

从接口继承的方法 java.time.chrono.ChronoLocalDate

从类继承的方法 java.lang.Object

从接口继承的方法 java.time.temporal.TemporalAccessor

方法详细资料

now

now

now

of

from

getChronology

getEra

lengthOfMonth

lengthOfYear

range

getLong

with

with

withVariant

plus

minus

toEpochDay

isLeapYear

plus

minus

atTime

until

equals

hashCode

until

toString