Inställningar för API-fel och varningar

Du kan ange följande inställningar på sidan Öppnar sidan för konsolinställningar Utveckling av insticksprogram> API-fel/-varningar .

API-problem skapas under projektbyggen (automatiska och fullständiga byggen), verktygen delar upp de rapporterade problemtyperna i tre kategorier:

  1. Användningsproblem - begränsad kod har anropats av obehörigt insticksprogram
  2. API-inkompatibilitet - ändringar mellan versioner är inte kompatibla
  3. Versionsproblem - insticksprogam- eller kodversioner (@since tags) är inte korrekta
  4. Analysalternativ - allmänna alternativ

Du kan också konfigurera problemallvarlighetsnivåerna på projektbasis genom att använda egenskapssidan API-fel/-varningar för ett projekt.

Använda API

Inställningssidan för API-användning

Allmänt

Alternativ

Beskrivning

Standard

Oriktig användning av API-Javadoc-märkord

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om API-Javadoc-märkord används felaktigt.

Ignorera

Referens inte är definierade i den angivna exekveringsmiljön

När alternativet aktiveras söker API-analysbyggfunktionen efter referenser till systembibliotek som ogiltiga enligt körningsmiljön som har angetts för samlingspaketet.

Ignorera

Begränsningar

Alternativ

Beskrivning

Standard

Implementera ett gränssnitt märkt som @noimplement

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om det finns olagliga implementationer av märkta gränssnitt.

Varning

Utökar en typ som är märkt @noextend

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om det finns klasser som utökar märkta typer.

Varning

Refererar till ett fält eller en metod som är märkt @noreference

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om det finns fält- och metodreferenser till märkta medlemmar.

Varning

Skapar en förekomst av en klass med märkordet @noinstantiate

När alternativet är aktivt kontrollerar API-analysbyggfunktionen att märkta klasser inte är skapade.

Varning

Åsidosätter en metod som är märkt med @nooverride

När alternativet är aktivt kontrollerar API-analysbyggfunktionen att märkta metoder i överordnade klasser inta åsidosätts i någon underordnad klass genom antingen utökning (återimplementering med ett anrop till den åsidosatta överordnade klassen) eller återimplementering (utan anrop till den åsidosatt överordnade klassen).

Varning

Läckor

Alternativ

Beskrivning

Standard

Utökar en icke-API-klass

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några API-klasser utökar icke-API-typer.

Varning

Implementerar ett icke-API-gränssnitt

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några API-klasser implementerar ett icke-API-gränssnitt.

Varning

Fält med icke-API-typ

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några API-typer har publika eller skyddade fält med icke-API-typer.

Varning

Metod med en icke-API-returtyp

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några API-typer har publika eller skyddade metoder med icke-API-returtyper.

Varning

Metod med en icke-API-parametertyp

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några API-typer har publika eller skyddade metoder med icke-API-parametertyper.

Varning

API-kompatibilitet

Inställningssidan för alternativet API-kompatibilitet

Alternativ

Beskrivning

Standard

Rapportera API-brytning även om det är auktoriserat av ökning i huvudversion

När alternativet har aktiverats rapporterar API-analysbyggfunktionen problem för API-brytningar även om huvudversionen av samlingspaketet redan har utökats.

Avaktiverad

Samlingspaket

Alternativ

Beskrivning

Standard

En API-typ har blivit en icke-API-typ

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några API-typer i det aktuella paketet har ändrats till icke-API-typer.

Fel

En typ har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några API-typer har tagits bort från API-omfånget i ett visst paket.

Fel

En omexporterad API-typ har blivit en icke-API-typ

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några omexporterade API-typer i det aktuella paketet har ändrats till icke-API-typer.

Fel

En omexporterad typ har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några omexporterade API-typer har tagits bort från API-omfånget i ett visst paket.

Fel

Klass

Alternativ

Beskrivning

Standard

En metod (som måste implementeras) har lagts till:

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några publika eller skyddade metoder som måste implementeras har lagts till för någon API-typ.

Fel

Begränsningar har lagts till

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om API-begränsningar har lagts till för några API-klasser.

Fel

En typparameter har lagts till

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några typparametrar har lagts till i några API-klasser.

Fel

Supergränssnittshierarkin har minskats

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några överordnade gränssnitt har tagits bort från några API-klasser.

Fel

Nyckelordet abstract har lagts till

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om nyckelordet abstract har lagts till i några API-klasser.

Fel

Nyckelordet final har lagts till

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om nyckelordet final har lagts till i några API-klasser.

Fel

Konverterat till anteckning, enum eller gränssnitt

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några API-klasser har ändrats till kommentarer, enumerationer eller gränssnitt.

Fel

Synligheten har minskats

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några publika API-klasser har gjorts till privata eller standardomfång.

Fel

Ett fält har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några publika eller skyddade fält har tagits bort från några API-klasser.

Fel

