Интерфейс TemporalField

default String getDisplayName(Locale locale)

Возвращает отображаемое название поля для указанной локали.

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

Реализация по умолчанию должна проверить, что локаль не равна null, и вернуть toString().

TemporalUnit getBaseUnit()

Возвращает единицу измерения поля.

Единица измерения поля — это период, в пределах которого оно изменяется. Например, для поля 'MonthOfYear' единицей измерения являются 'Months'. См. также getRangeUnit().

TemporalUnit getRangeUnit()

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

Диапазон поля — это период, в пределах которого поле изменяется. Например, для поля 'MonthOfYear' диапазоном являются 'Years'. См. также getBaseUnit().

Диапазон никогда не равен null. Например, поле 'Year' является сокращением для 'YearOfForever'. Поэтому его единица измерения — 'Years', а диапазон — 'Forever'.

ValueRange range()

Возвращает диапазон допустимых значений поля.

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

Обратите внимание, что результат описывает только минимальные и максимальные допустимые значения, и не следует делать из него слишком далеко идущих выводов. Например, в диапазоне могут быть значения, недопустимые для этого поля.

boolean isDateBased()

Проверяет, представляет ли это поле составляющую даты.

Поле основано на дате, если его можно получить из EPOCH_DAY. Обратите внимание, что допустимо, если и isDateBased(), и isTimeBased() возвращают false, например, когда поле представляет минуту недели.

boolean isTimeBased()

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

Поле основано на времени, если его можно получить из NANO_OF_DAY. Обратите внимание, что допустимо, если и isDateBased(), и isTimeBased() возвращают false, например, когда поле представляет минуту недели.

boolean isSupportedBy(TemporalAccessor temporal)

Проверяет, поддерживается ли это поле временным объектом.

Этот метод определяет, поддерживает ли временной аксессор это поле. Если метод возвращает false, запросить это поле у временного объекта нельзя.

Этот метод можно использовать двумя эквивалентными способами. Первый — вызвать его напрямую. Второй — использовать TemporalAccessor.isSupported(TemporalField):

  // these two lines are equivalent, but the second approach is recommended
  temporal = thisField.isSupportedBy(temporal);
  temporal = temporal.isSupported(thisField);

Рекомендуется использовать второй подход, isSupported(TemporalField), поскольку такой код гораздо понятнее.

Реализации должны определять поддержку, используя поля, доступные в ChronoField.

ValueRange rangeRefinedBy(TemporalAccessor temporal)

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

Этот метод использует временной объект, чтобы определить диапазон допустимых значений поля. Он похож на range(), однако уточняет результат с учетом временного объекта. Например, если поле — DAY_OF_MONTH, метод range не дает точного результата, поскольку длина месяца может составлять 28, 29, 30 или 31 день. Использование этого метода с датой позволяет получить точный диапазон, выбрав один из этих четырех вариантов.

Этот метод можно использовать двумя эквивалентными способами. Первый — вызвать его напрямую. Второй — использовать TemporalAccessor.range(TemporalField):

  // these two lines are equivalent, but the second approach is recommended
  temporal = thisField.rangeRefinedBy(temporal);
  temporal = temporal.range(thisField);

Рекомендуется использовать второй подход, range(TemporalField), поскольку такой код гораздо понятнее.

Реализации должны выполнять запросы и вычисления, используя поля, доступные в ChronoField. Если поле не поддерживается, необходимо выбросить UnsupportedTemporalTypeException.

long getFrom(TemporalAccessor temporal)

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

Этот метод запрашивает у временного объекта значение данного поля.

Этот метод можно использовать двумя эквивалентными способами. Первый — вызвать его напрямую. Второй — использовать TemporalAccessor.getLong(TemporalField) (или TemporalAccessor.get(TemporalField)):

  // these two lines are equivalent, but the second approach is recommended
  temporal = thisField.getFrom(temporal);
  temporal = temporal.getLong(thisField);

Рекомендуется использовать второй подход, getLong(TemporalField), поскольку такой код гораздо понятнее.

Реализации должны выполнять запросы и вычисления, используя поля, доступные в ChronoField. Если поле не поддерживается, необходимо выбросить UnsupportedTemporalTypeException.

<R extends Temporal> R adjustInto(R temporal, long newValue)

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

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

В некоторых случаях изменение поля не имеет однозначного результата. Например, если целевой объект — дата, соответствующая 31 января, то изменение месяца на февраль не дает однозначного результата. В таких случаях реализация отвечает за определение результата. Обычно выбирается предыдущая допустимая дата, то есть в данном примере последний допустимый день февраля.

Этот метод можно использовать двумя эквивалентными способами. Первый — вызвать его напрямую. Второй — использовать Temporal.with(TemporalField, long):

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

Рекомендуется использовать второй подход, with(TemporalField), поскольку такой код гораздо понятнее.

Реализации должны выполнять запросы и вычисления, используя поля, доступные в ChronoField. Если поле не поддерживается, необходимо выбросить UnsupportedTemporalTypeException.

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

default TemporalAccessor resolve(Map<TemporalField, Long> fieldValues, TemporalAccessor partialTemporal, ResolverStyle resolverStyle)

Разрешает это поле, предоставляя более простой эквивалент или дату.

Этот метод вызывается на этапе разрешения при разборе. Он предназначен для преобразования определенных приложением полей в более стандартные поля, например поля ChronoField, или в дату.

Обычно приложениям не следует вызывать этот метод напрямую.

String toString()

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

Название должно иметь формат 'BaseOfRange', например 'MonthOfYear', если только диапазоном поля не является FOREVER; в этом случае указывается только базовая единица, например 'Year' или 'Era'.