Preferências de Avisos e Erros de API

As seguintes preferências podem ser configuradas utilizando a página de preferências Abre a página de preferências Console Desenvolvimento de Plug-in > Erros/Avisos de API.

Os problemas de API são criados durante construções de projeto (construções automáticas e completas), a ferramenta divide os tipos de problemas relatados em uma das três categorias:

  1. Problemas de Uso - código restrito está sendo chamado por plug-ins desautorizados
  2. Incompatibilidades de API - alterações entre versões não são compatíveis
  3. Problemas de Versão - versões de plug-in ou versões de código (tags @since) não corretas
  4. Opções de Análise - opções gerais

Você também pode configurar as gravidades do problema com base no projeto, utilizando a página de propriedades Erros/Avisos da API para um projeto

Utilização da API

Página de Preferências da Opção de Uso da API

Geral

Opção

Descrição

Padrão

Uso não suportado de Tags Javadoc da API

Quando ativado, o construtor de análise de API procurará pelas tags Javadoc de API utilizadas incorretamente.

Ignorar

Referência não definida no ambiente de execução especificado

Quando ativada, o construtor de análise de API verificará as referências às bibliotecas do sistema que podem estar ilegais de acordo com o ambiente de execução especificado para o pacote configurável.

Ignorar

Restrições

Opção

Descrição

Padrão

Implementando uma Interface Marcada como '@noimplement'

Quando ativado, o construtor de análise de API procurará pela implementação ilegal de interfaces marcadas.

Aviso

Estendendo um tipo marcado '@noextend'

Quando ativado, o construtor de análise de API procurará pelas classes que estendem os tipos marcados.

Aviso

Fazendo referência a um campo ou método marcado como '@noreference'

Quando ativado, o construtor de análise de API procurará pelo campo e referências de método para membros marcados.

Aviso

Instanciando uma Classe Marcada '@noinstantiate'

Quando ativado, o construtor de análise de API verificará se as classes marcadas não estão instanciadas.

Aviso

Substituindo um método marcado como '@nooverride'

Quando ativado, o construtor de análise de API verificará se os métodos marcados em classes pais não são substituídos em qualquer classe filha, estendendo (reimplementação com uma chamada para o pai substituído) ou reimplementando (sem chamada para o pai substituído).

Aviso

Fugas

Opção

Descrição

Padrão

Estende uma Classe Não API

Quando ativado, o construtor de análise de API verificará se alguma classe de API estende tipos não API.

Aviso

Implementa uma Interface Não API

Quando ativado, o construtor de análise de API verificará se alguma classe de API implementa uma interface não API

Aviso

Campo com tipo não API

Quando ativado, o construtor de análise de API verificará se algum tipo de API possui campos públicos ou protegidos com tipos não API.

Aviso

Método com um tipo de retorno não API

Quando ativado, o construtor de análise de API verificará se algum tipo de API possui métodos públicos ou protegidos com tipos de retorno não API.

Aviso

Método com tipo de parâmetro não API

Quando ativado, o construtor de análise de API verificará se algum tipo de API possui métodos públicos ou protegidos com tipos de parâmetros não API.

Aviso

Compatibilidade de API

Página de Preferências de Opção de Compatibilidade de API

Opção

Descrição

Padrão

Relatar interrupção da API mesmo que autorizado por incremento da versão principal

Quando ativado, o construtor de análise de API relatará problemas para rupturas de API mesmo se a versão principal do pacote configurável já tiver sido incrementada.

Desativado

Pacote Configurável

Opção

Descrição

Padrão

Um tipo de API se tornou não API

Quando ativado, o construtor de análise de API verificará se qualquer tipo de API no pacote configurável atual foi alterado para tipos não API.

Erro

Um tipo foi removido

Quando ativado, o construtor de análise da API verificará se algum tipo de API foi removido do escopo de API no pacote configurável fornecido.

Erro

Um tipo de API reexportado se tornou não API

Quando ativado, o construtor de análise de API verificará se qualquer tipo de API reexportado no pacote configurável atual foi alterado para tipos não API.

Erro

Um tipo reexportado foi removido

Quando ativado, o construtor de análise de API verificará se quaisquer tipos de API reexportados foram removidos do escopo da API no pacote configurável fornecido.

Erro

Classe

Opção

Descrição

Padrão

Foi incluído um método (que precisa ser implementado):

Quando ativado, o construtor de análise de API verificará se qualquer método público ou protegido que precisa ser implementado foi incluído em qualquer tipo de API.

Erro

Restrições foram incluídas

Quando ativado, o construtor de análise de API verificará se as restrições de API foram incluídas para quaisquer classes de API.

Erro

Um parâmetro de tipo foi incluído

