Preferanser for API-feil og -advarsler

Preferansene nedenfor kan defineres ved hjelp av preferansesiden Åpner preferansesiden Konsoll Plugin-utvikling > API-feil/-advarsler.

API-problemer oppstår under prosjektbygginger (automatiske og fullstendige bygginger), verktøyet deler inn i typer problemer, som rapporteres i en av tre kategorier:

  1. Bruksproblemer - begrenset kode blir kalt opp av uautoriserte plugin-moduler
  2. API-inkompatibiliteter - endringer mellom versjoner er ikke kompatible
  3. Versjonsproblemer - plugin-versjoner eller kodeversjoner (@since-koder) er feil
  4. Analysealternativer - generelle alternativer

Du kan også konfigurere problemalvorsgrader på prosjektbasis ved hjelp av egenskapssiden API-feil/-advarsler for et prosjekt.

API-bruk

Preferansesiden API-bruk

Generelt

Alternativ

Beskrivelse

Standardverdi

Ikke støttet bruk av API Javadoc-koder

Når API-analysebyggeren er aktivert, vil den kontrollere om API Javadoc-koder er brukt feil.

Ignorer

Referanse ikke definert i oppgitt utføringsmiljø

Når API-analysebyggeren er aktivert, vil den kontrollere om det finnes referanser til systembiblioteker som kan være ugyldige i henhold til utføringsmiljøet som er angitt for pakken.

Ignorer

Begrensninger

Alternativ

Beskrivelse

Standardverdi

Implementere et grensesnitt merket med '@noimplement'

Når API-analysebyggeren er aktivert, vil den kontrollere om merkede grensesnitt er implementert ulovlig.

Advarsel

Utvide en type merket med '@noextend'

Når API-analysebyggeren er aktivert, vil den kontrollere om det finnes klasser som utvider merkede typer.

Advarsel

Referere til et felt eller en metode merket med '@noreference'

Når API-analysebyggeren er aktivert, vil den kontrollere om det finnes felt- og metodereferanser til kodede medlemmer.

Advarsel

Opprette forekomster av en klasse merket med '@noinstantiate'

Når API-analysebyggeren er aktivert, vil den kontrollere at det ikke finnes forekomster av kodede klasser.

Advarsel

Overstyre en metode merket med '@nooverride'

Når API-analysebyggeren er aktivert, vil den kontrollere at kodede metoder ikke overstyres av en underordnet klasse ved utvidelse (reimplementering med et kall til overstyrt overordnet) eller reimplementering (uten kall til overstyrt overordnet).

Advarsel

Lekkasjer

Alternativ

Beskrivelse

Standardverdi

Utvider en ikke-API-klasse

Når API-analysebyggeren er aktivert, vil den kontrollere om noen API-klasser utvider ikke-API-typer.

Advarsel

Implementerer et ikke-API-grensesnitt

Når API-analysebyggeren er aktivert, vil den kontrollere om noen API-klasser implementerer et ikke-API-grensesnitt.

Advarsel

Felt uten ikke-API-type

Når API-analysebyggeren er aktivert, vil den kontrollere om noen API-klasser har felles eller beskyttede felt med ikke-API-typer.

Advarsel

Metode med et ikke-API-returtype

Når API-analysebyggeren er aktivert, vil den kontrollere om noen API-klasser har felles eller beskyttede felt med ikke-API-returtyper.

Advarsel

Metode med ikke-API-parametertype

Når API-analysebyggeren er aktivert, vil den kontrollere om noen API-typer har felles eller beskyttede felt med ikke-API-parametertyper.

Advarsel

API-kompatibilitet

Preferanseside for API-kompatibilitetsalternativer

Alternativ

Beskrivelse

Standardverdi

Rapporter API-brudd selv om det er autorisert av økning i hovedversjon

Når API-analysebyggeren er aktivert, vil den rapportere om problemer med API-brudd, selv om hovedversjonsnummeret til pakken allerede er økt.

Deaktivert

Pakke

Alternativ

Beskrivelse

Standardverdi

En API-type er blitt ikke-API

Når API-analysebyggeren er aktivert, vil den kontrollere om noen API-typer i gjeldende pakke er blitt endret til ikke-API-typer.

Feil

En type er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om noen API-typer er flyttet fra API-omfanget i gitt pakke.

Feil

En API-type som er eksportert på nytt, er blitt ikke-API

Når API-analysebyggeren er aktivert, vil den kontrollere om noen API-typer som er eksportert på nytt i gjeldende pakke, er blitt endret til ikke-API-typer.

Feil

En type som er eksportert på nytt, er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om noen API-typer som er eksportert på nytt, er fjernet fra API-omfanget i gitt pakke.

