Класс 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)

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

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

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

• MONTH_OF_YEAR
• PROLEPTIC_MONTH
• YEAR_OF_ERA
• YEAR
• ERA

Все другие ChronoField экземпляры вернут false.

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

public boolean isSupported(TemporalUnit unit)

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

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

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

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

Все другие ChronoUnit экземпляры вернут false.

Если интервал не является 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) со значением, умноженным на -1. Обратитесь к этому методу для полного описания того, как работает добавление, а, следовательно, и вычитание.

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

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: