Определение ограничений API

Инструменты API предоставляют теги Javadoc для явного документирования и ограничения применения API. В следующей таблице приведены теги Javadoc, поддерживаемые каждым элементом, и семантика каждого тега.

Клиент относится к модулю или комплекту, который требует пакте, в котором определяется соответствующий API. В пакете, в котором определяется API, ограничения не применяются. Например, пакет, который определяет некоторый интерфейс как @noimplement, может предоставить некоторую реализацию этого интерфейса.

Поддерживаемые теги ограничений

  Класс Интерфейс Метод Конструктор

Конечное поле

Неконечное поле
@noimplement
-
Supported
-
-
-
-
@noextend
Supported
Supported
-
-
-
-
@noinstantiate
Supported
-
-
-
-
-
@nooverride
-
-
Supported
-
-
-
@noreference
-
-
Supported
Supported
-
Supported

Семантика ограничений

@noimplement

Указывает, что клиенты не должны реализовывать этот интерфейс. Любой класс, использующий ключевое слово implements для связанного интерфейса или родительского интерфейса для связанного, в котором не реализован суперкласс, будет помечен как неполадка.

@noextend
Указывает, что клиенты не должны расширять этот класс или интерфейс. Любой класс или интерфейс, использующий ключевое слово extends для связанного типа, будет помечен как неполадка.
@noinstantiate
Указывает, что клиенты не должны создавать экземпляр этого класса. Любой код, который создает экземпляр соответствующего класса с любым конструктором, будет помечен как неполадка.
@nooverride
Указывает, что клиенты не должны повторно декларировать этот метод. Любой подкласс, который определяет метод, переопределяющий связанный метод, будет помечен как неполадка.
@noreference
Указывает, что клиенты не должны обращаться к этому методу, конструктору или неконечному полю. Любой код, который непосредственно вызывает соответствующий метод или конструктор или ссылается на соответствующее неконечное поле, будет помечен как неполадка.

Связанные задачи

Настройка контрольной версии

Связанные справочники

Управление тегом Javadoc @since
Параметры контрольной версии API
Параметры ошибок и предупреждений API