En metod har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några publika eller skyddade metoder har tagits bort från några API-klasser.

Fel

En konstruktor har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några publika eller skyddade konstruktorer har tagits bort från några API-klasser.

Fel

Superklasshierarkin har minskats

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om superklasser har tagits bort från hierarkin.

Fel

En medlemstyp har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några medlemstyper har tagits bort från några API-klasser.

Fel

En typparameter har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om typparametrar har tagits bort från några API-klasser.

Fel

Gränssnitt

Alternativ

Beskrivning

Standard

Ett fält (med gränssnitt utan märkordet @noimplement) har lagts till

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några publika fält har lagts till i några API-gränssnitt.

Fel

En metod (med gränssnitt utan märkordet @noimplement) har lagts till

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några publika metoder har lagts till i några API-gränssnitt.

Fel

Begränsningar har lagts till

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om API-begränsningarna har lagts till för några API-gränssnitt.

Fel

En typparameter har lagts till

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några typparametrar har lagts till i några API-gränssnitt.

Fel

Konverterat till klass, enum eller anteckning

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några API-gränssnitt har ändrats till klasser, enumerationer eller gränssnitt.

Fel

Supergränssnittshierarkin har minskats

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några överordnade gränssnitt har tagits bort för några API-gränssnitt.

Fel

En typparameter har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om typparametrar har tagits bort från några API-gränssnitt.

Fel

Ett fält har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några publika fält har tagits bort från några API-gränssnitt.

Fel

En metod har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några publika metoder har tagits bort från några API-gränssnitt.

Fel

En medlemstyp har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några medlemstyper har tagits bort från några API-gränssnitt.

Fel

Enumeration

Alternativ

Beskrivning

Standard

Supergränssnittshierarkin har minskats

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några överordnade gränssnitt har tagits bort från några API-enumerationer.

Fel

Konverterat till anteckning, klass eller gränssnitt

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några API-enumerationer har ändrats till kommentarer, klasser eller gränssnitt.

Fel

Ett fält har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några publika fält har tagits bort från några API-enumerationer.

Fel

En enumerationskonstant har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några enumerationskonstanter har tagits bort från några API-enumerationer.

Fel

En metod har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några publika metoder har tagits bort från några API-enumerationer.

Fel

En medlemstyp har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några medlemstyper har tagits bort från några API-enumerationer.

Fel

Kommentar

Alternativ

Beskrivning

Standard

En metod utan standardvärde har lagts till

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om en metod utan något standardvärde har lagts till API-kommentarer.

Fel

Konverterat till klass, enum eller gränssnitt

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några API-kommentarer har konverterats till klasser, enumerationer eller gränssnitt.

Fel

Ett fält har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några publika fält har tagits bort från några API-kommentarer.

Fel

En metod har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några publika metoder har tagits bort från några API-kommentarer.

Fel

En medlemstyp har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några publika medlemstyper har tagits bort från några API-kommentarer.

Fel

Fält

Alternativ

Beskrivning

Standard

Ett konstantvärde har lagts till

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om ett konstantvärde har lagts till i tidigare i oinitierade publika eller skyddade fältkonstanter för några API-typer.

Fel

Typen har ändrats

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några publika eller skyddade fält har ändrats för några API-typer.

Fel

Konstantvärdet har ändrats

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om värdet för några publika eller skyddade fältkonstanter har ändrats i några API-typer.

Fel

Synligheten har minskats

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några publika eller skyddade fält har gjorts till privata i några API-typer.

Fel

Nyckelordet final har tagits bort för statisk konstant

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några publika eller skyddade fält har fått nyckelordet final borttaget i några API-typer.

Fel

Nyckelordet final har lagts till

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om nyckelordet final har lagts till några publika eller skyddade fält i några API-typer.

Fel

Nyckelordet static har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om nyckelordet static har tagits bort från några publika eller skyddade fält i några API-typer.

Fel

Nyckelordet static har lagts till

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om nyckelordet final har lagts till några publika eller skyddade fält i några API-typer.

Fel

Konstantvärdet har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om värdet för ett konstantfält har tagits bort för några publika eller skyddade fältkonstanter i några API-typer.

Fel

Ett typargument har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om ett typargument har tagits bort från några publika eller skyddade fält för några API-typer.

Fel

Metod

Alternativ

Beskrivning

Standard

Begränsningen @nooverride har lagts till

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om begränsningarna för publika eller skyddade metoder har ändrats i några API-typer genom att lägga till märkordet @nooverride.

Fel

En typparameter har lagts till

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om en typparameter har lagts till några publika eller skyddade metoder för några API-typer.

Fel

Variabelargument har konverterats till matristyp

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om ett varargs-argument har utökats till en objektmatris för någon publik eller skyddad metod för några API-typer.

Fel

Synligheten har minskats

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några publika eller skyddade metoder har gjorts privata för några API-typer.

Fel

Nyckelordet abstract har lagts till

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några publika eller skyddade metoder har gjorts "abstract" i några API-typer.

