Класс YearMonth

public static YearMonth now()

Получает текущий год-месяц с системных часов в часовом поясе по умолчанию.

Это запросит system clock в часовом поясе по умолчанию для получения текущего года-месяца.

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

public static YearMonth now(ZoneId zone)

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

Это запросит system clock для получения текущего года-месяца. Указание часового пояса избегает зависимости от часового пояса по умолчанию.

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

public static YearMonth now(Clock clock)

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

Это запросит указанные часы для получения текущего года-месяца. Использование этого метода позволяет использовать альтернативные часы для тестирования. Альтернативные часы могут быть введены с помощью dependency injection.

public static YearMonth of(int year, Month month)

Получает экземпляр YearMonth из года и месяца.

public static YearMonth of(int year, int month)

Получает экземпляр YearMonth из года и месяца.

public static YearMonth from(TemporalAccessor temporal)

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

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

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

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

public static YearMonth parse(CharSequence text)

Получает экземпляр YearMonth из текстовой строки, такой как 2007-12.

Строка должна представлять собой допустимый год-месяц. Формат должен быть uuuu-MM. Года вне диапазона от 0000 до 9999 должны быть префиксны знаком плюс или минус.

public static YearMonth parse(CharSequence text, DateTimeFormatter formatter)

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

Текст парсится с помощью форматера, возвращая год-месяц.

public boolean isSupported(TemporalField field)

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

Проверяет, может ли быть запрошен этот год-месяц для указанного поля. Если ложно, то вызов методов range, get и with(TemporalField, long) вызовет исключение.

Если поле является ChronoField, то запрос выполняется здесь. Поддерживаемые поля:

• MONTH_OF_YEAR
• PROLEPTIC_MONTH
• YEAR_OF_ERA
• YEAR
• ERA

Все остальные ChronoField возвращают ложь.

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

public boolean isSupported(TemporalUnit unit)

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

Проверяет, может ли указанный интервал быть добавлен к или вычтен из этого года-месяца. Если ложно, то вызов методов plus(long, TemporalUnit) и minus вызовет исключение.

Если интервал является ChronoUnit, то запрос выполняется здесь. Поддерживаемые интервалы:

• MONTHS
• YEARS
• DECADES
• CENTURIES
• MILLENNIA
• ERAS

Все остальные ChronoUnit возвращают ложь.

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

public ValueRange range(TemporalField field)

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

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

Если поле является ChronoField, то запрос выполняется здесь. Метод supported fields возвращает соответствующие объекты диапазона. Все остальные ChronoField экземпляры выбросят исключение UnsupportedTemporalTypeException.

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

public int get(TemporalField field)

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

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

Если поле является ChronoField, то запрос обрабатывается здесь. supported fields вернёт корректные значения на основе этого года-месяца, за исключением PROLEPTIC_MONTH, которое слишком велико, чтобы поместиться в int, и вызовет DateTimeException. Все остальные экземпляры ChronoField вызовут UnsupportedTemporalTypeException.

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

public long getLong(TemporalField field)

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

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

Если поле является ChronoField, то запрос обрабатывается здесь. supported fields вернёт корректные значения на основе этого года-месяца. Все остальные экземпляры ChronoField вызовут UnsupportedTemporalTypeException.

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

public int getYear()

Возвращает поле года.

Этот метод возвращает примитивное значение int для года.

Год, возвращаемый этим методом, пролептический, как указано в get(YEAR).

public int getMonthValue()

Возвращает поле месяца от 1 до 12.

Этот метод возвращает месяц как int от 1 до 12. Код приложения часто становится более понятным, если используется перечисление Month, вызвав getMonth().

public Month getMonth()

Возвращает поле месяца с использованием перечисления Month.

Этот метод возвращает перечисление Month для месяца. Это помогает избежать путаницы, какие значения int означают. Если вам нужен доступ к примитивному значению int, то перечисление предоставляет int value.

public boolean isLeapYear()

Проверяет, является ли год високосным, согласно правилам системы пролептического календаря ISO.

Этот метод применяет текущие правила для високосных годов на протяжении всего временного промежутка. В общем случае год является високосным, если он делится на четыре без остатка. Однако годы, делящиеся на 100, не являются високосным, за исключением годов, делящихся на 400, которые являются високосным.

