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

java.lang.Object

java.lang.Enum<DayOfWeek>

java.time.DayOfWeek

Все реализованные интерфейсы:: Serializable, Comparable<DayOfWeek>, Constable, TemporalAccessor, TemporalAdjuster

public enum DayOfWeek extends Enum<DayOfWeek> implements TemporalAccessor, TemporalAdjuster

День недели, например, 'Вторник'.

DayOfWeek — это перечисление, представляющее 7 дней недели — понедельник, вторник, среда, четверг, пятница, суббота и воскресенье.

В дополнение к текстовому имени перечисления, каждый день недели имеет int значение. int значение следует стандарту ISO-8601, от 1 (понедельник) до 7 (воскресенье). Рекомендуется, чтобы приложения использовали перечисление, а не int значение для обеспечения ясности кода.

Это перечисление предоставляет доступ к локализованной текстовой форме дня недели. В некоторых локалях дням также присваиваются разные числовые значения, например, воскресенье может иметь значение 1, однако этот класс не поддерживает это. Смотрите WeekFields для локализованного нумерации недель.

Не используйте ordinal() для получения числового представления DayOfWeek. Используйте getValue() вместо этого.

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

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

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

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

Enum.EnumDesc<E extends Enum<E>>

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

Константа перечисления	Описание
`FRIDAY`	Единственный экземпляр для дня недели пятница.
`MONDAY`	Единственный экземпляр для дня недели понедельник.
`SATURDAY`	Единственный экземпляр для дня недели суббота.
`SUNDAY`	Единственный экземпляр для дня недели воскресенье.
`THURSDAY`	Единственный экземпляр для дня недели четверг.
`TUESDAY`	Единственный экземпляр для дня недели вторник.
`WEDNESDAY`	Единственный экземпляр для дня недели среда.

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

Модификатор и тип	Метод	Описание
`Temporal`	`adjustInto(Temporal temporal)`	Настраивает указанный временной объект, чтобы он соответствовал этому дню недели.
`static DayOfWeek`	`from(TemporalAccessor temporal)`	Получает экземпляр `DayOfWeek` из временного объекта.
`int`	`get(TemporalField field)`	Получает значение указанного поля из этого дня недели в виде `int`.
`String`	`getDisplayName(TextStyle style, Locale locale)`	Получает текстовое представление, например, 'Пн' или 'Пятница'.
`long`	`getLong(TemporalField field)`	Получает значение указанного поля из этого дня недели в виде `long`.
`int`	`getValue()`	Получает значение дня недели в формате `int`.
`boolean`	`isSupported(TemporalField field)`	Проверяет, поддерживается ли указанное поле.
`DayOfWeek`	`minus(long days)`	Возвращает день недели, который находится на указанное количество дней до текущего.
`static DayOfWeek`	`of(int dayOfWeek)`	Получает экземпляр `DayOfWeek` из `int` значения.
`DayOfWeek`	`plus(long days)`	Возвращает день недели, который находится на указанное количество дней после текущего.
`<R> R`	`query(TemporalQuery<R> query)`	Запрашивает этот день недели с помощью указанного запроса.
`ValueRange`	`range(TemporalField field)`	Получает диапазон допустимых значений для указанного поля.
`static DayOfWeek`	`valueOf(String name)`	Возвращает константу перечисления этого класса с указанным именем.
`static DayOfWeek[]`	`values()`	Возвращает массив, содержащий константы этого класса перечисления в порядке их объявления.

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

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

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

getClass, notify, notifyAll, wait, wait, wait

END_OF_DOCUMENT_MARKER

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

ПОНЕДЕЛЬНИК

public static final DayOfWeek MONDAY

Единственный экземпляр для дня недели — понедельник. У него числовое значение 1.

ВТОРНИК

public static final DayOfWeek TUESDAY

Единственный экземпляр для дня недели — вторник. У него числовое значение 2.

СРЕДА

public static final DayOfWeek WEDNESDAY

Единственный экземпляр для дня недели — среда. У него числовое значение 3.

ЧЕТВЕРГ

public static final DayOfWeek THURSDAY

Единственный экземпляр для дня недели — четверг. У него числовое значение 4.

ПЯТНИЦА

public static final DayOfWeek FRIDAY

Единственный экземпляр для дня недели — пятница. У него числовое значение 5.

