Definir restrições de API

As Ferramentas das API fornecem identificadores Javadoc para documentarem e restringirem de forma explícita a utilização da API. As tabelas seguintes resumem os identificadores Javadoc suportados por cada membro e a semântica de cada identificador.

cliente refere-se a um plug-in ou um agrupamento que necessite do agrupamento onde está definida a API associada. As restrições não são aplicadas no mesmo agrupamento em que se define a API. Por exemplo, um agrupamento que defina uma interface como @noimplement também pode facultar uma implementação dessa interface.

Identificadores de Restrição Suportados

  Classe Interface Método Construtor

Campo Final

Campo Não Final
@noimplement
-
Suportado
-
-
-
-
@noextend
Suportado
Suportado
-
-
-
-
@noinstantiate
Suportado
-
-
-
-
-
@nooverride
-
-
Suportado
-
-
-
@noreference
-
-
Suportado
Suportado
-
Suportado

Semântica de Restrição

@noimplement

Indica que os clientes não devem implementar esta interface. Qualquer classe que utilize a palavra-chave implements para a interface ou ascendente associados em que não existir nenhuma superclasse de implementação será sinalizada com um problema.

@noextend
Indica que os clientes não devem estender esta classe ou interface. Qualquer classe que utilize a palavra-chave extends para o tipo associado será sinalizada com um problema.
@noinstantiate
Indica que os clientes não devem instanciar esta classe. Qualquer código que instancie a classe associada com qualquer construtor será sinalizado com um problema.
@nooverride
Indica que os clientes não devem redeclarar este método. Qualquer subclasse que defina um método que se sobreponha ao método associado será sinalizada com um problema.
@noreference
Indica que os clientes não devem referenciar este método, construtor ou campo não final. Qualquer código que invoque directamente o método ou construtor associado ou que referencie o campo não final associado será sinalizado com um problema.

Tarefas relacionadas

Configurar uma linha de base

Referência relacionada

Gestão de identificadores Javadoc @since
Preferências de Linhas de Base de API
Preferências de Erros e Avisos de API