Например, 1904 год является високосным, так как делится на 4. 1900 год не был високосным, так как делится на 100, однако 2000 год был високосным, так как делится на 400.

Вычисление пролептическое - применяется к далёкому будущему и далёкому прошлому. Это исторически неточно, но соответствует стандарту ISO-8601.

public boolean isValidDay(int dayOfMonth)

Проверяет, является ли день месяца допустимым для этого года-месяца.

Этот метод проверяет, образуют ли этот год, месяц и введённый день действительную дату.

public int lengthOfMonth()

Возвращает длительность месяца с учётом года.

Возвращает длительность месяца в днях. Например, дата в январе вернёт 31.

public int lengthOfYear()

Возвращает длительность года.

Возвращает длительность года в днях, либо 365, либо 366.

public YearMonth with(TemporalAdjuster adjuster)

Возвращает скопированную и изменённую копию этого года-месяца.

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

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

Результат этого метода получается путём вызова метода TemporalAdjuster.adjustInto(Temporal) указанного корректировщика, передавая this в качестве аргумента.

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

public YearMonth with(TemporalField field, long newValue)

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

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

Если поле является ChronoField, то корректировка выполняется здесь. Поддерживаемые поля работают следующим образом:

• MONTH_OF_YEAR - Возвращает YearMonth с указанным месяцем. Год останется неизменным.
• PROLEPTIC_MONTH - Возвращает YearMonth с указанным пролептическим месяцем. Это полностью заменяет год и месяц этого объекта.
• YEAR_OF_ERA - Возвращает YearMonth с указанным годом эпохи. Месяц и эпоха останутся неизменными.
• YEAR - Возвращает YearMonth с указанным годом. Месяц останется неизменным.
• ERA - Возвращает YearMonth с указанной эпохой. Месяц и год эпохи останутся неизменными.

Во всех случаях, если новое значение выходит за пределы допустимого диапазона значений для поля, будет выброшено DateTimeException.

Все остальные ChronoField вызовут UnsupportedTemporalTypeException.

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

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

public YearMonth withYear(int year)

Возвращает копию этого YearMonth с изменённым годом.

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

public YearMonth withMonth(int month)

Возвращает копию этого YearMonth с изменённым месяцем года.

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

public YearMonth plus(TemporalAmount amountToAdd)

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

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

Вычисление делегируется объекту значения вызовом TemporalAmount.addTo(Temporal). Реализация значения свободна реализовывать добавление любым способом, однако обычно она обращается к plus(long, TemporalUnit). Обратитесь к документации реализации значения, чтобы определить, можно ли его успешно добавить.

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

public YearMonth plus(long amountToAdd, TemporalUnit unit)

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

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

Если поле является ChronoUnit, то добавление выполняется здесь. Поддерживаемые поля ведут себя следующим образом:

• MONTHS - Возвращает копию YearMonth с добавлением указанного количества месяцев. Это эквивалентно plusMonths(long).
• YEARS - Возвращает копию YearMonth с добавлением указанного количества лет. Это эквивалентно plusYears(long).
• DECADES - Возвращает копию YearMonth с добавлением указанного количества десятилетий. Это эквивалентно вызову plusYears(long) со значением, умноженным на 10.
• CENTURIES - Возвращает копию YearMonth с добавлением указанного количества столетий. Это эквивалентно вызову plusYears(long) со значением, умноженным на 100.
• MILLENNIA - Возвращает копию YearMonth с добавлением указанного количества тысячелетий. Это эквивалентно вызову plusYears(long) со значением, умноженным на 1000.
• ERAS - Возвращает копию YearMonth с добавлением указанного количества эр. Поддерживаются только две эры, поэтому значение должно быть единицей, нулём или минус единицей. Если значение не равно нулю, то год изменяется таким образом, что год-эпохи не изменяется.

Все остальные ChronoUnit объекты выбросят UnsupportedTemporalTypeException.

Если поле не является ChronoUnit, то результат этого метода получается путём вызова TemporalUnit.addTo(Temporal, long) с передачей this в качестве аргумента. В этом случае единица определяет, выполнять ли и как выполнять добавление.

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

public YearMonth plusYears(long yearsToAdd)

Возвращает копию этого YearMonth с добавлением указанного количества лет.

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

