Spec-Zone.ru › OpenJDK 25

Перечисление ChronoUnit

java.lang.Object
java.lang.Enum<ChronoUnit>
java.time.temporal.ChronoUnit
Все реализованные интерфейсы:
Serializable, Comparable<ChronoUnit>, Constable, TemporalUnit
public enum ChronoUnit extends Enum<ChronoUnit> implements TemporalUnit
Стандартный набор единиц периодов дат.

Этот набор единиц предоставляет доступ к манипулированию датой, временем или датой и временем на основе единиц. Стандартный набор единиц можно расширить, реализовав TemporalUnit.

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

Требования к реализации:
Это окончательное, неизменяемое и потокобезопасное перечисление.
Since:
1.8

Краткое описание вложенных классов

Вложенные классы и интерфейсы, объявленные в классе Enum

Enum.EnumDesc<E>

Краткое описание констант перечисления

Константа перечисления Описание
CENTURIES
Единица, представляющая понятие столетия.
DAYS
Единица, представляющая понятие дня.
DECADES
Единица, представляющая понятие десятилетия.
ERAS
Единица, представляющая понятие эры.
FOREVER
Искусственная единица, представляющая понятие бесконечности.
HALF_DAYS
Единица, представляющая понятие половины дня, используемое в обозначениях AM/PM.
HOURS
Единица, представляющая понятие часа.
MICROS
Единица, представляющая понятие микросекунды.
MILLENNIA
Единица, представляющая понятие тысячелетия.
MILLIS
Единица, представляющая понятие миллисекунды.
MINUTES
Единица, представляющая понятие минуты.
MONTHS
Единица, представляющая понятие месяца.
NANOS
Единица, представляющая понятие наносекунды — наименьшей поддерживаемой единицы времени.
SECONDS
Единица, представляющая понятие секунды.
WEEKS
Единица, представляющая понятие недели.
YEARS
Единица, представляющая понятие года.

Краткое описание методов

Модификатор и тип Метод Описание
<R extends Temporal>
R
addTo(R temporal, long amount)
Возвращает копию указанного объекта времени с добавленным указанным периодом.
long between(Temporal temporal1Inclusive, Temporal temporal2Exclusive)
Вычисляет промежуток времени между двумя объектами времени.
Duration getDuration()
Возвращает предполагаемую длительность этой единицы в календарной системе ISO.
boolean isDateBased()
Проверяет, является ли эта единица единицей даты.
boolean isDurationEstimated()
Проверяет, является ли длительность единицы приблизительной.
boolean isTimeBased()
Проверяет, является ли эта единица единицей времени.
String toString()
Возвращает имя этой константы перечисления, указанное в объявлении.
static ChronoUnit valueOf(String name)
Возвращает константу перечисления этого класса с указанным именем.
static ChronoUnit[] values()
Возвращает массив, содержащий константы этого класса перечисления в порядке их объявления.

Методы, объявленные в классе Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Методы, объявленные в классе Object

getClass, notify, notifyAll, wait, wait, wait

Методы, объявленные в интерфейсе TemporalUnit

isSupportedBy

Подробное описание констант перечисления

NANOS

public static final ChronoUnit NANOS
Единица, представляющая понятие наносекунды — наименьшей поддерживаемой единицы времени. В календарной системе ISO она равна одной миллиардной доле секунды.

MICROS

public static final ChronoUnit MICROS
Единица, представляющая понятие микросекунды. В календарной системе ISO она равна одной миллионной доле секунды.

MILLIS

public static final ChronoUnit MILLIS
Единица, представляющая понятие миллисекунды. В календарной системе ISO она равна одной тысячной доле секунды.

SECONDS

public static final ChronoUnit SECONDS
Единица, представляющая понятие секунды. В календарной системе ISO она равна секунде в системе единиц СИ, за исключением случаев, связанных с високосной секундой.

MINUTES

public static final ChronoUnit MINUTES
Единица, представляющая понятие минуты. В календарной системе ISO она равна 60 секундам.

HOURS

public static final ChronoUnit HOURS
Единица, представляющая понятие часа. В календарной системе ISO она равна 60 минутам.

HALF_DAYS

