Voorkeuren voor API-fouten en -waarschuwingen

U kunt de volgende voorkeuren instellen op de voorkeurenpagina Voorkeurenpagina voor console openen Pluginontwikkeling > API-fouten/waarschuwingen.

De API-problemen die tijdens projectbuilds (automatische en volledige builds) worden gerapporteerd, worden door de tools onderverdeeld in de volgende drie categorieën:

  1. Gebruiksproblemen - voorbehouden code wordt aangeroepen door niet-gemachtigde plugins.
  2. API-incompatibiliteiten - wijzigingen tussen versies zijn niet compatibel.
  3. Versieproblemen - versies van plugins of code (@since-tags) zijn onjuist.
  4. Analyseopties - algemene opties.

U kunt de probleemseverity's ook configureren per project, door de eigenschappenpagina voor API-fouten/waarschuwingen te gebruiken voor een project

API-gebruik

Voorkeurenpagina voor de API-gebruiksopties

Algemeen

Optie

Beschrijving

Standaardwaarde

Niet-ondersteund gebruik van API-Javadoc-tags

Indien ingeschakeld, controleert de API-analysebuilder of er onjuist gebruikte Javadoc-tags zijn voor de API.

Negeren

Reference not defined in specified execution environment

When enabled the API analysis builder will check for references to system libraries that might be illegal according to the execution environment specified for the bundle.

Negeren

Beperkingen

Optie

Beschrijving

Standaardwaarde

Een als '@noimplement' gemarkeerde interface implementeren

Indien ingeschakeld, controleert de API-analysebuilder op niet-toegestane implementatie van gemarkeerde interfaces.

Waarschuwing

Uitbreiden van een type met de markering '@noextend'

Indien ingeschakeld, controleert de API-analysebuilder of er klassen zijn die gemarkeerde typen uitbreiden.

Waarschuwing

Verwijzen naar een veld of methode met de markering '@noreference'

Indien ingeschakeld, controleert de API-analysebuilder of er veld- of methodeverwijzingen zijn naar gemarkeerde leden.

Waarschuwing

Instantiëren van een klasse met de tag '@noinstantiate'

Indien ingeschakeld, controleert de API-analysebuilder dat klassen met tags niet worden geïnstantieerd.

Waarschuwing

Vervangen van een methode met de markering '@nooverride'

Indien ingeschakeld, controleert de API-analysebuilder of methoden met tags in bovenliggende klassen niet worden vervangen in een onderliggende klasse door het uitbreiden (opnieuw implementeren met een aanroep naar het uitgeschakelde bovenliggende item) of opnieuw implementeren (zonder aanroep naar het uitgeschakelde bovenliggende item).

Waarschuwing

Lekken

Optie

Beschrijving

Standaardwaarde

Uitbreiding van een niet-API-klasse

Indien ingeschakeld, controleert de API-analysebuilder of er API-klassen zijn die niet-API-typen uitbreiden.

Waarschuwing

Implementeert een niet-API-interface

Indien ingeschakeld, controleert de API-analysebuilder of er API-klassen zijn die een niet-API-interface implementeren.

Waarschuwing

Veld met een niet-API-type

Indien ingeschakeld, controleert de API-analysebuilder of er API-typen zijn die openbare of beschermde velden hebben met niet-API-typen.

Waarschuwing

Methode met een niet-API-retourtype

Indien ingeschakeld, controleert de API-analysebuilder of er API-typen zijn die openbare of beschermde methoden hebben met niet-API-retourtypen.

Waarschuwing

Methode met non-API-parametertype

Indien ingeschakeld, controleert de API-analysebuilder of er API-typen zijn die openbare of beschermde methoden hebben met niet-API-parametertypen.

Waarschuwing

API-compatibiliteit

Voorkeurenpagina voor API-compatibiliteitsopties

Optie

Description

Default

API-wijzigingen ook rapporteren als deze is gemachtigd door verhoging van hoofdversie

Indien ingeschakeld, rapporteert de API-analysebuilder problemen bij API-wijzigingen, zelfs als de hoofdversie van de bundel al is verhoogd.

Uitgeschakeld

Bundel

Optie

Beschrijving

Standaardwaarde

Een API-type is een niet-API-type geworden

Indien ingeschakeld, controleert de API-analysebuilder of er in de huidige bundel API-typen zijn die in niet-API-typen zijn gewijzigd.

fout

Een type is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of er API-typen zijn verwijderd uit het API-bereik in de aangegeven bundel.

fout

Een opnieuw geëxporteerd API-type is een niet-API-type geworden

Indien ingeschakeld, controleert de API-analysebuilder of er in de huidige bundel opnieuw geëxporteerde API-typen zijn die in niet-API-typen zijn gewijzigd.