Quando ativado, o construtor de análise de API verificará se qualquer parâmetro de tipo foi incluído em qualquer classe de API.

Erro

A hierarquia de superinterfaces foi reduzida

Quando ativado, o construtor de análise de API verificará se alguma interface pai foi removida de qualquer classe de API.

Erro

A palavra-chave 'abstract' foi incluída

Quando ativado, o construtor de análise de API verificará se uma palavra-chave 'abstract' foi incluída em alguma classe de API.

Erro

A palavra-chave 'final' foi incluída

Quando ativado, o construtor de análise de API verificará se uma palavra-chave 'final' foi incluída em alguma classe de API.

Erro

Convertido em anotação, enumeração ou interface

Quando ativado, o construtor de análise de API verificará se qualquer classe de API foi alterada para anotações, enumerações ou interfaces.

Erro

A visibilidade foi reduzida

Quando ativado, o construtor de análise de API verificará se alguma classe de API pública se tornou escopo privado ou padrão.

Erro

Um campo foi removido

Quando ativado, o construtor de análise de API verificará se algum campo público ou protegido foi removido de qualquer classe de API.

Erro

Um método foi removido

Quando ativado, o construtor de análise de API verificará se algum método público ou protegido foi removido de qualquer classe de API.

Erro

Um construtor foi removido

Quando ativado, o construtor de análise de API verificará se algum construtor público ou protegido foi removido de qualquer classe de API.

Erro

A hierarquia de superclasse foi reduzida

Quando ativado, o construtor de análise de API verificará se quaisquer superclasses foram removidas da hierarquia.

Erro

Um tipo de membro foi removido

Quando ativado, o construtor de análise de API verificará se algum tipo de membro foi removido de quaisquer classes de API.

Erro

Um parâmetro de tipo foi removido

Quando ativado, o construtor de análise de API verificará se algum parâmetro de tipo foi removido de qualquer classe de API.

Erro

Interface

Opção

Descrição

Padrão

Um campo (interface não marcada como '@noimplement') foi incluído

Quando ativado, o construtor de análise de API verificará se algum campo público foi incluído em alguma interface API.

Erro

Um método (interface não marcada como '@noimplement') foi incluído

Quando ativado, o construtor de análise de API verificará se algum método público foi incluído em alguma interface API.

Erro

Restrições foram incluídas

Quando ativado, o construtor de análise de API verificará se as restrições de API foram incluídas para quaisquer interfaces de API.

Erro

Um parâmetro de tipo foi incluído

Quando ativado, o construtor de análise de API verificará se algum parâmetro de tipo foi incluído em alguma interface API.

Erro

Convertido em classe, enumeração ou anotação

Quando ativado, o construtor de análise de API verificará se quaisquer interfaces de API foram alteradas para classes, enumerações ou interfaces.

Erro

A hierarquia de superinterfaces foi reduzida

Quando ativado, o construtor de análise de API verificará se alguma interface pai foi removida para qualquer interface API.

Erro

Um parâmetro de tipo foi removido

Quando ativado, o construtor de análise de API verificará se algum parâmetro de tipo foi removido de qualquer interface API.

Erro

Um campo foi removido

Quando ativado, o construtor de análise de API verificará se algum campo público foi removido de qualquer interface API.

Erro

Um método foi removido

Quando ativado, o construtor de análise de API verificará se algum método público foi removido de qualquer interface API.

Erro

Um tipo de membro foi removido

Quando ativado, o construtor de análise de API verificará se algum tipo de membro foi removido de qualquer interface API.

Erro

Enum

Opção

Descrição

Padrão

A hierarquia de superinterfaces foi reduzida

Quando ativado, o construtor de análise de API verificará se alguma interface pai foi removida de qualquer enum de API.

Erro

Convertido em anotação, classe ou interface

Quando ativado, o construtor de análise de API verificará se quaisquer enumerações de API foram alteradas para anotações, classes ou interfaces.

Erro

Um campo foi removido

Quando ativado, o construtor de análise de API verificará se algum campo público foi removido de quaisquer enums de API.

Erro

Uma constante de enum foi removida

Quando ativado, o construtor de análise de API verificará se alguma constante de num foi removida de quaisquer enums de API.

Erro

Um método foi removido

Quando ativado, o construtor de análise de API verificará se algum método público foi removido de quaisquer enums de API.

Erro

Um tipo de membro foi removido

Quando ativado, o construtor de análise de API verificará se algum tipo de membro foi removido de quaisquer enums de API.

Erro

Anotação

Opção

Descrição

Padrão

Um método sem um valor padrão foi incluído

Quando ativado, o construtor de análise de API verificará se um método sem um valor padrão foi incluído nas anotações de API.

Erro

Convertido em classe, enumeração ou interface

