Класс HijrahDate

public static HijrahDate now()

Получает текущую HijrahDate исламского календаря Umm Al-Qura в часовом поясе по умолчанию.

Это запросит system clock в часовом поясе по умолчанию, чтобы получить текущую дату.

Использование этого метода предотвратит возможность использования альтернального часового механизма для тестирования, так как часовой механизм жёстко закодирован.

public static HijrahDate now(ZoneId zone)

Получает текущую HijrahDate исламского календаря Umm Al-Qura в указанном часовом поясе.

Это запросит system clock, чтобы получить текущую дату. Указание часового пояса предотвращает зависимость от часового пояса по умолчанию.

Использование этого метода предотвратит возможность использования альтернативного часового механизма для тестирования, так как часовой механизм жёстко закодирован.

public static HijrahDate now(Clock clock)

Получает текущую HijrahDate исламского календаря Umm Al-Qura из указанных часов.

Это запросит указанные часы, чтобы получить текущую дату — сегодняшний день. Использование этого метода позволяет использовать альтернативный часовой механизм для тестирования. Альтернативный часовой механизм может быть представлен с помощью инъекции зависимостей.

public static HijrahDate of(int prolepticYear,
                            int month,
                            int dayOfMonth)

Получает HijrahDate исламского календаря Umm Al-Qura по пролептическому году, месяцу и дню месяца.

Это возвращает HijrahDate со значениями указанных полей. День должен быть корректным для года и месяца; в противном случае будет выброшено исключение.

public static HijrahDate from(TemporalAccessor temporal)

Получает HijrahDate исламского календаря Umm Al-Qura из временного объекта.

Это получает дату в исламском календарной системе на основе указанного временного объекта. TemporalAccessor представляет произвольный набор информации о дате и времени, которую этот фабричный метод преобразует в экземпляр HijrahDate.

Преобразование обычно использует поле EPOCH_DAY, которое стандартизировано для всех календарных систем.

Этот метод соответствует сигнатуре функционального интерфейса TemporalQuery, что позволяет использовать его в качестве запроса с помощью ссылки на метод, HijrahDate::from.

public HijrahChronology getChronology()

Возвращает хронологию этой даты, которая является исламской календарной системой хиджры.

Chronology представляет используемую календарную систему. Эра и другие поля в ChronoField определяются хронологией.

public HijrahEra getEra()

Возвращает применимую эру к этой дате.

Исламская календарная система хиджры имеет одну эру «AH», определенную в HijrahEra.

public int lengthOfMonth()

Возвращает длительность месяца, представленного этой датой.

Это возвращает длительность месяца в днях. Длительность месяцев в исламском календарной системе хиджры варьируется от 29 до 30 дней.

public int lengthOfYear()

Возвращает длительность года, представленного этой датой.

Это возвращает длительность года в днях. Год в исламском календарной системе хиджры обычно короче, чем в системе ISO.

public ValueRange range(TemporalField field)

Получает диапазон допустимых значений для указанного поля.

Все поля могут быть выражены как целочисленное значение long. Этот метод возвращает объект, описывающий допустимый диапазон для этого значения. Значение этого временного объекта используется для повышения точности возвращаемого диапазона. Если объект даты и времени не может вернуть диапазон, потому что поле не поддерживается или по какой-либо другой причине, будет выброшено исключение.

Обратите внимание, что результат описывает только минимальное и максимальное допустимые значения, и не стоит делать слишком много выводов из них. Например, могут быть значения в диапазоне, которые некорректны для поля.

public long getLong(TemporalField field)

Возвращает значение указанного поля как long.

Это запрашивает значение указанного поля у даты и времени. Возвращаемое значение может быть вне допустимого диапазона значений для поля. Если объект даты и времени не может вернуть значение, потому что поле не поддерживается или по какой-либо другой причине, будет выброшено исключение.

public HijrahDate with(TemporalField field,
                       long newValue)