fout

Een opnieuw geëxporteerd type is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of er opnieuw geëxporteerde API-typen zijn verwijderd uit het API-bereik in de aangegeven bundel.

fout

Klasse

Optie

Description

Default

Een methode (die geïmplementeerd moet worden) is toegevoegd:

Indien ingeschakeld, controleert de API-analysebuilder of er openbare of beschermde methoden die geïmplementeerd moeten worden, zijn toegevoegd aan API-typen.

fout

Er zijn beperkingen toegevoegd

Indien ingeschakeld, controleert de API-analysebuilder of er API-beperkingen zijn toegevoegd aan API-klassen.

fout

Een typeparameter is toegevoegd

Indien ingeschakeld, controleert de API-analysebuilder of er typeparameters zijn toegevoegd aan API-klassen.

fout

De hiërarchie van de superinterfaces is gereduceerd

Indien ingeschakeld, controleert de API-analysebuilder of er bovenliggende interfaces zijn verwijderd uit API-klassen.

fout

Het sleutelwoord 'abstract' is toegevoegd

Indien ingeschakeld, controleert de API-analysebuilder of het sleutelwoord 'abstract' is toegevoegd aan een van de API-klassen.

fout

Het sleutelwoord 'final' is toegevoegd

Indien ingeschakeld, controleert de API-analysebuilder of het sleutelwoord 'final' is toegevoegd aan een van de API-klassen.

fout

Omgezet naar annotatie, enum of interface

Indien ingeschakeld, controleert de API-analysebuilder of er API-klassen zijn gewijzigd in annotaties, enums of interfaces.

fout

De zichtbaarheid is verminderd

Indien ingeschakeld, controleert de API-analysebuilder of openbare API-klassen persoonlijk zijn gemaakt of ingesteld in standaardbereik.

fout

Een veld is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of er openbare of beschermde velden zijn verwijderd uit API-klassen.

fout

Een methode is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of er openbare of beschermde methoden zijn verwijderd uit API-klassen.

fout

Een constructor is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of er openbare of beschermde constructors zijn verwijderd uit API-klassen.

fout

De hiërarchie van de superklassen is gereduceerd

Indien ingeschakeld, controleert de API-analysebuilder of er superklassen zijn verwijderd uit de hiërarchie.

fout

Een lidtype is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of er lidtypen zijn verwijderd uit API-klassen.

fout

Een typeparameter is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of er typeparameters zijn verwijderd uit API-klassen.

fout

Interface

Optie

Description

Default

Er is een veld toegevoegd (interface niet voorzien van tag '@noimplement')

Indien ingeschakeld, controleert de API-analysebuilder of er vrij toegankelijke velden zijn toegevoegd aan een API-interface.

fout

Er is een methode toegevoegd (interface niet voorzien van tag '@noimplement')

Indien ingeschakeld, controleert de API-analysebuilder of er vrij toegankelijke methoden zijn toegevoegd aan een API-interface.

fout

Er zijn beperkingen toegevoegd

Indien ingeschakeld, controleert de API-analysebuilder of er API-beperkingen zijn toegevoegd aan API-interfaces.

fout

Een typeparameter is toegevoegd

Indien ingeschakeld, controleert de API-analysebuilder of er typeparameters zijn toegevoegd aan API-interfaces.

fout

Omgezet naar klasse, enum of annotatie

Indien ingeschakeld, controleert de API-analysebuilder of er API-interfaces zijn gewijzigd in klassen, enums of interfaces.

fout

De hiërarchie van de superinterfaces is gereduceerd

Indien ingeschakeld, controleert de API-analysebuilder of er bovenliggende interfaces zijn verwijderd voor API-interfaces.

fout

Een typeparameter is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of er typeparameters zijn verwijderd uit API-interfaces.

fout

Een veld is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of er vrij toegankelijke velden zijn verwijderd uit API-interfaces.

fout

Een methode is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of er vrij toegankelijke methoden zijn verwijderd uit API-interfaces.

fout

Een lidtype is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of er typeleden zijn verwijderd uit API-interfaces.

fout

Enum

Optie

Description

Default

De hiërarchie van de superinterfaces is gereduceerd

Indien ingeschakeld, controleert de API-analysebuilder of er bovenliggende interfaces zijn verwijderd uit API-enums.

fout

Omgezet naar annotatie, klasse of interface

Indien ingeschakeld, controleert de API-analysebuilder of er API-enums zijn gewijzigd in annotaties, klassen of interfaces.

fout

Een veld is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of er vrij toegankelijke velden zijn verwijderd uit API-enums.

fout

Een enum-constante is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of er enum-constanten zijn verwijderd uit API-enums.

fout

Een methode is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of er vrij toegankelijke methoden zijn verwijderd uit API-enums.