Quando ativado, o construtor de análise de API verificará se quaisquer anotações de API foram convertidas em classes, enumerações ou interfaces.

Erro

Um campo foi removido

Quando ativado, o construtor de análise de API verificará se algum campo público foi removido de qualquer anotação de API.

Erro

Um método foi removido

Quando ativado, o construtor de análise de API verificará se quaisquer métodos públicos foram removidos de quaisquer anotações de API.

Erro

Um tipo de membro foi removido

Quando ativado, o construtor de análise de API verificará se quaisquer tipos de membros públicos foram removidos de quaisquer anotações de API.

Erro

Campo

Opção

Descrição

Padrão

Um valor constante foi incluído

Quando ativado, o construtor de análise de API verificará se um valor constante foi incluído em qualquer constante de campo pública ou protegida não inicializada anteriormente para quaisquer tipos de API.

Erro

O tipo foi modificado

Quando ativado, o construtor de análise de API verificará se o tipo de algum campo público ou protegido foi alterado para algum tipo de API.

Erro

O valor constante foi modificado

Quando ativado, o construtor de análise de API verificará se o valor de alguma constante de campo público ou protegido foi alterada em algum tipo de API.

Erro

A visibilidade foi reduzida

Quando ativado, o construtor de análise de API verificará se algum campo público ou protegido se tornou privado em algum tipo de API.

Erro

A palavra-chave 'final' foi removida para constante estática

Quando ativado, o construtor de análise de API verificará se algum campo público ou protegido teve a palavra-chave final removida em algum tipo de API.

Erro

A palavra-chave 'final' foi incluída

Quando ativado, o construtor de análise de API verificará se a palavra-chave final foi incluída em algum campo público ou protegido em algum tipo de API.

Erro

A palavra-chave 'static' foi removida

Quando ativado, o construtor de análise de API verificará se a palavra-chave estática foi removida de algum campo público ou protegido em algum tipo de API.

Erro

A palavra-chave 'static' foi incluída

Quando ativado, o construtor de análise de API verificará se a palavra-chave estática foi incluída em algum campo público ou protegido em algum tipo de API.

Erro

O valor constante foi removido

Quando ativado, o construtor de análise de API verificará se o valor de um campo constante foi removido para alguma constante de campo público ou protegido em algum tipo de API.

Erro

Um argumento de tipo foi removido

Quando ativado, o construtor de análise de API verificará se um argumento de tipo foi removido de quaisquer campos públicos ou protegidos em quaisquer tipos de API.

Erro

Método

Opção

Descrição

Padrão

A restrição @nooverride foi incluída

Quando ativado, o construtor de análise de API verificará se as restrições de quaisquer métodos públicos ou protegidos foram alteradas em quaisquer tipos de API incluindo a tag @nooverride.

Erro

Um parâmetro de tipo foi incluído

Quando ativado, o construtor de análise de API verificará se um parâmetro de tipo foi incluído em algum método público ou protegido para algum tipo de API.

Erro

Argumento de variável convertido em tipo de matriz

Quando ativado, o construtor de análise de API verificará se um argumento varargs foi expandido para uma matriz de objeto para algum método público ou protegido para algum tipo de API.

Erro

A visibilidade foi reduzida

Quando ativado, o construtor de análise de API verificará se algum método público ou protegido se tornou privado para algum tipo de API.

Erro

A palavra-chave 'abstract' foi incluída

Quando ativado, o construtor de análise de API verificará se algum método público ou protegido se tornou abstrato para algum tipo de API.

Erro

A palavra-chave 'static' foi incluída

Quando ativado, o construtor de análise de API verificará se algum método público ou protegido se tornou estático para algum tipo de API.

Erro

A palavra-chave 'static' foi removida

Quando ativado, o construtor de análise de API verificará se algum método público ou protegido se tornou não estático para algum tipo de API.

Erro

A palavra-chave 'final' foi incluída (tipo marcado como '@noextend')

Quando ativado, o construtor de análise de API verificará se algum método público ou protegido se tornou final em algum tipo de API que tenha sido marcado como @noextend.

Erro

O valor padrão da anotação foi removido

Quando ativado, o construtor de análise de API verificará se o valor-padrão associado a qualquer método de anotação de API foi removido.

Erro

Um parâmetro de tipo foi removido

Quando ativado, o construtor de análise de API verificará se um parâmetro de tipo foi removido de algum método público ou protegido para algum tipo de API.

Erro

Construtor

Opção

Descrição

Padrão

Um parâmetro de tipo foi incluído

Quando ativado, o construtor de análise de API verificará se um parâmetro de tipo foi incluído em algum construtor público para algum tipo de API.

Erro

Argumento de variável convertido em tipo de matriz

