Перечисление месяца

java.lang.Object

java.lang.Enum<Month>

java.time.Month

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

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

Месяц года, например, 'июль'.

Month - перечисление, представляющее 12 месяцев года: январь, февраль, март, апрель, май, июнь, июль, август, сентябрь, октябрь, ноябрь и декабрь.

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

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

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

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

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

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

Enum.EnumDesc<E extends Enum<E>>

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

Константа перечисления	Описание
`APRIL`	Единственный экземпляр для месяца апреля с 30 днями.
`AUGUST`	Единственный экземпляр для месяца августа с 31 днем.
`DECEMBER`	Единственный экземпляр для месяца декабря с 31 днем.
`FEBRUARY`	Единственный экземпляр для месяца февраля с 28 днями или 29 в високосном году.
`JANUARY`	Единственный экземпляр для месяца января с 31 днем.
`JULY`	Единственный экземпляр для месяца июля с 31 днем.
`JUNE`	Единственный экземпляр для месяца июня с 30 днями.
`MARCH`	Единственный экземпляр для месяца марта с 31 днем.
`MAY`	Единственный экземпляр для месяца мая с 31 днем.
`NOVEMBER`	Единственный экземпляр для месяца ноября с 30 днями.
`OCTOBER`	Единственный экземпляр для месяца октября с 31 днем.
`SEPTEMBER`	Единственный экземпляр для месяца сентября с 30 днями.

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

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

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

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

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

getClass, notify, notifyAll, wait, wait, wait

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

Январь

public static final Month JANUARY

Единственный экземпляр для месяца января с 31 днем. Имеет числовое значение 1.

Февраль

public static final Month FEBRUARY

Единственный экземпляр для месяца февраля с 28 днями или 29 в високосном году. Имеет числовое значение 2.

Март

public static final Month MARCH

Единственный экземпляр для месяца марта с 31 днем. Имеет числовое значение 3.

Апрель

public static final Month APRIL

Единственный экземпляр для месяца апреля с 30 днями. Имеет числовое значение 4.

Май

public static final Month MAY

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

Июнь

public static final Month JUNE

Единственный экземпляр для месяца июня с 30 днями. Имеет числовое значение 6.

Июль

public static final Month JULY

Единственный экземпляр для месяца июля с 31 днем. Имеет числовое значение 7.

Август

public static final Month AUGUST

Единственный экземпляр для месяца августа с 31 днем. Имеет числовое значение 8.

Сентябрь

public static final Month SEPTEMBER

Единственный экземпляр для месяца сентября с 30 днями. Имеет числовое значение 9.

Октябрь

public static final Month OCTOBER

Единственный экземпляр для месяца октября с 31 днем. Имеет числовое значение 10.

Ноябрь

public static final Month NOVEMBER

Единственный экземпляр для месяца ноября с 30 днями. Имеет числовое значение 11.

Декабрь

public static final Month DECEMBER

Единственный экземпляр для месяца декабря с 31 днем. Имеет числовое значение 12.

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

values

public static Month[] values()

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

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

valueOf

public static Month valueOf(String name)

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

Параметры:: name - имя возвращаемой константы перечисления.
Возвращает:: константу перечисления с указанным именем
Исключение:: IllegalArgumentException - если в этом классе перечисления нет константы с указанным именем; NullPointerException - если аргумент равен null

of

public static Month of(int month)

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

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

Параметры:: month - месяц года для представления, от 1 (январь) до 12 (декабрь)
Возвращает:: месяц года, не null
Исключение:: DateTimeException - если месяц года недопустим

from

public static Month from(TemporalAccessor temporal)

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

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

Преобразование извлекает поле MONTH_OF_YEAR. Извлечение разрешено только если временной объект имеет хронологию ISO или может быть преобразован в LocalDate.

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

Параметры:: temporal - временной объект для преобразования, не null
Возвращает:: месяц года, не null
Исключение:: DateTimeException - если невозможно преобразовать в Month

getValue