Возвращает объект того же типа, что и этот объект, с изменённым указанным полем.

Это возвращает новый объект на основе этого объекта со значениями указанного поля, изменёнными. Например, для LocalDate, это можно использовать для установки года, месяца или дня месяца. Возвращаемый объект будет иметь тот же тип видимости, что и этот объект.

В некоторых случаях изменение поля не полностью определено. Например, если целевой объект — дата, представляющая 31 января, то изменение месяца на февраль будет неясным. В таких случаях поле отвечает за разрешение результата. Обычно оно выберет предыдущую корректную дату, которая в этом примере будет последним днём февраля.

public HijrahDate with(TemporalAdjuster adjuster)

Возвращает изменённый объект того же типа, что и этот объект.

Это корректирует эту дату и время в соответствии с правилами указанного корректировщика. Простой корректировщик может просто установить одно из полей, например, поле год. Более сложный корректировщик может установить дату на последнее число месяца. Выбор общих корректировок представлен в TemporalAdjusters. К ним относятся нахождение «последнего числа месяца» и «следующей среды». Корректировщик отвечает за обработку особых случаев, таких как разная длина месяцев и високосные годы.

Некоторые примеры кода, показывающие, как и почему используется этот метод:

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

public HijrahDate withVariant(HijrahChronology chronology)

Возвращает HijrahDate с запрошенной хронологией.

Год, месяц и день проверяются по новой запрошенной хронологии хиджры. Если хронология имеет меньшую длительность месяца для месяца, день уменьшается до последнего дня месяца.

public HijrahDate plus(TemporalAmount amount)

Возвращает объект того же типа, что и этот объект, с добавленной величиной.

Это корректирует это временное значение, добавляя согласно правилам указанного количества. Величина обычно является Period, но может быть любого другого типа, реализующего интерфейс TemporalAmount, например, Duration.

Пример кода, показывающий, как и почему используется этот метод:

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

Обратите внимание, что вызов plus в сочетании с minus не гарантирует возвращение той же даты и времени.

public HijrahDate minus(TemporalAmount amount)

Возвращает объект того же типа, что и этот объект, со вычтенной величиной.

Это корректирует это временное значение, вычитая согласно правилам указанного количества. Величина обычно является Period, но может быть любого другого типа, реализующего интерфейс TemporalAmount, например, Duration.

Пример кода, показывающий, как и почему используется этот метод:

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

Обратите внимание, что вызов plus в сочетании с minus не гарантирует возвращение той же даты и времени.

public long toEpochDay()

Преобразует эту дату в Эпоху дня.

Epoch Day count — это простая возрастающая счётчик дней, где день 0 — 1970-01-01 (ISO). Это определение одинаково для всех хронологий, что позволяет выполнить преобразование.

Эта реализация по умолчанию обращается к полю EPOCH_DAY.

public boolean isLeapYear()

public HijrahDate plus(long amountToAdd,
                       TemporalUnit unit)

Возвращает объект того же типа, что и этот объект, с добавлением указанного периода.

Этот метод возвращает новый объект, основанный на этом, с добавленным указанным периодом. Например, в LocalDate, это можно использовать для добавления количества лет, месяцев или дней. Возвращаемый объект будет иметь тот же наблюдаемый тип, что и этот объект.

В некоторых случаях изменение поля не полностью определено. Например, если целевой объект представляет дату 31 января, то добавление одного месяца было бы неясным. В таких случаях поле отвечает за разрешение результата. Обычно оно выбирает предыдущую допустимую дату, что в данном примере будет последним допустимым днём февраля.

public HijrahDate minus(long amountToSubtract,
                        TemporalUnit unit)

Возвращает объект того же типа, что и этот объект, с вычитанием указанного периода.

Этот метод возвращает новый объект, основанный на этом, с вычтенным указанным периодом. Например, в LocalDate, это можно использовать для вычитания количества лет, месяцев или дней. Возвращаемый объект будет иметь тот же наблюдаемый тип, что и этот объект.