Fel

Nyckelordet static har lagts till

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några publika eller skyddade metoder har gjorts "static" i några API-typer.

Fel

Nyckelordet static har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några publika eller skyddade metoder har gjorts icke-statiska (ej "static") i några API-typer.

Fel

Nyckelordet final har lagts till (typ med märkordet @noextend)

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några publika eller skyddade metoder gjorts "final" i några API-typer som har märkts med @noextend.

Fel

Kommentarsstandardvärdet har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om standardvärdet för någon API-kommentarmetod har tagits bort.

Fel

En typparameter har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om en typparameter har tagits bort från några publika eller skyddade metoder för några API-typer.

Fel

Konstruktor

Alternativ

Beskrivning

Standard

En typparameter har lagts till

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om en typparameter har lagts till några publika konstruktorer för några API-typer.

Fel

Variabelargument har konverterats till matristyp

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några varargs-parametrar har utökats till objektmatriser för några publika konstruktorer för några API-typer.

Fel

Synligheten har minskats

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några publika konstruktorer har gjorts icke-publika i några API-typer.

Fel

En typparameter har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om en typparameter har tagits bort från några publika konstruktorer för några API-typer.

Fel

Typparameter

Alternativ

Beskrivning

Standard

En klassbindning har lagts till

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om en klassbindning har lagts till någon typparameter för några API-typer.

Fel

En gränssnittsbindning har lagts till

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om en gränssnittsbindning har lagts till någon typparameter för några API-typer.

Fel

En klassbindning har ändrats

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om någon klassbindning har ändrats för någon typparameter för några API-typer.

Fel

En gränssnittsbindning har ändrats

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om någon gränssnittsbindning har ändrats för någon typparameter för några API-typer.

Fel

En klassbindning har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om någon klassbindning har tagits bort för någon typparameter för några API-typer.

Fel

En gränssnittsbindning har tagits bort

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om någon gränssnittsbindning har tagits bort för någon typparameter för några API-typer.

Fel

Versionshantering

Inställningssidan för alternativet API-versionshantering

Alternativ

Beskrivning

Standard

Rapportera saknade @since-märkord

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om @since-märkord saknas för typer eller medlemmar som har lagts till sedan versionen för den API-basnivå som används.

Fel

Rapportera felformaterade @since-märkord

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några @since-märkord som för närvarande används är felformaterade (fel syntax).

Fel

Rapportera ogiltig @since-märkordsversion

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om några @since-märkord som för närvarande används har fel version.

Fel

Rapportera inkompatibel paketversion

När alternativet är aktivt kontrollerar API-analysbyggfunktionen om paketversionen för insticksprogrammet är fel, baserat på eventuella API-ändringar och den aktuella API-basnivån som används.

Fel

Ignorera ökningar för underordnade versioner utan API-ändringar

Om rapporteringen av inkompatibla versionsnummer är aktiv, kan det här alternativet användas för att ange för API-analysbyggfunktionen att åsidosätta mindre versionsändringar om det inte har utförts en API-ändring jämförd med den aktuella API-basnivån.

På

Ignorera större ökningar för versioner utan API-ändringar

Om rapporteringen av inkompatibla versionsnummer är aktiv, kan det här alternativet användas för att ange för API-analysbyggfunktionen att åsidosätta större versionsökningar om det inte har utförts en API-ändring jämförd med den aktuella API-basnivån.

På

Analysalternativ

Inställningssidan Analysalternativ

Alternativ

Beskrivning

Standard

Paketet saknar regel/förutsättning som krävs

När alternativet är aktivt rapporterar API-analysbyggfunktionen alla obligatoriska begränsningar eller förutsättningar som saknas för att byggfunktionen ska kunna göra en fullständig analys. Oavsett vilket värde som anges hoppas analysen över för motsvarande samlingspaket.

Fel

Oanvända API-problemfiler

När alternativet är aktivt rapporterar API-analysbyggfunktionen vilka API-problemfilter som inte längre används.

Varning

Alternativ för API-användningssökningar

Inställningssida för API-användningssökningar

Alternativ

Beskrivning

Standard

Olösta typproblem

När alternativet är aktivt rapporterar API-analysbyggfunktionen alla API-typer som har tagits bort och som ingår i någon avsökningslista på inställningssidan API-användningssökningar.

Fel

Olösta metodproblem

När alternativet är aktivt rapporterar API-analysbyggfunktionen alla metoder som har tagits bort och som ingår i någon användningsöklista på inställningssidan API-användningssökningar.

Fel

Olösta fältproblem

När alternativet är aktivt rapporterar API-analysbyggfunktionen alla fält som har tagits bort och som ingår i någon användningsöklista på inställningssidan API-användningssökningar.

Fel


Närliggande referens

PDE-inställningar
Egenskapssidan för API-fel och varningar
Inställningar för API-basnivåer
Inställningar för API-användningssökning