СУББОТА

public static final DayOfWeek SATURDAY

Единственный экземпляр для дня недели — суббота. У него числовое значение 6.

ВОСКРЕСЕНЬЕ

public static final DayOfWeek SUNDAY

Единственный экземпляр для дня недели — воскресенье. У него числовое значение 7.

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

values

public static DayOfWeek[] values()

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

Returns:: массив, содержащий константы этого перечисления в порядке их объявления

valueOf

public static DayOfWeek valueOf(String name)

Возвращает константу перечисления этого класса с заданным именем. Строка должна точно совпадать с идентификатором, используемым для объявления константы перечисления в этом классе. (Вспомогательные пробелы не допускаются.)

Parameters:: name - имя возвращаемой константы перечисления.
Returns:: константа перечисления с заданным именем
Throws:: IllegalArgumentException - если в этом классе перечисления нет константы с заданным именем; NullPointerException - если аргумент равен null

of

public static DayOfWeek of(int dayOfWeek)

Получает экземпляр DayOfWeek по значению int.

DayOfWeek — перечисление, представляющее 7 дней недели. Этот фабричный метод позволяет получить перечисление по значению int. Значение int соответствует стандарту ISO-8601, от 1 (понедельник) до 7 (воскресенье).

Parameters:: dayOfWeek - день недели для представления, от 1 (понедельник) до 7 (воскресенье)
Returns:: экземпляр дня недели, не null
Throws:: DateTimeException - если день недели некорректен

from

public static DayOfWeek from(TemporalAccessor temporal)

Получает экземпляр DayOfWeek из временного объекта.

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

Преобразование извлекает поле DAY_OF_WEEK.

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

Parameters:: temporal - временной объект для преобразования, не null
Returns:: день недели, не null
Throws:: DateTimeException - если преобразование в DayOfWeek невозможно

getValue

public int getValue()

Получает значение дня недели int.

Значения нумеруются в соответствии со стандартом ISO-8601, от 1 (понедельник) до 7 (воскресенье). Смотрите WeekFields.dayOfWeek() для локализованного определения номера недели.

Returns:: день недели, от 1 (понедельник) до 7 (воскресенье)

getDisplayName

public String getDisplayName(TextStyle style, Locale locale)

Получает текстовое представление, например, 'Пн' или 'Пятница'.

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

Если текстовое соответствие не найдено, возвращается значение numeric value.

Parameters:: style - длина требуемого текста, не null; locale - язык для использования, не null
Returns:: текстовое значение дня недели, не null

isSupported

public boolean isSupported(TemporalField field)

Проверяет, поддерживается ли указанное поле.

Проверяет, можно ли запросить у этого дня недели указанное поле. Если false, вызов методов range и get приведет к ошибке.

Если поле равно DAY_OF_WEEK, то этот метод возвращает true. Все другие экземпляры ChronoField вернут false.

Если поле не является ChronoField, то результат этого метода получается путем вызова TemporalField.isSupportedBy(TemporalAccessor) с this в качестве аргумента. Поддерживается ли поле, определяется полем.

Specified by:: isSupported в интерфейсе TemporalAccessor
Parameters:: field - поле для проверки, null возвращает false
Returns:: true, если поле поддерживается этим днем недели, false — иначе

range

public ValueRange range(TemporalField field)

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

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

Если поле равно DAY_OF_WEEK, то возвращается диапазон дня недели от 1 до 7. Все остальные экземпляры ChronoField выбросят UnsupportedTemporalTypeException.

Если поле не является ChronoField, то результат этого метода получается путем вызова TemporalField.rangeRefinedBy(TemporalAccessor) с this в качестве аргумента. Возможна ли получение диапазона определяется полем.

Specified by:: range в интерфейсе TemporalAccessor
Parameters:: field - поле для запроса диапазона, не null
Returns:: диапазон допустимых значений для поля, не null
Throws:: DateTimeException - если диапазон для поля получить невозможно; UnsupportedTemporalTypeException - если поле не поддерживается

get

public int get(TemporalField field)

Получает значение указанного поля из этого дня недели в виде int.

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

Если поле равно DAY_OF_WEEK, то возвращается значение дня недели от 1 до 7. Все остальные экземпляры ChronoField выбросят UnsupportedTemporalTypeException.