В некоторых случаях изменение поля не полностью определено. Например, если целевой объект представляет дату 31 марта, то вычитание одного месяца было бы неясным. В таких случаях поле отвечает за разрешение результата. Обычно оно выбирает предыдущую допустимую дату, что в данном примере будет последним допустимым днём февраля.

public final ChronoLocalDateTime<HijrahDate> atTime(LocalTime localTime)

Комбинирует эту дату с временем для создания ChronoLocalDateTime.

Это возвращает ChronoLocalDateTime, сформированную из этой даты в указанное время. Все возможные комбинации даты и времени допустимы.

public ChronoPeriod until(ChronoLocalDate endDate)

Вычисляет период между этой датой и другой датой как ChronoPeriod.

Это вычисляет период между двумя датами. Все используемые хронологии вычисляют период в годах, месяцах и днях, однако API ChronoPeriod позволяет представлять период с использованием других единиц.

Начальная и конечная точки — это this и указанная дата. Результат будет отрицательным, если конец находится до начала. Отрицательный знак будет одинаковым для года, месяца и дня.

Вычисление выполняется с использованием хронологии этой даты. При необходимости входная дата будет преобразована для соответствия.

Этот экземпляр неизменяемый и не изменяется этим методом.

public boolean equals(Object obj)

Сравнивает эту дату с другой датой, включая хронологию.

Сравнивает эту HijrahDate с другой, гарантируя, что дата одинакова.

Сравниваются только объекты типа HijrahDate, другие типы возвращают false. Чтобы сравнить даты двух TemporalAccessor экземпляров, включая даты в двух разных хронологиях, используйте ChronoField.EPOCH_DAY в качестве компаратора.

public int hashCode()

public long until(Temporal endExclusive,
                  TemporalUnit unit)

Вычисляет количество времени до другой даты в указанных единицах измерения.

Это вычисляет количество времени между двумя ChronoLocalDate объектами в терминах одной TemporalUnit. Точки начала и конца — это this и указанная дата. Результат будет отрицательным, если конец раньше начала. Temporal , переданное в этот метод, преобразуется в ChronoLocalDate с помощью Chronology.date(TemporalAccessor). Вычисление возвращает целое число, представляющее количество полных единиц между двумя датами. Например, количество дней между двумя датами можно вычислить с помощью startDate.until(endDate, DAYS).

Существует два эквивалентных способа использования этого метода. Первый — вызвать этот метод. Второй — использовать TemporalUnit.between(Temporal, Temporal):

// these two lines are equivalent
   amount = start.until(end, MONTHS);
   amount = MONTHS.between(start, end);

Выбор следует делать, исходя из того, что делает код более читаемым.

Вычисление реализовано в этом методе для ChronoUnit. Единицы DAYS, WEEKS, MONTHS, YEARS, DECADES, CENTURIES, MILLENNIA и ERAS должны поддерживаться всеми реализациями. Другие ChronoUnit значения приведут к исключению.

Если единица измерения не является ChronoUnit, то результат этого метода получается путем вызова TemporalUnit.between(Temporal, Temporal) , передавая this в качестве первого аргумента и преобразованный входной временной объект — в качестве второго аргумента.

Этот экземпляр неизменяемый и не изменяется этим вызовом метода.

public String toString()

Возвращает строковое представление объекта. В общем случае метод toString возвращает строку, которая "текстуально представляет" этот объект. Результат должен быть кратким, но информативным представлением, удобным для чтения человеком. Рекомендуется, чтобы все подклассы переопределяли этот метод.

Метод toString для класса Object возвращает строку, состоящую из имени класса, к которому относится объект, символа "@" и неозначенного шестнадцатеричного представления хэш-кода объекта. Другими словами, этот метод возвращает строку, равную значению:

getClass().getName() + '@' + Integer.toHexString(hashCode())