Indstillinger for API-fejl og -advarsler

Du kan angive følgende indstillinger på indstillingssiden Åbner indstillingssiden Konsol Plugin-udvikling > API-fejl/advarsler.

API-problemer opstår under bygning af projekter (automatiske og fuldstændige bygninger). Værktøjet inddeler de rapporterede typer problemer i tre kategorier:

  1. Problemer i forbindelse med brugen - kode med begrænsninger kaldes af uautoriserede plugins.
  2. API-inkompatibilitet - forskelle mellem versioner er ikke kompatible.
  3. Versionsproblemer - plugin-versioner eller kodeversioner (@since-koder) er ikke korrekte.
  4. Analyseindstillinger - generelle indstillinger.

Du kan også konfigurere problemniveauerne pr. projekt ved at bruge egenskabssiden API-fejl/advarsler for et projekt.

API-brug

Indstillingssiden API-brug

Generelt

Indstilling

Beskrivelse

Standard

Brug af API Javadoc-koder er ikke understøttet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er API Javadoc-koder, som er brugt forkert.

Ignorér

Reference er ikke defineret i det angivne udførelsesmiljø

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er referencer til systembiblioteker, som kan være ugyldige i henhold til det udførelsesmiljø, der er angivet for bundtet.

Ignorér

Begrænsninger

Indstilling

Beskrivelse

Standard

Implementerer en grænseflade mærket '@noimplement'

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er ugyldige implementeringer af markerede grænseflader.

Advarsel

Udvider en type mærket '@noextend'

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er klasser, som udvider markerede typer.

Advarsel

Refererer til et felt eller en metode mærket '@noreference'

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er felt- og metodereferencer til mærkede medlemmer.

Advarsel

Opretter forekomst af en klasse mærket '@noinstantiate'

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er oprettet en forekomst af mærkede klasser.

Advarsel

Tilsidesætter en metode mærket '@nooverride'

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er mærkede metoder i overordnede klasser, der er tilsidesat i en underordnet klasse, enten via udvidelse (genimplementér med et kald til den tilsidesatte overordnede) eller via genimplementering (uden et kald til den tilsidesatte overordnede).

Advarsel

Læk

Indstilling

Beskrivelse

Standard

Udvider en ikke-API-klasse

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er API-klasser, som udvider ikke-API-typer.

Advarsel

Implementerer en ikke-API-grænseflade

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er API-klasser, som implementerer en ikke-API-grænseflade.

Advarsel

Felt med en ikke-API-type

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er API-typer, som har offentlige eller beskyttede felter med ikke-API-typer.

Advarsel

Metode med en ikke-API-returtype

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er API-typer, som har offentlige eller beskyttede metoder med ikke-API-returtyper.

Advarsel

Metode med en ikke-API-parametertype

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er API-typer, som har offentlige eller beskyttede metoder med ikke-API-parametertyper.

Advarsel

API-kompatibilitet

Indstillingssiden API-kompatibilitet

Indstilling

Beskrivelse

Standard

Rapportér om API-brud, selvom den er autoriseret af større versionsforøgelse

Hvis indstillingen er aktiveret, vil API-analysebyggeprogrammet rapportere om problemer med API-brud, selvom den større version af bundtet allerede er forøget.

Deaktiveret

Bundt

Indstilling

Beskrivelse

Standard

En API-type er blevet en ikke-API

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er API-typer i det aktuelle bundt, som er blevet ændret til ikke-API-typer.

Fejl

En type er fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er API-typer, som er fjernet fra API-omfanget i det givne bundt.

Fejl

En geneksporteret API-type er blevet en ikke-API

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er geneksporterede API-typer i det aktuelle bundt, som er blevet ændret til ikke-API-typer.

Fejl

En geneksporteret type er blevet fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er geneksporterede API-typer, som er fjernet fra API-omfanget i det givne bundt.

Fejl

Klasse

Indstilling

Beskrivelse

Standard

