Spec-Zone.ru › OpenJDK 8

Интерфейс Эра

Все суперинтерфейсы:
TemporalAccessor, TemporalAdjuster
Все известные реализующие классы:
HijrahEra, IsoEra, ЯпонскаяЭра, MinguoEra, ТайскаяБуддистскаяЭра

public interface Era
extends TemporalAccessor, TemporalAdjuster

Эра на временной шкале.

Большинство календарных систем имеют одну эпоху, разделяющую временную шкалу на две эры. Однако некоторые календарные системы имеют несколько эр, например, по правлению каждого лидера. В любом случае, эра концептуально является крупнейшим разделением временной шкалы. Каждая хронология определяет эры, которые являются известными эрами, и Chronology.eras, чтобы получить допустимые эры.

Например, тайская буддийская календарная система делит время на две эры, до и после одной даты. В отличие от этого, японская календарная система имеет одну эру для правления каждого императора.

Экземпляры Era могут сравниваться с использованием оператора ==.

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

Методы

Модификатор и тип Метод и описание
default Temporal adjustInto(Temporal temporal)

Настраивает указанный временной объект так, чтобы он имел ту же эру, что и этот объект.

default int get(TemporalField field)

Получает значение указанного поля из этой эры в виде int.

default String getDisplayName(TextStyle style, Locale locale)

Получает текстовое представление этой эры.

default long getLong(TemporalField field)

Получает значение указанного поля из этой эры как long.

int getValue()

Получает числовое значение, связанное с эрой, как определено хронологией.

default boolean isSupported(TemporalField field)

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

default <R> R query(TemporalQuery<R> query)

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

default ValueRange range(TemporalField field)

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

Методы

getValue

int getValue()

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

Все поля, включая эры, имеют связанное числовое значение. Значение числового значения для эры определяется хронологией в соответствии с этими принципами:

  • Эра, используемая в эпоху 1970-01-01 (ISO), имеет значение 1.
  • Поздние эры имеют последовательно более высокие значения.
  • Более ранние эры имеют последовательно более низкие значения, которые могут быть отрицательными.
Возвращает:
числовое значение эры

isSupported

default boolean isSupported(TemporalField field)

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

Это проверяет, может ли эта эра быть запрошена для указанного поля. Если false, то вызов методов range и get вызовет исключение.

Если поле является ChronoField, то запрос реализуется здесь. Поле ERA возвращает true. Все остальные экземпляры ChronoField вернут false.

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

Определено в:
isSupported в интерфейсе TemporalAccessor
Параметры:
field - поле для проверки, null возвращает false
Возвращает:
true, если поле поддерживается в этой эре, false в противном случае

range

default ValueRange range(TemporalField field)

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

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

Если поле является ChronoField, то запрос реализуется здесь. Поле ERA возвращает диапазон. Все остальные экземпляры ChronoField вызовут UnsupportedTemporalTypeException.

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

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

Определено в:
range в интерфейсе TemporalAccessor
Параметры:
field - поле, для которого требуется получить диапазон, не null
Возвращает:
диапазон допустимых значений для поля, не null
Исключения:
DateTimeException - если диапазон для поля получить нельзя
UnsupportedTemporalTypeException - если единица не поддерживается

get

default int get(TemporalField field)

Получает значение указанного поля из этой эры как int.

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

Если поле является ChronoField, то запрос реализуется здесь. Поле ERA возвращает значение эры. Все остальные экземпляры ChronoField вызовут UnsupportedTemporalTypeException.

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

Определено в:
get в интерфейсе TemporalAccessor
Параметры:
field - поле для получения, не null
Возвращает:
значение для поля
Исключения:
DateTimeException - если значение для поля получить нельзя или значение находится вне диапазона допустимых значений для поля
UnsupportedTemporalTypeException - если поле не поддерживается или диапазон значений превышает int
ArithmeticException - если произошел переполнение числового типа

getLong

default long getLong(TemporalField field)

Получает значение указанного поля из этой эры как long.

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

Если поле является ChronoField, то запрос реализуется здесь. Поле ERA возвращает значение эры. Все остальные экземпляры ChronoField вызовут UnsupportedTemporalTypeException.

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

Определено в:
getLong в интерфейсе TemporalAccessor
Параметры:
field - поле для получения, не null
Возвращает:
значение для поля
Исключения:
DateTimeException - если значение для поля получить нельзя
UnsupportedTemporalTypeException - если поле не поддерживается
ArithmeticException - если произошел переполнение числового типа

query

default <R> R query(TemporalQuery<R> query)

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

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

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

Определено в:
query в интерфейсе TemporalAccessor
Параметры типа:
R - тип результата
Параметры:
query - вызываемый запрос, не null
Возвращает:
результат запроса, может быть null (определено запросом)
Исключения:
DateTimeException - если запрос выполнить невозможно (определено запросом)
ArithmeticException - если произошло переполнение числового типа (определено запросом)

adjustInto

default Temporal adjustInto(Temporal temporal)

Настраивает указанный объект временного типа, чтобы он имел ту же эру, что и этот объект.

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

Настройка эквивалентна использованию Temporal.with(TemporalField, long) , передавая ChronoField.ERA в качестве поля.

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

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

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

Определено в:
adjustInto в интерфейсе TemporalAdjuster
Параметры:
temporal - целевой объект для настройки, не null
Возвращает:
настроенный объект, не null
Исключения:
DateTimeException - если настройку сделать невозможно
ArithmeticException - если произошло переполнение числового типа

getDisplayName

default String getDisplayName(TextStyle style,
                              Locale locale)

Получает текстовое представление этой эры.

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

Если текстовое отображение не найдено, то возвращается numeric value.

Примечание API:
Эта реализация по умолчанию подходит для большинства реализаций.
Параметры:
style - требуемый стиль текста, не null
locale - используемая локаль, не null
Возвращает:
текстовое значение эры, не null

© 1993, 2020, 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.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API