public static final ChronoUnit HALF_DAYS
Единица, представляющая понятие половины дня, используемое в обозначениях AM/PM. В календарной системе ISO она равна 12 часам.

DAYS

public static final ChronoUnit DAYS
Единица, представляющая понятие дня. В календарной системе ISO это стандартный день от полуночи до полуночи. Предполагаемая длительность дня составляет 24 Hours.

При использовании с другими календарными системами единица должна соответствовать дню, определяемому восходом и заходом Солнца на Земле. Не обязательно, чтобы дни начинались в полночь: при преобразовании между календарными системами дата должна быть эквивалентна в полдень.

WEEKS

public static final ChronoUnit WEEKS
Единица, представляющая понятие недели. В календарной системе ISO она равна 7 дням.

При использовании с другими календарными системами единица должна соответствовать целому числу дней.

MONTHS

public static final ChronoUnit MONTHS
Единица, представляющая понятие месяца. В календарной системе ISO продолжительность месяца зависит от месяца года. Предполагаемая длительность месяца составляет одну двенадцатую от 365.2425 Days.

При использовании с другими календарными системами единица должна соответствовать целому числу дней.

YEARS

public static final ChronoUnit YEARS
Единица, представляющая понятие года. В календарной системе ISO она равна 12 месяцам. Предполагаемая длительность года составляет 365.2425 Days.

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

DECADES

public static final ChronoUnit DECADES
Единица, представляющая понятие десятилетия. В календарной системе ISO она равна 10 годам.

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

CENTURIES

public static final ChronoUnit CENTURIES
Единица, представляющая понятие столетия. В календарной системе ISO она равна 100 годам.

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

MILLENNIA

public static final ChronoUnit MILLENNIA
Единица, представляющая понятие тысячелетия. В календарной системе ISO она равна 1000 годам.

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

ERAS

public static final ChronoUnit ERAS
Единица, представляющая понятие эры. В календарной системе ISO нет эр, поэтому невозможно добавить эру к дате или дате и времени. Предполагаемая длительность эры искусственно задана как 1,000,000,000 Years.

При использовании с другими календарными системами ограничений на единицу нет.

FOREVER

public static final ChronoUnit FOREVER
Искусственная единица, представляющая понятие бесконечности. В основном она используется с TemporalField для представления неограниченных полей, таких как год или эра. Предполагаемая длительность этой единицы искусственно задана как наибольшая длительность, поддерживаемая Duration.

Подробное описание методов

values

public static ChronoUnit[] values()
Возвращает массив, содержащий константы этого класса перечисления в порядке их объявления.
Возвращает:
массив, содержащий константы этого класса перечисления в порядке их объявления

valueOf

public static ChronoUnit valueOf(String name)
Возвращает константу перечисления этого класса с указанным именем. Строка должна точно совпадать с идентификатором, использованным для объявления константы перечисления в этом классе. (Пробелы в строке не допускаются.)
Параметры:
name — имя возвращаемой константы перечисления.
Возвращает:
константу перечисления с указанным именем
Вызывает исключение:
IllegalArgumentException — если в этом классе перечисления нет константы с указанным именем
NullPointerException — если аргумент равен null

getDuration

public Duration getDuration()
Возвращает предполагаемую длительность этой единицы в календарной системе ISO.

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

Определено в:
getDuration в интерфейсе TemporalUnit
Возвращает:
предполагаемую длительность этой единицы; не null

isDurationEstimated

public boolean isDurationEstimated()
Проверяет, является ли длительность единицы приблизительной.

Все единицы времени в этом классе считаются точными, а все единицы даты в этом классе — приблизительными.

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

Определено в:
isDurationEstimated в интерфейсе TemporalUnit
Возвращает:
true, если длительность приблизительная; false, если точная

isDateBased

public boolean isDateBased()
Проверяет, является ли эта единица единицей даты.

Все единицы от дней до эр включительно относятся к единицам даты. Единицы времени и FOREVER возвращают false.

Определено в:
isDateBased в интерфейсе TemporalUnit
Возвращает:
true, если это единица даты; false, если это единица времени

isTimeBased

public boolean isTimeBased()
Проверяет, является ли эта единица единицей времени.

Все единицы от наносекунд до половины дня включительно относятся к единицам времени. Единицы даты и FOREVER возвращают false.

Определено в:
isTimeBased в интерфейсе TemporalUnit
Возвращает:
true, если это единица времени; false, если это единица даты

addTo

public <R extends Temporal> R addTo(R temporal, long amount)
Описание скопировано из интерфейса: TemporalUnit
Возвращает копию указанного объекта времени с добавленным указанным периодом.

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

Этот метод можно использовать двумя эквивалентными способами. Первый — вызвать метод напрямую. Второй — использовать Temporal.plus(long, TemporalUnit):

  // these two lines are equivalent, but the second approach is recommended
  temporal = thisUnit.addTo(temporal);
  temporal = temporal.plus(thisUnit);
Рекомендуется использовать второй подход, plus(TemporalUnit), поскольку так код гораздо понятнее.

Реализации должны выполнять запросы и вычисления, используя единицы, доступные в ChronoUnit, или поля, доступные в ChronoField. Если единица не поддерживается, необходимо выбросить UnsupportedTemporalTypeException.

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

Определено в:
addTo в интерфейсе TemporalUnit
Параметры типа:
R — тип объекта Temporal
Параметры:
temporal — объект времени для корректировки; не null
amount — величина этой единицы, которую нужно добавить; положительная или отрицательная
Возвращает:
скорректированный объект времени; не null

between

public long between(Temporal temporal1Inclusive, Temporal temporal2Exclusive)
Описание скопировано из интерфейса: TemporalUnit
Вычисляет промежуток времени между двумя объектами времени.

Вычисление выполняется в единицах этой единицы. Начальная и конечная точки задаются объектами времени и должны быть совместимых типов. Перед вычислением реализации преобразуют объект второго типа в экземпляр первого типа. Результат будет отрицательным, если конец предшествует началу. Например, промежуток в часах между двумя объектами времени можно вычислить с помощью HOURS.between(startTime, endTime).

Вычисление возвращает целое число, представляющее количество полных единиц между двумя объектами времени. При определении итогового целого числа учитываются значения полей меньших единиц. Например, промежуток в часах между 11:30 и 13:29 составит только один час, поскольку до двух часов не хватает одной минуты; промежуток в месяцах между датами 2024-09-29 и 2025-02-28 (последним днём февраля) составит 4 месяца, поскольку до пяти месяцев не хватает одного дня.

Этот метод можно использовать двумя эквивалентными способами. Первый — вызвать метод напрямую. Второй — использовать Temporal.until(Temporal, TemporalUnit):

  // these two lines are equivalent
  between = thisUnit.between(start, end);
  between = start.until(end, thisUnit);
Выбор следует делать исходя из того, какой вариант делает код понятнее.

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

 long daysBetween = DAYS.between(start, end);
 // or alternatively
 long daysBetween = start.until(end, DAYS);

Реализации должны выполнять запросы и вычисления, используя единицы, доступные в ChronoUnit, или поля, доступные в ChronoField. Если единица не поддерживается, необходимо выбросить UnsupportedTemporalTypeException. Реализации не должны изменять указанные объекты времени.

Определено в:
between в интерфейсе TemporalUnit
Параметры:
temporal1Inclusive — базовый объект времени; не null
temporal2Exclusive — другой объект времени, не включительно; не null
Возвращает:
промежуток времени между temporal1Inclusive и temporal2Exclusive в единицах этой единицы; положительный, если temporal2Exclusive позже temporal1Inclusive, отрицательный, если раньше

toString

public String toString()
Описание скопировано из класса: Enum
Возвращает имя этой константы перечисления, указанное в объявлении. Этот метод можно переопределить, хотя обычно в этом нет необходимости или целесообразности. Класс перечисления должен переопределять этот метод, если существует более удобное для программиста строковое представление.
Определено в:
toString в интерфейсе TemporalUnit
Переопределяет:
toString в классе Enum<ChronoUnit>
Возвращает:
имя этой константы перечисления

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в документации Java SE, содержащей более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и работающие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или её аффилированных лиц в США и других странах.
Авторские права © 1993, 2025, Oracle и/или её аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/time/temporal/ChronoUnit.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API