fout

Een lidtype is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of er lidtypen zijn verwijderd uit API-enums.

fout

Annotatie

Optie

Description

Default

Een methode zonder standaardwaarde is toegevoegd.

Indien ingeschakeld, controleert de API-analysebuilder of een methode zonder standaardwaarde is toegevoegd aan API-annotaties.

fout

Omgezet naar klasse, enum of interface

Indien ingeschakeld, controleert de API-analysebuilder of er API-annotaties zijn omgezet naar klassen, enums of interfaces.

fout

Een veld is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of er vrij toegankelijke velden zijn verwijderd uit API-annotaties.

fout

Een methode is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of er vrij toegankelijke methoden zijn verwijderd uit API-annotaties.

fout

Een lidtype is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of er vrij toegankelijke lidtypen zijn verwijderd uit API-annotaties.

fout

Veld

Optie

Description

Default

Een constantewaarde is toegevoegd

Indien ingeschakeld, controleert de API-analysebuilder of een constantewaarde is toegevoegd aan voorheen niet geïnitialiseerde openbare of beschermde veldconstanten voor API-typen.

fout

Het type is gewijzigd

Indien ingeschakeld, controleert de API-analysebuilder of het type van openbare of beschermde velden is gewijzigd voor API-typen.

fout

De constantewaarde is gewijzigd.

Indien ingeschakeld, controleert de API-analysebuilder of de waarde van constanten voor openbare of beschermde velden is gewijzigd in de API-typen.

fout

De zichtbaarheid is verminderd

Indien ingeschakeld, controleert de API-analysebuilder of er openbare of beschermde velden persoonlijk zijn gemaakt in API-typen.

fout

Het sleutelwoord 'final' is verwijderd voor statische constante

Indien ingeschakeld, controleert de API-analysebuilder of voor openbare of beschermde velden het sleutelwoord 'final' is verwijderd in een van de API-typen.

fout

Het sleutelwoord 'final' is toegevoegd

Indien ingeschakeld, controleert de API-analysebuilder of het sleutelwoord 'final' is toegevoegd aan openbare of beschermde velden in een van de API-typen.

fout

Het sleutelwoord 'static' is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of het sleutelwoord 'static' is verwijderd uit openbare of beschermde velden in een van de API-typen.

fout

Het sleutelwoord 'static' is toegevoegd

Indien ingeschakeld, controleert de API-analysebuilder of het sleutelwoord 'static' is toegevoegd aan openbare of beschermde velden in een van de API-typen.

fout

De constantewaarde is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of de waarde van een constanteveld is verwijderd voor openbare of beschermde veldconstanten in API-typen.

fout

Een typeargument is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of een typeargument is verwijderd uit openbare of beschermde velden van API-typen.

fout

Methode

Optie

Description

Default

De beperking @nooverride is toegevoegd

Indien ingeschakeld, controleert de API-analysebuilder of de beperkingen voor openbare of beschermde methoden in de API-typen zijn gewijzigd door toevoeging van de tag @nooverride.

fout

Een typeparameter is toegevoegd

Indien ingeschakeld, controleert de API-analysebuilder of een typeparameter is toegevoegd aan openbare of beschermde methoden voor een van de API-typen.

fout

Variabeleargument omgezet naar arraytype

Indien ingeschakeld, controleert de API-analysebuilder of een varargs-argument is uitgebreid tot een objectarray voor openbare of beschermde methoden voor een van de API-typen.

fout

De zichtbaarheid is verminderd

Indien ingeschakeld, controleert de API-analysebuilder of er openbare of beschermde methoden persoonlijk zijn gemaakt voor API-typen.

fout

Het sleutelwoord 'abstract' is toegevoegd

Indien ingeschakeld, controleert de API-analysebuilder of er openbare of beschermde methoden abstract zijn gemaakt in API-typen.

fout

Het sleutelwoord 'static' is toegevoegd

Indien ingeschakeld, controleert de API-analysebuilder of er openbare of beschermde methoden 'static' zijn gemaakt in API-typen.

fout

Het sleutelwoord 'static' is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of er openbare of beschermde methoden 'non-static' zijn gemaakt in API-typen.

fout

Het sleutelwoord 'final' is toegevoegd (type heeft de tag '@noextend')

Indien ingeschakeld, controleert de API-analysebuilder of er openbare of beschermde methoden 'final' zijn gemaakt in API-typen die zijn voorzien van de tag @noextend.

fout

De standaardwaarde voor de annotatie is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of de standaardwaarde van API-annotatiemethoden is verwijderd.

fout

Een typeparameter is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of een typeparameter is verwijderd uit openbare of beschermde methoden voor een van de API-typen.

fout

Constructor

Optie

Description

Default