public YearMonth plusMonths(long monthsToAdd)

Возвращает копию этого YearMonth с добавлением указанного количества месяцев.

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

public YearMonth minus(TemporalAmount amountToSubtract)

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

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

Вычисление делегируется объекту значения вызовом TemporalAmount.subtractFrom(Temporal). Реализация значения свободна реализовывать вычитание любым способом, однако обычно она обращается к minus(long, TemporalUnit). Обратитесь к документации реализации значения, чтобы определить, можно ли его успешно вычесть.

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

public YearMonth minus(long amountToSubtract, TemporalUnit unit)

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

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

Этот метод эквивалентен plus(long, TemporalUnit) с отрицательным значением. Обратитесь к тому методу для полного описания того, как работает добавление, а следовательно, и вычитание.

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

public YearMonth minusYears(long yearsToSubtract)

Возвращает копию этого YearMonth с вычитанием указанного количества лет.

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

public YearMonth minusMonths(long monthsToSubtract)

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

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

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

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

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

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

public Temporal adjustInto(Temporal temporal)

Корректирует указанный временной объект, чтобы он содержал этот год-месяц.

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

Корректировка эквивалентна использованию Temporal.with(TemporalField, long), передавая ChronoField.PROLEPTIC_MONTH в качестве поля. Если указанный временной объект не использует систему календаря ISO, то выбрасывается исключение DateTimeException.

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

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

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

public long until(Temporal endExclusive, TemporalUnit unit)

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

Это вычисляет количество времени между двумя объектами YearMonth в терминах одной TemporalUnit. Начальная и конечная точки — это this и указанный год-месяц. Результат будет отрицательным, если конец предшествует началу. Temporal , переданный в этот метод, преобразуется в YearMonth с использованием from(TemporalAccessor). Например, количество лет между двумя годами-месяцами можно вычислить с помощью startYearMonth.until(endYearMonth, YEARS).

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

Есть два эквивалентных способа использования этого метода. Первый — вызвать этот метод. Второй — использовать TemporalUnit.between(Temporal, Temporal):

   // these two lines are equivalent
   amount = start.until(end, MONTHS);
   amount = MONTHS.between(start, end);
 

Выбор должен быть сделан на основе того, что делает код более читаемым.

Вычисление реализовано в этом методе для ChronoUnit. Поддерживаются единицы MONTHS, YEARS, DECADES, CENTURIES, MILLENNIA и ERAS. Другие значения ChronoUnit будут вызывать исключение.

Если единица не является ChronoUnit, то результат этого метода получается путем вызова TemporalUnit.between(Temporal, Temporal) , передавая this в качестве первого аргумента и преобразованный входной временной объект — в качестве второго.

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

public String format(DateTimeFormatter formatter)

Форматирует этот год-месяц с использованием указанного форматера.

Этот год-месяц будет передан форматеру для получения строки.

public LocalDate atDay(int dayOfMonth)

Объединяет этот год-месяц с днем месяца для создания LocalDate.

Возвращает LocalDate, сформированный из этого года-месяца и указанного дня месяца.

Значение дня месяца должно быть допустимым для года-месяца.

Этот метод может использоваться в цепочке для создания даты:

  LocalDate date = year.atMonth(month).atDay(day);
 

public LocalDate atEndOfMonth()

Возвращает LocalDate в конце месяца.

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

Этот метод может использоваться в цепочке для создания даты:

  LocalDate date = year.atMonth(month).atEndOfMonth();
 

public int compareTo(YearMonth other)

Сравнивает этот год-месяц с другим годом-месяцем.

Сравнение основано сначала на значении года, а затем на значении месяца. Оно «совместимо с equals», как определено в Comparable.

public boolean isAfter(YearMonth other)

Проверяет, следует ли этот год-месяц за указанным годом-месяцем.

public boolean isBefore(YearMonth other)

Проверяет, предшествует ли этот год-месяц указанному году-месяцу.

public boolean equals(Object obj)

Проверяет, равен ли этот год-месяц другому году-месяцу.

Сравнение основано на временном положении годов-месяцев.

public int hashCode()

Хеш-код для этого года-месяца.

public String toString()

Выводит этот год-месяц как String, например, 2007-12.

Вывод будет в формате uuuu-MM: