Класс HijrahDate

public static HijrahDate now()

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

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

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

public static HijrahDate now(ZoneId zone)

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

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

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

public static HijrahDate now(Clock clock)

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

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

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

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

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

public static HijrahDate from(TemporalAccessor temporal)

Получает дату исламского календаря 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()

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

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

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 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()

Выводит эту дату как String.

Вывод будет включать полную локальную дату.