Класс YearMonth
- Все реализуемые интерфейсы:
Serializable, Comparable<YearMonth>, Temporal, TemporalAccessor, TemporalAdjuster
public final class YearMonth extends Object implements Temporal, TemporalAdjuster, Comparable<YearMonth>, Serializable
2007-12. YearMonth — неизменяемый объект даты и времени, представляющий сочетание года и месяца. Можно получить значение любого поля, выводимого из года и месяца, например квартал года.
Этот класс не хранит и не представляет день, время или часовой пояс. Например, значение «октябрь 2007 года» можно сохранить в YearMonth.
Календарная система ISO-8601 — это современная гражданская календарная система, используемая сегодня в большинстве стран мира. Она эквивалентна пролептической григорианской календарной системе, в которой современные правила високосных лет применяются ко всему временному периоду. Для большинства современных приложений правила ISO-8601 вполне подходят. Однако для приложений, работающих с историческими датами, точность которых важна, подход ISO-8601 не подходит.
Это класс, основанный на значениях; программистам следует считать экземпляры, которые равны, взаимозаменяемыми и не использовать экземпляры для синхронизации, иначе возможно непредсказуемое поведение. Например, в будущей версии синхронизация может завершиться неудачей. Для сравнения следует использовать метод equals.
- Требования к реализации:
- Этот класс неизменяемый и потокобезопасный.
- Начиная с версии:
- 1.8
- См. также:
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
Temporal |
adjustInto |
Изменяет указанный временной объект так, чтобы он представлял этот год и месяц. |
LocalDate |
atDay |
Объединяет этот год и месяц с днем месяца, создавая LocalDate. |
LocalDate |
atEndOfMonth() |
Возвращает LocalDate в конце месяца. |
int |
compareTo |
Сравнивает этот год и месяц с другим годом и месяцем. |
boolean |
equals |
Проверяет, равен ли этот год и месяц другому году и месяцу. |
String |
format |
Форматирует этот год и месяц с помощью указанного форматировщика. |
static YearMonth |
from |
Получает экземпляр YearMonth из временного объекта. |
int |
get |
Получает значение указанного поля этого года и месяца как int. |
long |
getLong |
Получает значение указанного поля этого года и месяца как long. |
Month |
getMonth() |
Получает поле месяца года с помощью перечисления Month. |
int |
getMonthValue() |
Получает значение поля месяца года от 1 до 12. |
int |
getYear() |
Получает поле года. |
int |
hashCode() |
Хеш-код этого года и месяца. |
boolean |
isAfter |
Проверяет, идет ли этот год и месяц после указанного года и месяца. |
boolean |
isBefore |
Проверяет, идет ли этот год и месяц перед указанным годом и месяцем. |
boolean |
isLeapYear() |
Проверяет, является ли год високосным согласно правилам пролептической календарной системы ISO. |
boolean |
isSupported |
Проверяет, поддерживается ли указанное поле. |
boolean |
isSupported |
Проверяет, поддерживается ли указанная единица измерения. |
boolean |
isValidDay |
Проверяет, допустим ли день месяца для этого года и месяца. |
int |
lengthOfMonth() |
Возвращает длину месяца с учетом года. |
int |
lengthOfYear() |
Возвращает длину года. |
YearMonth |
minus |
Возвращает копию этого года и месяца с вычтенным указанным значением. |
YearMonth |
minus |
Возвращает копию этого года и месяца с вычтенным указанным значением. |
YearMonth |
minusMonths |
Возвращает копию этого YearMonth с вычтенным указанным количеством месяцев. |
YearMonth |
minusYears |
Возвращает копию этого YearMonth с вычтенным указанным количеством лет. |
static YearMonth |
now() |
Получает текущие год и месяц по системным часам в часовом поясе по умолчанию. |
static YearMonth |
now |
Получает текущие год и месяц по указанным часам. |
static YearMonth |
now |
Получает текущие год и месяц по системным часам в указанном часовом поясе. |
static YearMonth |
of |
Получает экземпляр YearMonth из года и месяца. |
static YearMonth |
of |
Получает экземпляр YearMonth из года и месяца. |
static YearMonth |
parse |
Получает экземпляр YearMonth из текстовой строки, например 2007-12. |
static YearMonth |
parse |
Получает экземпляр YearMonth из текстовой строки с помощью указанного форматировщика. |
YearMonth |
plus |
Возвращает копию этого года и месяца с добавленным указанным значением. |
YearMonth |
plus |
Возвращает копию этого года и месяца с добавленным указанным значением. |
YearMonth |
plusMonths |
Возвращает копию этого YearMonth с добавленным указанным количеством месяцев. |
YearMonth |
plusYears |
Возвращает копию этого YearMonth с добавленным указанным количеством лет. |
<R> R |
query |
Выполняет запрос к этому году и месяцу с помощью указанного запроса. |
ValueRange |
range |
Получает диапазон допустимых значений для указанного поля. |
String |
toString() |
Выводит этот год и месяц в виде String, например 2007-12. |
long |
until |
Вычисляет промежуток времени до другого года и месяца в указанных единицах измерения. |
YearMonth |
with |
Возвращает скорректированную копию этого года и месяца. |
YearMonth |
with |
Возвращает копию этого года и месяца, в которой указанному полю присвоено новое значение. |
YearMonth |
withMonth |
Возвращает копию этого YearMonth с измененным значением месяца года. |
YearMonth |
withYear |
Возвращает копию этого YearMonth с измененным значением года. |
Методы, объявленные в классе Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait | Модификатор и тип | Метод | Описание |
|---|---|---|
protected Object |
clone() |
Создает и возвращает копию этого объекта. |
protected void |
finalize() |
Устарело, будет удалено: этот элемент API планируется удалить в будущей версии. Финализация объявлена устаревшей и будет удалена в одном из будущих выпусков. |
final Class |
getClass() |
Возвращает класс времени выполнения этого Object. |
final void |
notify() |
Пробуждает один поток, ожидающий на мониторе этого объекта. |
final void |
notifyAll() |
Пробуждает все потоки, ожидающие на мониторе этого объекта. |
final void |
wait() |
Переводит текущий поток в состояние ожидания до пробуждения, обычно вследствие вызова notify или interrupt. |
final void |
wait |
Переводит текущий поток в состояние ожидания до пробуждения, обычно вследствие вызова notify или interrupt, либо до истечения заданного интервала реального времени. |
final void |
wait |
Переводит текущий поток в состояние ожидания до пробуждения, обычно вследствие вызова notify или interrupt, либо до истечения заданного интервала реального времени. |
Подробное описание методов
now
public static YearMonth now()
Для получения текущих года и месяца выполняется запрос к system clock в часовом поясе по умолчанию.
Использование этого метода не позволит использовать альтернативные часы для тестирования, так как часы заданы жестко.
- Возвращает:
- текущие год и месяц по системным часам и в часовом поясе по умолчанию, не null
now
public static YearMonth now(ZoneId zone)
Для получения текущих года и месяца выполняется запрос к system clock. Указание часового пояса позволяет избежать зависимости от часового пояса по умолчанию.
Использование этого метода не позволит использовать альтернативные часы для тестирования, так как часы заданы жестко.
- Параметры:
-
zone— идентификатор часового пояса, который следует использовать; не null - Возвращает:
- текущие год и месяц по системным часам, не null
now
public static YearMonth now(Clock clock)
Для получения текущих года и месяца выполняется запрос к указанным часам. Использование этого метода позволяет применять альтернативные часы для тестирования. Альтернативные часы можно создать с помощью dependency injection.
- Параметры:
-
clock— часы, которые следует использовать; не null - Возвращает:
- текущие год и месяц, не null
of
public static YearMonth of(int year, Month month)
YearMonth по году и месяцу.- Параметры:
-
year— представляемый год, от MIN_YEAR до MAX_YEAR -
month— представляемый месяц года, не null - Возвращает:
- год и месяц, не null
- Исключения:
-
DateTimeException— если значение года недопустимо
of
public static YearMonth of(int year, int month)
YearMonth по году и месяцу.- Параметры:
-
year— представляемый год, от MIN_YEAR до MAX_YEAR -
month— представляемый месяц года, от 1 (январь) до 12 (декабрь) - Возвращает:
- год и месяц, не null
- Исключения:
-
DateTimeException— если значение любого из полей недопустимо
from
public static YearMonth from(TemporalAccessor temporal)
YearMonth из объекта времени. Год и месяц определяются на основе указанного объекта времени. TemporalAccessor представляет произвольный набор сведений о дате и времени, который эта фабрика преобразует в экземпляр YearMonth.
В ходе преобразования извлекаются поля YEAR и MONTH_OF_YEAR. Извлечение допускается только в том случае, если объект времени использует хронологию ISO или может быть преобразован в LocalDate.
Сигнатура этого метода соответствует функциональному интерфейсу TemporalQuery, что позволяет использовать его как запрос посредством ссылки на метод, YearMonth::from.
- Параметры:
-
temporal— преобразуемый объект времени, не null - Возвращает:
- год и месяц, не null
- Исключения:
-
DateTimeException— если преобразование вYearMonthневозможно
parse
public static YearMonth parse(CharSequence text)
YearMonth из текстовой строки, например 2007-12. Строка должна представлять допустимые год и месяц. Формат должен быть uuuu-MM. Перед годами, выходящими за диапазон от 0000 до 9999, необходимо указывать знак плюса или минуса.
- Параметры:
-
text— разбираемый текст, например "2007-12", не null - Возвращает:
- разобранные год и месяц, не null
- Исключения:
-
DateTimeParseException— если текст невозможно разобрать
parse
public static YearMonth parse(CharSequence text, DateTimeFormatter formatter)
YearMonth из текстовой строки с использованием указанного форматировщика. Текст разбирается с помощью форматировщика, в результате чего возвращаются год и месяц.
- Параметры:
-
text— разбираемый текст, не null -
formatter— используемый форматировщик, не null - Возвращает:
- разобранные год и месяц, не null
- Исключения:
-
DateTimeParseException— если текст невозможно разобрать
isSupported
public boolean isSupported(TemporalField field)
Проверяет, можно ли получить из этих года и месяца значение указанного поля. Если нет, вызовы методов range, get и with(TemporalField, long) приведут к выбросу исключения.
Если поле является ChronoField, запрос обрабатывается здесь. Поддерживаются следующие поля:
-
MONTH_OF_YEAR -
PROLEPTIC_MONTH -
YEAR_OF_ERA -
YEAR -
ERA
ChronoField возвращается false. Если поле не является ChronoField, результат этого метода получается вызовом TemporalField.isSupportedBy(TemporalAccessor) с аргументом this. Поддержка поля определяется самим полем.
- Определено в:
-
isSupportedв интерфейсеTemporalAccessor - Параметры:
-
field— проверяемое поле; для null возвращается false - Возвращает:
- true, если это поле поддерживается для этих года и месяца; в противном случае false
isSupported
public boolean isSupported(TemporalUnit unit)
Проверяет, можно ли прибавить указанную единицу измерения к этим году и месяцу или вычесть ее из них. Если нет, вызовы методов plus(long, TemporalUnit) и minus приведут к выбросу исключения.
Если единица измерения является ChronoUnit, запрос обрабатывается здесь. Поддерживаются следующие единицы измерения:
-
MONTHS -
YEARS -
DECADES -
CENTURIES -
MILLENNIA -
ERAS
ChronoUnit возвращается false. Если единица измерения не является ChronoUnit, результат этого метода получается вызовом TemporalUnit.isSupportedBy(Temporal) с аргументом this. Поддержка единицы измерения определяется самой единицей.
- Определено в:
-
isSupportedв интерфейсеTemporal - Параметры:
-
unit— проверяемая единица измерения; для null возвращается false - Возвращает:
- true, если единицу измерения можно прибавить или вычесть; в противном случае false
range
public ValueRange range(TemporalField field)
Объект диапазона задает минимальное и максимальное допустимые значения поля. Эти год и месяц используются для повышения точности возвращаемого диапазона. Если вернуть диапазон невозможно, поскольку поле не поддерживается или по иной причине, выбрасывается исключение.
Если поле является ChronoField, запрос обрабатывается здесь. Метод supported fields возвращает подходящие экземпляры диапазона. Для всех остальных экземпляров ChronoField выбрасывается UnsupportedTemporalTypeException.
Если поле не является ChronoField, результат этого метода получается вызовом TemporalField.rangeRefinedBy(TemporalAccessor) с аргументом this. Возможность получения диапазона определяется самим полем.
- Определено в:
-
rangeв интерфейсеTemporalAccessor - Параметры:
-
field— поле, диапазон которого требуется получить; не null - Возвращает:
- диапазон допустимых значений поля, не null
- Исключения:
-
DateTimeException— если диапазон значений поля невозможно получить -
UnsupportedTemporalTypeException— если поле не поддерживается
get
public int get(TemporalField field)
int. Метод запрашивает значение указанного поля для этих года и месяца. Возвращаемое значение всегда находится в пределах допустимого диапазона значений поля. Если вернуть значение невозможно, поскольку поле не поддерживается или по иной причине, выбрасывается исключение.
Если поле является ChronoField, запрос обрабатывается здесь. Метод supported fields возвращает допустимые значения на основе этих года и месяца, за исключением PROLEPTIC_MONTH, которое слишком велико, чтобы поместиться в int, и приводит к выбросу DateTimeException. Для всех остальных экземпляров ChronoField выбрасывается UnsupportedTemporalTypeException.
Если поле не является ChronoField, результат этого метода получается вызовом TemporalField.getFrom(TemporalAccessor) с аргументом this. Возможность получения значения и его смысл определяются самим полем.
- Определено в:
-
getв интерфейсеTemporalAccessor - Параметры:
-
field— поле, значение которого требуется получить; не null - Возвращает:
- значение поля
- Исключения:
-
DateTimeException— если невозможно получить значение поля или значение выходит за пределы допустимого диапазона значений поля -
UnsupportedTemporalTypeException— если поле не поддерживается или диапазон значений выходит за пределыint -
ArithmeticException— при переполнении числового значения
getLong
public long getLong(TemporalField field)
long. Метод запрашивает значение указанного поля для этих года и месяца. Если вернуть значение невозможно, поскольку поле не поддерживается или по иной причине, выбрасывается исключение.
Если поле является ChronoField, запрос обрабатывается здесь. Метод supported fields возвращает допустимые значения на основе этих года и месяца. Для всех остальных экземпляров ChronoField выбрасывается UnsupportedTemporalTypeException.
Если поле не является ChronoField, результат этого метода получается вызовом TemporalField.getFrom(TemporalAccessor) с аргументом this. Возможность получения значения и его смысл определяются самим полем.
- Определено в:
-
getLongв интерфейсеTemporalAccessor - Параметры:
-
field— поле, значение которого требуется получить; не null - Возвращает:
- значение поля
- Исключения:
-
DateTimeException— если невозможно получить значение поля -
UnsupportedTemporalTypeException— если поле не поддерживается -
ArithmeticException— при переполнении числового значения
getYear
public int getYear()
Этот метод возвращает значение года примитивного типа int.
Метод возвращает год в пролептическом представлении согласно get(YEAR).
- Возвращает:
- год, от MIN_YEAR до MAX_YEAR
getMonthValue
public int getMonthValue()
Этот метод возвращает месяц как значение типа int в диапазоне от 1 до 12. В коде приложения обычно яснее использовать перечисление Month, вызвав getMonth().
- Возвращает:
- месяц года, от 1 до 12
- См. также:
getMonth
public Month getMonth()
Month. Этот метод возвращает для месяца значение перечисления Month. Это позволяет избежать неоднозначности в значениях int. Если требуется получить значение примитивного типа int, перечисление предоставляет метод int value.
- Возвращает:
- месяц года, не null
- См. также:
isLeapYear
public boolean isLeapYear()
Этот метод применяет действующие правила определения високосных лет ко всей временной шкале. В общем случае год является високосным, если он делится на четыре без остатка. Однако годы, делящиеся на 100, не являются високосными, за исключением годов, делящихся на 400.
Например, 1904 год является високосным, поскольку делится на 4. 1900 год не был високосным, поскольку делится на 100, однако 2000 год был високосным, поскольку делится на 400.
Расчет является пролептическим: те же правила применяются к далекому будущему и далекому прошлому. Это исторически неточно, но соответствует стандарту ISO-8601.
- Возвращает:
- true, если год високосный; в противном случае false
isValidDay
public boolean isValidDay(int dayOfMonth)
Этот метод проверяет, образуют ли эти год и месяц вместе с указанным днем допустимую дату.
- Параметры:
-
dayOfMonth— проверяемый день месяца от 1 до 31; для недопустимого значения возвращается false - Возвращает:
- true, если день допустим для этих года и месяца
lengthOfMonth
public int lengthOfMonth()
Возвращает количество дней в месяце. Например, для даты в январе возвращается 31.
- Возвращает:
- количество дней в месяце, от 28 до 31
lengthOfYear
public int lengthOfYear()
Возвращает количество дней в году: 365 или 366.
- Возвращает:
- 366, если год високосный; в противном случае 365
with
public YearMonth with(TemporalAdjuster adjuster)
Возвращает YearMonth на основе этого объекта с скорректированными годом и месяцем. Корректировка выполняется с помощью указанного объекта стратегии настройки. Ознакомьтесь с документацией по настройщику, чтобы узнать, какая корректировка будет выполнена.
Простой настройщик может просто задать значение одного из полей, например года. Более сложный настройщик может установить год и месяц, соответствующие следующему пролету кометы Галлея мимо Земли.
Результат этого метода получается вызовом метода TemporalAdjuster.adjustInto(Temporal) для указанного настройщика с аргументом this.
Этот экземпляр неизменяем; вызов данного метода не влияет на него.
- Определено в:
-
withв интерфейсеTemporal - Параметры:
-
adjuster— используемый настройщик, не null - Возвращает:
YearMonthна основеthisс примененной корректировкой, не null- Исключения:
-
DateTimeException— если корректировку невозможно выполнить -
ArithmeticException— при переполнении числового значения
with
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. В этом случае возможность и способ корректировки определяются самим полем.
Этот экземпляр неизменяем; вызов данного метода не влияет на него.
- Определено в:
-
withв интерфейсеTemporal - Параметры:
-
field— поле, которое следует задать в результате; не null -
newValue— новое значение поля в результате - Возвращает:
YearMonthна основеthisс заданным значением указанного поля, не null- Исключения:
-
DateTimeException— если поле невозможно задать -
UnsupportedTemporalTypeException— если поле не поддерживается -
ArithmeticException— при переполнении числового значения
withYear
public YearMonth withYear(int year)
YearMonth с измененным годом. Этот экземпляр неизменяем; вызов данного метода не влияет на него.
- Параметры:
-
year— год, который следует задать в возвращаемых годе и месяце, от MIN_YEAR до MAX_YEAR - Возвращает:
YearMonthна основе этих года и месяца с указанным годом, не null- Исключения:
-
DateTimeException— если значение года недопустимо
withMonth
public YearMonth withMonth(int month)
YearMonth с измененным месяцем года. Этот экземпляр неизменяем; вызов данного метода не влияет на него.
- Параметры:
-
month— месяц года, который следует задать в возвращаемых годе и месяце, от 1 (январь) до 12 (декабрь) - Возвращает:
YearMonthна основе этих года и месяца с указанным месяцем, не null- Исключения:
-
DateTimeException— если значение месяца года недопустимо
plus
public YearMonth plus(TemporalAmount amountToAdd)
Возвращает YearMonth на основе этого объекта с прибавленной указанной величиной. Обычно в качестве величины используется Period, но это может быть любой другой тип, реализующий интерфейс TemporalAmount.
Вычисление делегируется объекту величины посредством вызова TemporalAmount.addTo(Temporal). Реализация величины может выполнять сложение любым способом, однако обычно она вызывает plus(long, TemporalUnit). Чтобы определить, можно ли успешно прибавить величину, ознакомьтесь с документацией по ее реализации.
Этот экземпляр неизменяем; вызов данного метода не влияет на него.
- Определено в:
-
plusв интерфейсеTemporal - Параметры:
-
amountToAdd— прибавляемая величина, не null - Возвращает:
YearMonthна основе этих года и месяца с выполненным сложением, не null- Исключения:
-
DateTimeException— если сложение невозможно выполнить -
ArithmeticException— при переполнении числового значения
plus
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)с величиной, умноженной на 1 000. -
ERAS— возвращаетYearMonthс указанным количеством прибавленных эр. Поддерживаются только две эры, поэтому величина должна равняться единице, нулю или минус единице. Если величина не равна нулю, год изменяется так, чтобы год эры остался прежним.
Для всех остальных экземпляров ChronoUnit выбрасывается UnsupportedTemporalTypeException.
Если единица измерения не является ChronoUnit, результат этого метода получается вызовом TemporalUnit.addTo(Temporal, long) с аргументом this. В этом случае возможность и способ выполнения сложения определяются самой единицей измерения.
Этот экземпляр неизменяем; вызов данного метода не влияет на него.
- Определено в:
-
plusв интерфейсеTemporal - Параметры:
-
amountToAdd— величина в указанных единицах, прибавляемая к результату; может быть отрицательной -
unit— единица измерения прибавляемой величины, не null - Возвращает:
YearMonthна основе этих года и месяца с прибавленной указанной величиной, не null- Исключения:
-
DateTimeException— если сложение невозможно выполнить -
UnsupportedTemporalTypeException— если единица измерения не поддерживается -
ArithmeticException— при переполнении числового значения
plusYears
public YearMonth plusYears(long yearsToAdd)
YearMonth с прибавленным указанным количеством лет. Этот экземпляр неизменяем; вызов данного метода не влияет на него.
- Параметры:
-
yearsToAdd— количество прибавляемых лет; может быть отрицательным - Возвращает:
YearMonthна основе этих года и месяца с прибавленными годами, не null- Исключения:
-
DateTimeException— если результат выходит за пределы поддерживаемого диапазона
plusMonths
public YearMonth plusMonths(long monthsToAdd)
YearMonth с прибавленным указанным количеством месяцев. Этот экземпляр неизменяем; вызов данного метода не влияет на него.
- Параметры:
-
monthsToAdd— количество прибавляемых месяцев; может быть отрицательным - Возвращает:
YearMonthна основе этих года и месяца с прибавленными месяцами, не null- Исключения:
-
DateTimeException— если результат выходит за пределы поддерживаемого диапазона
minus
public YearMonth minus(TemporalAmount amountToSubtract)
Возвращает YearMonth на основе этого значения, из которого вычтена указанная величина. Обычно величина представляет собой Period, но может быть любым другим типом, реализующим интерфейс TemporalAmount.
Вычисление делегируется объекту величины вызовом метода TemporalAmount.subtractFrom(Temporal). Реализация величины может выполнять вычитание любым способом, однако обычно она вызывает minus(long, TemporalUnit). Чтобы определить, можно ли успешно вычесть эту величину, обратитесь к документации ее реализации.
Этот экземпляр неизменяем и не изменяется при вызове данного метода.
- Указано в:
-
minusв интерфейсеTemporal - Параметры:
-
amountToSubtract- величина для вычитания, не null - Возвращает:
- значение
YearMonthна основе этого года-месяца, из которого выполнено вычитание; не null - Вызывает исключения:
-
DateTimeException- если вычитание невозможно выполнить -
ArithmeticException- при числовом переполнении
minus
public YearMonth minus(long amountToSubtract, TemporalUnit unit)
Возвращает YearMonth на основе этого значения, из которого вычтена величина в указанных единицах. Если вычесть величину невозможно, поскольку единица не поддерживается или по какой-либо другой причине, выбрасывается исключение.
Этот метод эквивалентен методу plus(long, TemporalUnit) с величиной, взятой с противоположным знаком. Полное описание того, как выполняется сложение и, следовательно, вычитание, приведено в документации этого метода.
Этот экземпляр неизменяем и не изменяется при вызове данного метода.
- Указано в:
-
minusв интерфейсеTemporal - Параметры:
-
amountToSubtract- величина в единицах, которую нужно вычесть из результата; может быть отрицательной -
unit- единица измерения величины для вычитания, не null - Возвращает:
- значение
YearMonthна основе этого года-месяца, из которого вычтена указанная величина; не null - Вызывает исключения:
-
DateTimeException- если вычитание невозможно выполнить -
UnsupportedTemporalTypeException- если единица не поддерживается -
ArithmeticException- при числовом переполнении
minusYears
public YearMonth minusYears(long yearsToSubtract)
YearMonth, из которого вычтено указанное количество лет. Этот экземпляр неизменяем и не изменяется при вызове данного метода.
- Параметры:
-
yearsToSubtract- количество лет для вычитания; может быть отрицательным - Возвращает:
- значение
YearMonthна основе этого года-месяца, из которого вычтены годы; не null - Вызывает исключения:
-
DateTimeException- если результат выходит за пределы поддерживаемого диапазона
minusMonths
public YearMonth minusMonths(long monthsToSubtract)
YearMonth, из которого вычтено указанное количество месяцев. Этот экземпляр неизменяем и не изменяется при вызове данного метода.
- Параметры:
-
monthsToSubtract- количество месяцев для вычитания; может быть отрицательным - Возвращает:
- значение
YearMonthна основе этого года-месяца, из которого вычтены месяцы; не null - Вызывает исключения:
-
DateTimeException- если результат выходит за пределы поддерживаемого диапазона
query
public <R> R query(TemporalQuery<R> query)
Запрос к этому году-месяцу выполняется с помощью указанного объекта стратегии запроса. Объект TemporalQuery определяет логику получения результата. Ознакомьтесь с документацией запроса, чтобы понять, каким будет результат этого метода.
Результат этого метода получается вызовом метода TemporalQuery.queryFrom(TemporalAccessor) у указанного запроса с передачей this в качестве аргумента.
- Указано в:
-
queryв интерфейсеTemporalAccessor - Параметры типа:
R- тип результата- Параметры:
-
query- запрос для выполнения, не null - Возвращает:
- результат запроса; может быть возвращено значение null (определяется запросом)
- Вызывает исключения:
-
DateTimeException- если выполнить запрос невозможно (определяется запросом) -
ArithmeticException- при числовом переполнении (определяется запросом)
adjustInto
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);
Этот экземпляр неизменяем и не изменяется при вызове данного метода.
- Указано в:
-
adjustIntoв интерфейсеTemporalAdjuster - Параметры:
-
temporal- целевой объект для изменения, не null - Возвращает:
- измененный объект, не null
- Вызывает исключения:
-
DateTimeException- если выполнить изменение невозможно -
ArithmeticException- при числовом переполнении
until
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 в качестве первого аргумента, а преобразованного входного временного объекта — в качестве второго аргумента.
Этот экземпляр неизменяем и не изменяется при вызове данного метода.
- Указано в:
-
untilв интерфейсеTemporal - Параметры:
-
endExclusive- конечная дата, не включительно; преобразуется вYearMonth; не null -
unit- единица измерения времени, не null - Возвращает:
- время между этим годом-месяцем и конечным годом-месяцем
- Вызывает исключения:
-
DateTimeException- если величину невозможно вычислить или конечный временной объект нельзя преобразовать вYearMonth -
UnsupportedTemporalTypeException- если единица не поддерживается -
ArithmeticException- при числовом переполнении
format
public String format(DateTimeFormatter formatter)
Этот год-месяц передается форматировщику для получения строки.
- Параметры:
-
formatter- используемый форматировщик, не null - Возвращает:
- отформатированную строку с годом и месяцем, не null
- Вызывает исключения:
-
DateTimeException- если во время форматирования произошла ошибка
atDay
public LocalDate atDay(int dayOfMonth)
LocalDate. Возвращает LocalDate, образованную этим годом-месяцем и указанным днем месяца.
Значение дня месяца должно быть допустимым для этого года-месяца.
Этот метод можно использовать в цепочке вызовов для создания даты:
LocalDate date = year.atMonth(month).atDay(day);
- Параметры:
-
dayOfMonth- день месяца, от 1 до 31 - Возвращает:
- дата, образованная этим годом-месяцем и указанным днем; не null
- Вызывает исключения:
-
DateTimeException- если день недопустим для этого года-месяца - См. также:
atEndOfMonth
public LocalDate atEndOfMonth()
LocalDate, соответствующую последнему дню месяца. Возвращает LocalDate на основе этого года-месяца. День месяца устанавливается в последний допустимый день месяца с учетом високосных лет.
Этот метод можно использовать в цепочке вызовов для создания даты:
LocalDate date = year.atMonth(month).atEndOfMonth();
- Возвращает:
- последнюю допустимую дату этого года-месяца, не null
compareTo
public int compareTo(YearMonth other)
Сначала сравниваются значения года, затем значения месяца. Сравнение «согласовано с equals» в соответствии с определением Comparable.
- Указано в:
-
compareToв интерфейсеComparable<YearMonth> - Параметры:
-
other- другой год-месяц для сравнения, не null - Возвращает:
- значение сравнения: меньше нуля, если этот объект предшествует
other, ноль, если они равны, больше нуля, если этот объект следует заother - См. также:
isAfter
public boolean isAfter(YearMonth other)
- Параметры:
-
other- другой год-месяц для сравнения, не null - Возвращает:
- true, если этот объект следует за указанным годом-месяцем
isBefore
public boolean isBefore(YearMonth other)
- Параметры:
-
other- другой год-месяц для сравнения, не null - Возвращает:
- true, если этот объект предшествует указанному году-месяцу
equals
public boolean equals(Object obj)
Сравнение основано на положении годов-месяцев на временной шкале.
hashCode
toString
© 1993, 2025, 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.