Если поле не является ChronoField, то результат этого метода получается путем вызова TemporalField.getFrom(TemporalAccessor) с this в качестве аргумента. Возможно ли получить значение и что оно представляет, определяется полем.

Specified by:: get в интерфейсе TemporalAccessor
Parameters:: field - поле для получения, не null
Returns:: значение поля, в пределах допустимого диапазона
Throws:: DateTimeException - если значение для поля получить невозможно или оно находится вне диапазона допустимых значений для поля; UnsupportedTemporalTypeException - если поле не поддерживается или диапазон значений превышает int; ArithmeticException - если происходит переполнение при вычислении

getLong

public long getLong(TemporalField field)

Получает значение указанного поля из этого дня недели в качестве long.

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

Если поле равно DAY_OF_WEEK, то будет возвращено значение дня недели от 1 до 7. Все другие ChronoField экземпляры будут выбрасывать исключение UnsupportedTemporalTypeException.

Если поле не является ChronoField, то результат этого метода получается путем вызова TemporalField.getFrom(TemporalAccessor), передавая this в качестве аргумента. Возможность получения значения и то, что представляет собой значение, определяется полем.

Specified by:: getLong в интерфейсе TemporalAccessor
Parameters:: field - поле для получения, не null
Returns:: значение для поля
Throws:: DateTimeException - если значение для поля получить невозможно; UnsupportedTemporalTypeException - если поле не поддерживается; ArithmeticException - если происходит переполнение целочисленных значений

plus

public DayOfWeek plus(long days)

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

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

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

Parameters:: days - количество дней для добавления, положительное или отрицательное
Returns:: результирующий день недели, не null

minus

public DayOfWeek minus(long days)

Возвращает день недели, который является указанным числом дней до этого.

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

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

Parameters:: days - количество дней для вычитания, положительное или отрицательное
Returns:: результирующий день недели, не null

query

public <R> R query(TemporalQuery<R> query)

Запрашивает этот день недели с использованием указанного запроса.

Запрашивает этот день недели с использованием указанного объекта стратегии запроса. Объект TemporalQuery определяет логику, которая используется для получения результата. Прочитайте документацию запроса, чтобы понять, каким будет результат этого метода.

Результат этого метода получается путем вызова метода TemporalQuery.queryFrom(TemporalAccessor) на указанном запросе, передавая this в качестве аргумента.

Specified by:: query в интерфейсе TemporalAccessor
Type Parameters:: R - тип результата
Parameters:: query - запрос для вызова, не null
Returns:: результат запроса, может быть null (определяется запросом)
Throws:: DateTimeException - если запрос выполнить невозможно (определяется запросом); ArithmeticException - если происходит переполнение целочисленных значений (определяется запросом)

adjustInto

public Temporal adjustInto(Temporal temporal)

Корректирует указанный временной объект, чтобы иметь этот день недели.

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

Корректировка эквивалентна использованию Temporal.with(TemporalField, long), передавая ChronoField.DAY_OF_WEEK в качестве поля. Обратите внимание, что это корректирует вперед или назад в пределах недели с понедельника по воскресенье. См. WeekFields.dayOfWeek() для локально заданных дней начала недели. См. TemporalAdjuster для других корректоров с большим контролем, таких как next(MONDAY).

В большинстве случаев понятнее использовать обратный порядок вызовов, используя Temporal.with(TemporalAdjuster):

   // these two lines are equivalent, but the second approach is recommended
   temporal = thisDayOfWeek.adjustInto(temporal);
   temporal = temporal.with(thisDayOfWeek);

Например, для даты, которая является средой, вывод будет следующим:

   dateOnWed.with(MONDAY);     // two days earlier
   dateOnWed.with(TUESDAY);    // one day earlier
   dateOnWed.with(WEDNESDAY);  // same date
   dateOnWed.with(THURSDAY);   // one day later
   dateOnWed.with(FRIDAY);     // two days later
   dateOnWed.with(SATURDAY);   // three days later
   dateOnWed.with(SUNDAY);     // four days later

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

Specified by:: adjustInto в интерфейсе TemporalAdjuster
Parameters:: temporal - целевой объект для корректировки, не null
Returns:: откорректированный объект, не null
Throws:: DateTimeException - если корректировку выполнить невозможно; ArithmeticException - если происходит переполнение целочисленных значений

© 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/DayOfWeek.html