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

public static YearMonth of(int year,
                           int month)

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) с отрицанной величиной. См. этот метод для полного описания того, как работает добавление, и, следовательно, вычитание.

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

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.