Spec-Zone.ru › OpenJDK 17

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

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

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

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

Enum.EnumDesc<E extends Enum<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()
Возвращает массив, содержащий константы этого класса перечисления в порядке их объявления.

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

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

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

getClass, notify, notifyAll, wait, wait, wait

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

isSupportedBy

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

НАНОСЕКУНДЫ

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

МИКРОСЕКУНДЫ

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

МИЛЛИСЕКУНДЫ

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

СЕКУНДЫ

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

МИНУТЫ

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

ЧАСЫ

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

ПОЛУСУТОК

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

ДНИ

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

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

НЕДЕЛИ

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

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

МЕСЯЦЫ

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

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

ГОДЫ

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

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

ДЕСЯТИЛЕТИЯ

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

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

ВЕКА

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

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

ТЫСЯЧЕЛЕТИЯ

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

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

ЭРЫ

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

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

ВСЕГДА

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 - временной объект для корректировки, не null
amount - количество этой единицы для добавления, положительное или отрицательное
Возвращает:
скорректированный временной объект, не null

between

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

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

Вычисление возвращает целое число, представляющее количество полных единиц между двумя временными объектами. Например, количество часов между временами 11:30 и 13:29 будет только одним часом, так как он на одну минуту меньше двух часов.

Существует два эквивалентных способа использования этого метода. Первый - вызвать этот метод напрямую. Второй - использовать 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>
Возвращает:
имя этой константы перечисления

© 1993, 2021, 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/17/docs/api/java.base/java/time/temporal/ChronoUnit.html

Spec-Zone.ru

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