Feil

Klasse

Alternativ

Beskrivelse

Standardverdi

En metode (som må implementeres) er lagt til:

Når API-analysebyggeren er aktivert, vil den kontrollere om noen offentlige eller beskyttede metoder som må implementeres, er lagt til i noen API-typer.

Feil

Begrensninger er lagt til

Når API-analysebyggeren er aktivert, vil den kontrollere om noen API-begrensninger er lagt til i noen API-klasser.

Feil

En typeparameter er lagt til

Når API-analysebyggeren er aktivert, vil den kontrollere om noen typeparametere er lagt til i noen API-klasser.

Feil

Supergrensesnitthierarki er redusert

Når API-analysebyggeren er aktivert, vil den kontrollere om noen overordnede grensesnitt er fjernet fra noen API-klasser.

Feil

Nøkkelordet 'abstract' er lagt til

Når API-analysebyggeren er aktivert, vil den kontrollere om nøkkelordet 'abstract' er lagt til i noen API-klasser.

Feil

Nøkkelordet 'final' er lagt til

Når API-analysebyggeren er aktivert, vil den kontrollere om nøkkelordet 'final' er lagt til i noen API-klasser.

Feil

Konvertert til annotation, enum eller interface

Når API-analysebyggeren er aktivert, vil den kontrollere om noen API-klasser er endret til annotation, enum eller interface.

Feil

Synligheten er redusert

Når API-analysebyggeren er aktivert, vil den kontrollere om noen felles API-klasser har fått privat eller standard omfang.

Feil

Et felt er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om noen felles eller beskyttede felt er fjernet fra API-klasser.

Feil

En metode er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om noen felles eller beskyttede metoder er fjernet fra API-klasser.

Feil

En konstruktør er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om noen felles eller beskyttede konstruktører er fjernet fra API-klasser.

Feil

Superklassehierarkiet er redusert

Når API-analysebyggeren er aktivert, vil den kontrollere om noen superklasser er fjernet fra hierarkiet.

Feil

En medlemstype er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om noen medlemstyper er fjernet fra noen API-klasser.

Feil

En typeparameter er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om noen typeparametere er fjernet fra API-klasser.

Feil

Grensesnitt

Alternativ

Beskrivelse

Standardverdi

Et felt (grensesnitt som ikke er kodet som '@noimplement') er lagt til

Når API-analysebyggeren er aktivert, vil den kontrollere om noen felles felt er lagt til i API-grensesnitt.

Feil

En metode (grensesnitt som ikke er kodet som '@noimplement') er lagt til

Når API-analysebyggeren er aktivert, vil den kontrollere om noen felles metoder er lagt til i API-grensesnitt.

Feil

Begrensninger er lagt til

Når API-analysebyggeren er aktivert, vil den kontrollere om noen API-begrensninger er lagt til i noen API-grensesnitt.

Feil

En typeparameter er lagt til

Når API-analysebyggeren er aktivert, vil den kontrollere om noen typeparametere er lagt til i API-grensesnitt.

Feil

Konvertert til class, enum eller annotation

Når API-analysebyggeren er aktivert, vil den kontrollere om noen API-grensesnitt er endret til class, enum eller interface.

Feil

Supergrensesnitthierarki er redusert

Når API-analysebyggeren er aktivert, vil den kontrollere om noen overordnede grensesnitt er fjernet fra noen API-grensesnitt.

Feil

En typeparameter er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om noen typeparametere er fjernet fra API-grensesnitt.

Feil

Et felt er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om noen felles felt er fjernet fra API-grensesnitt.

Feil

En metode er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om noen felles metoder er fjernet fra API-grensesnitt.

Feil

En medlemstype er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om noen medlemstyper er fjernet fra API-grensesnitt.

Feil

Enum

Alternativ

Beskrivelse

Standardverdi

Supergrensesnitthierarki er redusert

Når API-analysebyggeren er aktivert, vil den kontrollere om noen overordnede grensesnitt er fjernet fra noen API-enum-typer.

Feil

Konvertert til annotation, class eller interface

Når API-analysebyggeren er aktivert, vil den kontrollere om noen API-enum-verdier er endret til annotation, class eller interface.

Feil

Et felt er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om noen felles felt er fjernet fra API-enum-typer.

Feil

En enum-konstant er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om noen enum-konstanter er fjernet fra noen API-enum-typer.

Feil

En metode er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om noen felles metoder er fjernet fra API-enum-typer.

Feil

En medlemstype er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om noen medlemstyper er fjernet fra noen API-enum-typer.

Feil

Annotasjon

Alternativ

Beskrivelse

Standardverdi

En metode uten standardverdi er lagt til

