Класс HijrahDate

public static HijrahDate now()

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

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

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

public static HijrahDate now(ZoneId zone)

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

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

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

public static HijrahDate now(Clock clock)

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

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

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

Получает HijrahDate исламского календаря Умм аль-Кура из полей пролептического года, месяца года и дня месяца.

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

public static HijrahDate from(TemporalAccessor temporal)

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

Получает дату в календарной системе хиджры на основе указанного временного объекта. 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 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 с запрошенной хронологией.

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

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.

Вывод будет содержать полную местную дату.