En metode (som kræver implementering) er tilføjet:

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nogen offentlige eller beskyttede metoder, der skal implementeres, er blevet til føjet til en API-type.

Fejl

Begrænsninger er tilføjet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om API-begrænsninger er ændret for API-klasser.

Fejl

En typeparameter er tilføjet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er tilføjet nogen typeparametre til API-klasserne.

Fejl

Supergrænsefladehierarkiet er reduceret

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nogen overordnede grænseflader er fjernet fra API-klasser.

Fejl

Nøgleordet 'abstract' er tilføjet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nøgleordet 'abstract' er tilføjet til API-klasser.

Fejl

Nøgleordet 'final' er tilføjet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nøgleordet 'final' er tilføjet til API-klasser.

Fejl

Konverteret til annotation, enum eller grænseflade

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nogen API-klasser er ændret til annotationer, enums eller grænseflader.

Fejl

Synligheden er reduceret

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nogen API-klasser med omfanget 'public' er ændret til 'private' eller 'default'.

Fejl

Et felt er fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er fjernet nogen offentlige eller beskyttede felter fra API-klasser.

Fejl

En metode er fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er fjernet nogen offentlige eller beskyttede metoder fra API-klasser.

Fejl

En konstruktør er fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er fjernet nogen offentlige eller beskyttede konstruktører fra API-klasser.

Fejl

Superklassehierarkiet er reduceret

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er fjernet nogen superklasser fra hierarkiet.

Fejl

En medlemstype er blevet fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er fjernet nogen medlemstyper fra API-klasser.

Fejl

En typeparameter er fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er fjernet nogen typeparametre fra API-klasser.

Fejl

Grænseflade

Indstilling

Beskrivelse

Standard

Et felt (grænseflade ikke mærket som '@noimplement') er tilføjet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er tilføjet nogen offentlige felter til API-grænsefladerne.

Fejl

En metode (grænseflade ikke mærket som '@noimplement') er tilføjet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er tilføjet nogen offentlige metoder til API-grænsefladerne.

Fejl

Begrænsninger er tilføjet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er tiløjet API-begrænsninger er ændret for nogen API-grænseflader.

Fejl

En typeparameter er tilføjet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er tilføjet nogen typeparametre til API-grænsefladerne.

Fejl

Konverteret til klasse, enum eller annotation

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nogen API-grænseflader er ændret til klasser, enums eller grænseflader.

Fejl

Supergrænsefladehierarkiet er reduceret

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nogen overordnede grænseflader er fjernet for nogen API-grænseflader.

Fejl

En typeparameter er fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er fjernet nogen typeparametre fra API-grænseflader.

Fejl

Et felt er fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er fjernet nogen offentlige felter fra API-grænseflader.

Fejl

En metode er fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er fjernet nogen offentlige metoder fra API-grænseflader.

Fejl

En medlemstype er blevet fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er fjernet nogen medlemstyper fra API-grænseflader.

Fejl

Enum

Indstilling

Beskrivelse

Standard

Supergrænsefladehierarkiet er reduceret

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nogen overordnede grænseflader er fjernet fra API-enum-typer.

Fejl

Konverteret til annotation, klasse eller grænseflade

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nogen API-enums er ændret til annotationer, klasser eller grænseflader.

Fejl

Et felt er fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er fjernet nogen offentlige felter fra API-enum-typer.

Fejl

En enum-konstant er fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nogen enum-konstanter er fjernet fra API-enum-typer.

Fejl

En metode er fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er fjernet nogen offentlige metoder fra API-enum-typer.

Fejl

En medlemstype er blevet fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er fjernet nogen medlemstyper fra API-enum-typer.

Fejl

Annotation

Indstilling

Beskrivelse

Standard

En metode uden en standardværdi er tilføjet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er tilføjet en metode uden en standardværdi til API-annotationer.

Fejl

Konverteret til klasse, enum eller grænseflade

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nogen API-annotationer er ændret til klasser, enums eller grænseflader.

Fejl