public int getValue()

Получает значение месяца int.

Значения пронумерованы в соответствии со стандартом ISO-8601, от 1 (январь) до 12 (декабрь).

Возвращает:: месяц года, от 1 (январь) до 12 (декабрь)

getDisplayName

public String getDisplayName(TextStyle style, Locale locale)

Получает текстовое представление, например, 'Янв' или 'Декабрь'.

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

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

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

isSupported

public boolean isSupported(TemporalField field)

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

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

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

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

Определено в:: isSupported в интерфейсе TemporalAccessor
Параметры:: field - поле для проверки, null возвращает false
Возвращает:: true, если поле поддерживается этим месяцем, false - если нет

range

public ValueRange range(TemporalField field)

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

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

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

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

Определено в:: range в интерфейсе TemporalAccessor
Параметры:: field - поле для запроса диапазона, не null
Возвращает:: диапазон допустимых значений для поля, не null
Исключение:: DateTimeException - если диапазон для поля получить невозможно; UnsupportedTemporalTypeException - если поле не поддерживается

get

public int get(TemporalField field)

Получает значение указанного поля из этого месяца как int.

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

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

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

Определено в:: get в интерфейсе TemporalAccessor
Параметры:: field - запрашиваемое поле, не null
Возвращает:: значение поля, в пределах допустимого диапазона значений
Исключение:: DateTimeException - если значение поля получить невозможно или значение выходит за пределы допустимого диапазона значений для поля; UnsupportedTemporalTypeException - если поле не поддерживается или диапазон значений превышает int; ArithmeticException - если произошел переполнение чисел

getLong

public long getLong(TemporalField field)

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

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

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

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

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

plus

public Month plus(long months)

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

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

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

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

minus

public Month minus(long months)

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

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

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

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

length

public int length(boolean leapYear)

Получает длину этого месяца в днях.

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

Февраль имеет 28 дней в обычном году и 29 дней в високосном. Апрель, июнь, сентябрь и ноябрь имеют 30 дней. Все остальные месяцы имеют 31 день.

Parameters:: leapYear - true, если длина требуется для високосного года
Returns:: длина этого месяца в днях, от 28 до 31

minLength

public int minLength()

Получает минимальную длину этого месяца в днях.

Февраль имеет минимальную длину 28 дней. Апрель, июнь, сентябрь и ноябрь имеют 30 дней. Все остальные месяцы имеют 31 день.

Returns:: минимальная длина этого месяца в днях, от 28 до 31

maxLength

public int maxLength()

Получает максимальную длину этого месяца в днях.

Февраль имеет максимальную длину 29 дней. Апрель, июнь, сентябрь и ноябрь имеют 30 дней. Все остальные месяцы имеют 31 день.

Returns:: максимальная длина этого месяца в днях, от 29 до 31

firstDayOfYear

public int firstDayOfYear(boolean leapYear)

Получает день года, соответствующий первому дню этого месяца.

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

Parameters:: leapYear - true, если длина требуется для високосного года
Returns:: день года, соответствующий первому дню этого месяца, от 1 до 336

firstMonthOfQuarter

public Month firstMonthOfQuarter()

Получает месяц, соответствующий первому месяцу этого квартала.

Год можно разделить на четыре квартала. Этот метод возвращает первый месяц квартала для базового месяца. Январь, февраль и март возвращают январь. Апрель, май и июнь возвращают апрель. Июль, август и сентябрь возвращают июль. Октябрь, ноябрь и декабрь возвращают октябрь.

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.MONTH_OF_YEAR в качестве поля. Если указанный временной объект не использует систему календаря ISO, выбрасывается DateTimeException.

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

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

Например, для даты в мае выводами будут:

   dateInMay.with(JANUARY);    // four months earlier
   dateInMay.with(APRIL);      // one months earlier
   dateInMay.with(MAY);        // same date
   dateInMay.with(JUNE);       // one month later
   dateInMay.with(DECEMBER);   // seven months 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/Month.html