Een typeparameter is toegevoegd

Indien ingeschakeld, controleert de API-analysebuilder of een typeparameter is toegevoegd aan openbare constructors voor een van de API-typen.

fout

Variabeleargument omgezet naar arraytype

Indien ingeschakeld, controleert de API-analysebuilder of er varargs-parameters zijn uitgebreid tot objectarray's voor een openbare constructor voor een van de API-typen.

fout

De zichtbaarheid is verminderd

Indien ingeschakeld, controleert de API-analysebuilder of er openbare constructors 'non-public' zijn gemaakt in API-typen.

fout

Een typeparameter is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of een typeparameter zijn verwijderd uit openbare constructors voor een van de API-typen.

fout

Typeparameter

Optie

Description

Default

Een klassekoppeling is toegevoegd

Indien ingeschakeld, controleert de API-analysebuilder of een klassekoppeling is toegevoegd aan een typeparameter van een API-type.

fout

Een interfacekoppeling is toegevoegd

Indien ingeschakeld, controleert de API-analysebuilder of er interfacekoppelingen zijn toegevoegd aan een typeparameter van een API-type.

fout

Een klassenkoppeling is gewijzigd

Indien ingeschakeld, controleert de API-analysebuilder of er klassenkoppelingen zijn gewijzigd in een typeparameter van een API-type.

fout

Een interfacekoppeling is gewijzigd

Indien ingeschakeld, controleert de API-analysebuilder of er interfacekoppelingen zijn gewijzigd in een typeparameter van een API-type.

fout

Een klassekoppeling is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of er klassenkoppelingen zijn verwijderd uit een typeparameter van een API-type.

fout

Een interfacekoppeling is verwijderd

Indien ingeschakeld, controleert de API-analysebuilder of er interfacekoppelingen zijn verwijderd uit een typeparameter van een API-type.

fout

Versiebeheer

Voorkeurenpagina voor opties van API-versiebeheer

Optie

Description

Default

Ontbrekende '@since'-tags rapporteren

Indien ingeschakeld, controleert de API-analysebuilder of er tags @since ontbreken voor typen of leden die zijn toegevoegd sinds de versie van de API-basislijn in gebruik is.

fout

Ongeldige '@since'-tags rapporteren

Indien ingeschakeld, controleert de API-analysebuilder of er momenteel ongeldige @since-tags in gebruik zijn (onjuiste syntaxis).

fout

Ongeldige versies van '@since'-tag rapporteren

Indien ingeschakeld, controleert de API-analysebuilder of er momenteel @since-tags van een verkeerde versie in gebruik zijn.

fout

Incompatibele bundelversie rapporteren

Indien ingeschakeld, controleert de API-analysebuilder of de bundelversie voor de plugin incorrect is, op basis van API-wijzigingen en de API-basislijn die wordt gebruikt.

fout

Negeer verhoging van subversie zonder API-wijzigingen

As het rapporteren van ongeldige versienummers is ingeschakeld, kunt u met deze optie aangeven dat de API-analysebuilder subversiewijzigingen moet negeren wanneer de API niet is gewijzigd in vergelijking met de actuele API-basislijn.

Aan

Negeer verhoging van hoofdversie zonder API-wijzigingen

As het rapporteren van ongeldige versienummers is ingeschakeld, kunt u met deze optie aangeven dat de API-analysebuilder hoofdversiewijzigingen moet negeren wanneer de API niet is gewijzigd in vergelijking met de actuele API-basislijn.

Aan

Analyseopties

Voorkeurenpagina analyseopties

Optie

Description

Default

Voorwaarde ontbreekt in bundel

Indien ingeschakeld, rapporteert de API-analysebuilder ontbrekende verplichte voorwaarden of vereisten, waardoor de builder de analyse niet kan voltooien. De analyse van de betreffende bundel wordt ongeacht de waarde van deze optie overgeslagen.

fout

Ongebruikte API-probleemfilters

Indien ingeschakeld, meldt de API-analysebuilder API-probleemfilters die niet meer worden gebruikt.

Waarschuwing

API Use Scans Options

API use scans options preference page

Optie

Description

Default

Unresolved type problem

When enabled the API analysis builder will report any API types that have been removed that are included in any use scan listed on the API Use Scans prefrence page.

fout

Unresolved method problem

When enabled the API analysis builder will report any methods that have been removed that are included in any use scan listed on the API Use Scans prefrence page.

fout

Unresolved field problem

When enabled the API analysis builder will report any fields that have been removed that are included in any use scan listed on the API Use Scans prefrence page.

fout


Verwante onderwerpen

PDE-voorkeuren
Eigenschappenpagina voor API-fouten en -waarschuwingen
API-basislijnvoorkeuren
API Use Scans Preferences