Et felt er fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er fjernet nogen offentlige felter fra API-annotationer.

Fejl

En metode er fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er fjernet nogen offentlige metoder fra API-annotationer.

Fejl

En medlemstype er blevet fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er fjernet nogen medlemstyper fra API-annotationer.

Fejl

Felt

Indstilling

Beskrivelse

Standard

En konstantværdi er tilføjet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der er tilføjet en konstantværdi til tidligere ikke-initialiserede offentlige eller beskyttede feltkonstanter for en API-type.

Fejl

Typen er ændret

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om typen for nogen offentlige eller beskyttede felter er ændret for en API-type.

Fejl

Konstantværdien er ændret

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om værdien af nogen offentlige eller beskyttede feltkonstanter er ændret for nogen API-typer.

Fejl

Synligheden er reduceret

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nogen offentlige eller beskyttede felter er gjort private i API-typer.

Fejl

Nøgleordet 'final' er fjernet for statisk konstant

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nøgleordet 'final' er fjernet fra nogen offentlige eller beskyttede felter i nogen API-typer.

Fejl

Nøgleordet 'final' er tilføjet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nøgleordet 'final' er tilføjet til nogen offentlige eller beskyttede felter i nogen API-typer.

Fejl

Nøgleordet 'static' er fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nøgleordet 'static' er fjernet fra nogen offentlige eller beskyttede felter i nogen API-typer.

Fejl

Nøgleordet 'static' er tilføjet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nøgleordet 'static' er tilføjet til nogen offentlige eller beskyttede felter i nogen API-typer.

Fejl

Konstantværdien er fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om værdien af et konstantfelt er fjernet fra nogen offentlige eller beskyttede feltkonstanter i nogen API-typer.

Fejl

Et typeargument er fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om et typeargument er fjernet fra nogen offentlige eller beskyttede felter i API-typer.

Fejl

Metode

Indstilling

Beskrivelse

Standard

Begrænsningen @nooverride er tilføjet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om begrænsningerne af nogen offentlige eller beskyttede metoder er ændret for nogen API-typer, ved at tilføje koden @nooverride.

Fejl

En typeparameter er tilføjet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om en typeparameter er tilføjet til nogen offentlige eller beskyttede metoder for API-typer.

Fejl

Konverteret variabel argumenttype til arraytype

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om et varargs-argument er udvidet til et objektarray for nogen offentlige eller beskyttede metoder for en API-type.

Fejl

Synligheden er reduceret

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nogen offentlige eller beskyttede metoder er gjort private for en API-type.

Fejl

Nøgleordet 'abstract' er tilføjet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nogen offentlige eller beskyttede metoder er gjort abstrakte i en API-type.

Fejl

Nøgleordet 'static' er tilføjet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nogen offentlige eller beskyttede metoder er gjort statiske i en API-type.

Fejl

Nøgleordet 'static' er fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nogen offentlige eller beskyttede metoder er gjort ikke-statiske i en API-type.

Fejl

Nøgleordet 'final' er tilføjet (type mærket '@noextend')

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nogen offentlige eller beskyttede metoder er angivet til 'final' i en API-type, som er mærket som @noextend.

Fejl

Standardværdien for annotation er fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om den standardværdi, der er knyttet til en API-annotation, er fjernet.

Fejl

En typeparameter er fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om en typeparameter er fjernet fra nogen offentlige eller beskyttede metoder for API-typer.

Fejl

Konstruktør

Indstilling

Beskrivelse

Standard

En typeparameter er tilføjet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om en typeparameter er tilføjet til nogen offentlige konstruktører for API-typer.

Fejl

Konverteret variabel argumenttype til arraytype

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nogen varargs-parametre er udvidet til objektarrays for nogen offentlige konstruktører for API-typer.

Fejl

Synligheden er reduceret

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nogen offentlige konstruktører er gjort ikke-offentlige i en API-type.

Fejl

En typeparameter er fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om en typeparameter er fjernet fra nogen offentlige konstruktører for API-typer.

