Definindo Restrições de API

As Ferramentas da API fornecem tags Javadoc para documentar e restringir explicitamente o uso da API. As tabelas a seguir resumem as tags Javadoc suportadas por cada membro e a semântica de cada tag.

Um cliente refere-se a um plug-in ou pacote configurável que requer o pacote configurável onde a API associada está definida. Restrições não se aplicam ao mesmo pacote configurável onde a API está definida. Por exemplo, um pacote configurável que define uma interface como @noimplement também tem permissão para fornecer uma implementação dessa interface.

Tags de Restrição Suportadas

  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 clientes não devem implementar essa interface. Qualquer classe que usa a palavra-chave implements para a interface associada ou pai da interface associada em que não há superclasse de implementação será sinalizada com problema.

@noextend
Indica que os clientes não devem estender esta classe ou interface. Qualquer classe ou interface que usa a palavra-chave extends para o tipo associado será sinalizada com um problema.
@noinstantiate
Indica que clientes não devem instanciar essa 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 declarar novamente este método. Qualquer subclasse que defina um método que substitua o método associado será sinalizado com um problema.
@noreference
Indica que clientes não devem fazer referência a esse método, construtor ou campo não final. Qualquer código que chame diretamente o método ou o construtor associado ou que faça referência ao campo não final associado será sinalizado com um problema.

Tarefas relacionadas

Configurando uma Linha de Base

Referência relacionada

Gerenciamento de Tags Javadoc @since
Preferências de Linhas de Base API
Preferências de Avisos e Erros de API