Når API-analysebyggeren er aktivert, vil den kontrollere om det er lagt til en metode uten standardverdi i en API-annotasjon.

Feil

Konvertert til class, enum eller interface

Når API-analysebyggeren er aktivert, vil den kontrollere om noen API-annotasjoner er konvertert til class, enum eller interface.

Feil

Et felt er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om noen felles felt er fjernet fra API-annotasjoner.

Feil

En metode er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om noen felles metoder er fjernet fra API-annotasjoner.

Feil

En medlemstype er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om noen felles medlemstyper er fjernet fra noen API-annotasjoner.

Feil

Felt

Alternativ

Beskrivelse

Standardverdi

En konstant verdi er lagt til

Når API-analysebyggeren er aktivert, vil den kontrollere om en konstant verdi er lagt til i tidligere ikke-initialiserte felles eller beskyttede feltkonstanter for noen API-typer.

Feil

Typen er endret

Når API-analysebyggeren er aktivert, vil den kontrollere om typen til noen felles eller beskyttede felt er endret for noen API-typer.

Feil

Kontantverdien er endret

Når API-analysebyggeren er aktivert, vil den kontrollere om verdien til noen felles eller beskyttede feltkonstanter er endret i noen API-typer.

Feil

Synligheten er redusert

Når API-analysebyggeren er aktivert, vil den kontrollere om noen felles eller beskyttede felt er gjort private i noen API-typer.

Feil

Nøkkelordet 'final' er fjernet for statisk konstant

Når API-analysebyggeren er aktivert, vil den kontrollere om noen felles eller beskyttede felt har fått nøkkelordet final fjernet i noen API-typer.

Feil

Nøkkelordet 'final' er lagt til

Når API-analysebyggeren er aktivert, vil den kontrollere om nøkkelordet final er lagt til noen felles eller beskyttede felt i noen API-typer.

Feil

Nøkkelordet 'static' er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om nøkkelordet static er fjernet fra noen felles eller beskyttede felt i noen API-typer.

Feil

Nøkkelordet 'static' er lagt til

Når API-analysebyggeren er aktivert, vil den kontrollere om nøkkelordet static er lagt til noen felles eller beskyttede felt i noen API-typer.

Feil

Kontantverdien er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om verdien til et konstant felt er fjernet for noen felles eller beskyttede feltkonstanter i noen API-typer.

Feil

Et typeargument er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om et typeargument er fjernet fra noen felles eller beskyttede felt i noen API-typer.

Feil

Metode

Alternativ

Beskrivelse

Standardverdi

Begrensningen @nooverride er lagt til

Når API-analysebyggeren er aktivert, vil den kontrollere om begrensningene til noen felles eller beskyttede metoder er endret i noen API-typer ved at koden @nooverride er lagt til.

Feil

En typeparameter er lagt til

Når API-analysebyggeren er aktivert, vil den kontrollere om en typeparameter er lagt til noen felles eller beskyttede metoder for noen API-typer.

Feil

Variabelargument konvertert til matrisetype

Når API-analysebyggeren er aktivert, vil den kontrollere om et varargs-argument er utvidet for noen felles eller beskyttede metoder for noen API-typer.

Feil

Synligheten er redusert

Når API-analysebyggeren er aktivert, vil den kontrollere om noen felles eller beskyttede metoder er gjort private for noen API-typer.

Feil

Nøkkelordet 'abstract' er lagt til

Når API-analysebyggeren er aktivert, vil den kontrollere om noen felles eller beskyttede metoder er gjort abstrakte i noen API-typer.

Feil

Nøkkelordet 'static' er lagt til

Når API-analysebyggeren er aktivert, vil den kontrollere om noen felles eller beskyttede metoder er gjort statiske i noen API-typer.

Feil

Nøkkelordet 'static' er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om noen felles eller beskyttede metoder er gjort ikke-statiske i noen API-typer.

Feil

Nøkkelordet 'final' er lagt til (type kodet som '@noextend')

Når API-analysebyggeren er aktivert, vil den kontrollere om felles eller beskyttede metoder er gjort endelige i noen API-typer som ikke er kodet som @noextend.

Feil

Annotasjonens standardverdi er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om standardverdien som er tilknyttet noen API-annotasjonsmetoder, er fjernet.

Feil

En typeparameter er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om en typeparameter fjernet fra noen felles eller beskyttede metoder for noen API-typer.

Feil

Konstruktør

Alternativ

Beskrivelse

Standardverdi

En typeparameter er lagt til

Når API-analysebyggeren er aktivert, vil den kontrollere om en typeparameter er lagt til noen felles konstruktører for noen API-typer.

Feil

Variabelargument konvertert til matrisetype