Fejl

Typeparameter

Indstilling

Beskrivelse

Standard

En klassegrænse er tilføjet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om en klassegrænse er tilføjet til en typeparameter for API-typer.

Fejl

En grænsefladegrænse er tilføjet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om en grænsefladegrænse er tilføjet til en typeparameter for API-typer.

Fejl

En klassegrænse er ændret

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om en klassegrænse er ændret for en typeparameter for API-typer.

Fejl

En grænsefladegrænse er ændret

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om en grænsefladegrænse er ændret for en typeparameter for API-typer.

Fejl

En klassegrænse er fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om en klassegrænse er fjernet fra en typeparameter for API-typer.

Fejl

En grænsefladegrænse er fjernet

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om en grænsefladegrænse er fjernet fra en typeparameter for API-typer.

Fejl

Versionsstyring

Indstillingssiden Versionsstyring for API'er

Indstilling

Beskrivelse

Standard

Rapportér manglende '@since'-koder

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om der mangler @since-koder for typer eller medlemmer, som er tilføjet siden den version af API-grundlinjen, der er i brug.

Fejl

Rapportér forkert udformede '@since'-koder

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nogen af de @since-koder, der i øjeblikket er i brug, er forkert udformet.

Fejl

Rapportér ugyldig '@since'-kodeversion

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om nogen af de @since-koder, der i øjeblikket er i brug, har en forkert version.

Fejl

Rapportér inkompatibel bundtversion

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet kontrollere, om bundtversionen for plugin'en er forkert ud fra eventuelle API-ændringer og den API-grundlinje, der i øjeblikket er i brug.

Fejl

Ignorér mindre versionsforøgelse uden API-ændringer

Hvis rapportering af inkompatible versionsnumre er aktiveret, kan denne indstilling bruges til at instruere API-analysebyggeprogrammet om at ignorere mindre versionsændringer, hvis der ikke har været en API-ændring i sammenligning med den aktuelle API-grundlinje.

Aktiveret

Ignorér større versionsforøgelse uden API-brud

Hvis rapportering af inkompatible versionsnumre er aktiveret, kan denne indstilling bruges til at instruere API-analysebyggeprogrammet om at ignorere større versionsændringer, hvis der ikke har været en API-ændring i sammenligning med den aktuelle API-grundlinje.

Aktiveret

Analyseindstillinger

Indstillingssiden Analyseindstillinger

Indstilling

Beskrivelse

Standard

Bundt mangler påkrævet begrænsning/forudsætning

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet rapportere om manglende påkrævede betingelser eller forudsætninger, der forhindrer byggeprogrammet i at udføre en fuldstændig analyse. Uanset værdien af denne indstilling springes analysen over for det tilsvarende bundt.

Fejl

Ubrugte API-problemfiltre

Hvis indstillingen aktiveres, vil API-analysebyggeprogrammet rapportere om API-problemfiltre, der ikke længere bruges.

Advarsel

Indstillinger for API

Indstillingssiden for API-brugsscanninger

Indstilling

Beskrivelse

Standard

Uløst typeproblem

Når indstillingen er aktiveret, rapporterer API Analysis Builder API-typer, der er blevet fjernet, og som er inkluderet i en brugsscanning, som er angivet på indstillingssiden API-brugsscanninger.

Fejl

Uløst metodeproblem

Når indstillingen er aktiveret, rapporterer API Analysis alle metoder, der er blevet fjernet, og som er inkluderet i en brugsscanning, som er angivet på indstillingssiden API-brugsscanninger.

Fejl

Uløst feltproblem

Når indstillingen er aktiveret, rapporterer API Analysis alle felter, der er blevet fjernet, og som er inkluderet i en brugsscanning, som er angivet på indstillingssiden API-brugsscanninger.

Fejl


Relaterede referencer

PDE-indstillinger
Egenskabssiden API-fejl og -advarsler
API-grundlinjeindstillinger
Indstillinger for API-brugsscanninger