Quando ativado, o construtor de análise de API verificará se algum parâmetro varargs foi expandido para as matrizes de objeto para algum construtor público para algum tipo de API.

Erro

A visibilidade foi reduzida

Quando ativado, o construtor de análise de API verificará se algum construtor público se tornou não público em algum tipo de API.

Erro

Um parâmetro de tipo foi removido

Quando ativado, o construtor de análise de API verificará se um parâmetro de tipo foi removido de algum construtor público para algum tipo de API.

Erro

Parâmetro de Tipo

Opção

Descrição

Padrão

Um limite da classe foi incluído

Quando ativado, o construtor de análise de API verificará se um limite de classe foi incluído em qualquer parâmetro de tipo de quaisquer tipos de API.

Erro

Um limite da interface foi incluído

Quando ativado, o construtor de análise de API verificará se quaisquer limites de interface foram incluídos em qualquer parâmetro de tipo de quaisquer tipos de API.

Erro

Um limite da classe foi modificado

Quando ativado, o construtor de análise de API verificará se quaisquer limites de classe foram alterados em qualquer parâmetro de tipo de quaisquer tipos de API.

Erro

Um limite de interface foi modificado

Quando ativado, o construtor de análise de API verificará se quaisquer limites de interface foram alterados em qualquer parâmetro de tipo de quaisquer tipos de API.

Erro

Um limite da classe foi removido

Quando ativado, o construtor de análise de API verificará se quaisquer limites de classe foram removidos de qualquer parâmetro de tipo de quaisquer tipos de API.

Erro

Um limite de interface foi removido

Quando ativado, o construtor de análise de API verificará se quaisquer limites de interface foram removidos de qualquer parâmetro de tipo de quaisquer tipos de API.

Erro

Gerenciamento de Versão

Página de Preferências da Opção de Gerenciamento de Versão de API

Opção

Descrição

Padrão

Relatar tags '@since' ausentes

Quando ativado, o construtor de análise da API verificará se as tags @since estão ausentes nos tipos ou membros incluídos desde a versão da linha de base de API em uso.

Erro

Relatar tags '@since' mal formadas

Quando ativado, o construtor de análise de API verificará se alguma tag @since atualmente em uso está mal formada (sintaxe incorreta).

Erro

Relatar versão de tag '@since' inválida

Quando ativado, o construtor de análise de API verificará se alguma tag @since atualmente em uso possui versão incorreta.

Erro

Relatar versão de pacote configurável incompatível

Quando ativado, o construtor de análise de API verificará se a versão do pacote configurável para o plug-in está incorreta, com base em algumas alterações de API e na linha de base de API atual em uso.

Erro

Ignorar incremento da versão menor sem alterações na API

Se o relatório para números de versão incompatíveis estiver ativado, esta opção pode ser utilizada para informar ao construtor de análise de API para ignorar as alterações de versão secundárias, se não houver uma alteração de API comparada com a linha de base de API atual.

Ativado

Ignore o incremento de versão principal sem alterações na API

Se o relatório para números de versão incompatíveis estiver ativado, esta opção pode ser utilizada para informar ao construtor de análise de API para ignorar as alterações de versão principais, se não houver uma alteração de API comparada com a linha de base de API atual.

Ativado

Opções de Análise

Página de preferências de opções de análise

Opção

Descrição

Padrão

O pacote configurável não possui a restrição/pré-requisito necessário

Quando ativado, o construtor de análise de API relatará qualquer restrição ou pré-requisito ausente necessário que impeça que o construtor execute uma análise completa. Independentemente do valor desta opção, a análise é ignorada para o pacote configurável correspondente.

Erro

Filtros de Problemas da API não Utilizados

Quando ativado, o construtor de análise de API reportará qualquer filtro com problema da API que não esteja mais sendo utilizado.

Aviso

Opções de Varreduras de Uso da API

Página de preferências de opções de varreduras de uso da API

Opção

Descrição

Padrão

Problema de tipo não resolvido

Quando ativado, o construtor de análise da API relatará todos os tipos de API que foram removidos que estão incluídos em qualquer varredura de uso listada na página de preferências Varreduras de Uso da API.

Erro

Problema de método não resolvido

Quando ativado, o construtor de análise da API relatará todos os métodos que foram removidos que estão incluídos em qualquer varredura de uso listada na página de preferências Varreduras de Uso da API.

Erro

Problema de campo não resolvido

Quando ativado, o construtor de análise da API relatará todos os campos que foram removidos que estão incluídos em qualquer varredura de uso listada na página de preferências Varreduras de Uso da API.

Erro


Referência relacionada

Preferências do PDE
Página de Propriedades de Erros e Avisos de API
Preferências de Linhas de Base de API
Preferências de Varreduras de Uso da API