Når API-analysebyggeren er aktivert, vil den kontrollere om noen varargs-parametere er utvidet til objektmatriser for noen felles konstruktører for noen API-typer.

Feil

Synligheten er redusert

Når API-analysebyggeren er aktivert, vil den kontrollere om noen felles konstruktører er gjort ikke-felles i noen API-typer.

Feil

En typeparameter er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om en typeparameter fjernet fra noen felles konstruktører for noen API-typer.

Feil

Typeparameter

Alternativ

Beskrivelse

Standardverdi

En klassebinding er lagt til

Når API-analysebyggeren er aktivert, vil den kontrollere om en klassebinding er lagt til i noen typeparametere i noen API-typer.

Feil

En grensesnittbinding er lagt til

Når API-analysebyggeren er aktivert, vil den kontrollere om noen grensesnittbindinger er lagt til noen typeparametere i noen API-typer.

Feil

En klassebinding er endret

Når API-analysebyggeren er aktivert, vil den kontrollere om noen klassebindinger er endret i noen typeparametere i noen API-typer.

Feil

En grensesnittbinding er endret

Når API-analysebyggeren er aktivert, vil den kontrollere om noen grensesnittbindinger er endret i noen typeparametere i noen API-typer.

Feil

En klassebinding er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om noen klassebindinger er fjernet fra noen typeparametere i noen API-typer.

Feil

En grensesnittbinding er fjernet

Når API-analysebyggeren er aktivert, vil den kontrollere om noen grensesnittbindinger er fjernet fra noen typeparametere i noen API-typer.

Feil

Versjonsstyring

Preferanseside for alternativ for API-versjonsstyring

Alternativ

Beskrivelse

Standardverdi

Rapporter manglende '@since'-koder

Når API-analysebyggeren er aktivert, vil den kontrollere om @since-koder mangler for typer eller medlemmer som er lagt til etter at versjonen av API-basis ble tatt i bruk.

Feil

Rapporter '@since'-koder med feil format

Når API-analysebyggeren er aktivert, vil den kontrollere om noen @since-koder som er i bruk, har feil format (feil syntaks).

Feil

Rapporter ugyldig '@since'-kodeversjon

Når API-analysebyggeren er aktivert, vil den kontrollere om noen @since-koder som er i bruk, har feil versjon.

Feil

Rapporter inkompatibel buntversjon

Når API-analysebyggeren er aktivert, vil den kontrollere om buntversjonen for plugin-modulen er feil, basert på eventuelle API-endringer og gjeldende API-basis som brukes.

Feil

Ignorer mindre versjonsøkning uten API-endringer

Hvis rapportering for inkompatible versjonsnumre er aktivert, kan dette alternativet brukes til å be API-analysebyggeren ignorere mindre versjonsendringer dersom det ikke er gjort en API-endring sammenliknet med gjeldende API-basis.

På

Ignorer større versjonsøkning uten API-endringer

Hvis rapportering for inkompatible versjonsnumre er aktivert, kan dette alternativet brukes til å be API-analysebyggeren ignorere større versjonsendringer dersom det ikke er gjort en API-endring sammenliknet med gjeldende API-basis.

På

Analysealternativer

Preferansesiden Analysealternativer

Alternativ

Beskrivelse

Standardverdi

Bunt mangler nødvendig begrensning/forutsetning

Når API-analysebyggeren er aktivert, vil den rapportere alle manglende nødvendige begrensinger eller forutsetninger som hindrer byggeren i å utføre en komplett analyse. Uansett hvilken verdi dette alternativet har, vil analysen hoppe over den tilsvarende bunten.

Feil

Ubrukte API-problemfiltre

Når API-analysebyggeren er aktivert, vil den rapportere alle API-problemfiltre som ikke lenger brukes.

Advarsel

Alternativer for API-bruksskanning

Preferanseside for alternativer for API-bruksskanning

Alternativ

Beskrivelse

Standardverdi

Problem med ubehandlede typer

Når API-analysebyggeren er aktivert, vil den rapportere alle API-typer som er fjernet, og som er inkludert i en bruksskanning som er vist på preferansesiden API-bruksskanning.

Feil

Problem med ubehandlede metoder

Når API-analysebyggeren er aktivert, vil den rapportere alle metoder som er fjernet, og som er inkludert i en bruksskanning som er vist på preferansesiden API-bruksskanning.

Feil

Problem med ubehandlede felt

Når API-analysebyggeren er aktivert, vil den rapportere alle felt som er fjernet, og som er inkludert i en bruksskanning som er vist på preferansesiden API-bruksskanning.

Feil


Beslektet referanse

PDE-preferanser
Egenskapsside for API-feil og -advarsler
Preferanser for API-basis
Preferanser for API-bruksskanning