API hibák és figyelmeztetések beállításai

A következő beállításokat a Konzol beállítási oldal megnyitása Bedolgozó fejlesztés > API hibák/figyelmeztetések beállítási oldalon adhatja meg.

Az API problémák a projekt összeépítések (automatikus vagy teljes összeépítések) során jönnek létre, és az eszközkészlet a jelentett problématípusokat a következő három kategória egyikébe sorolja be:

  1. Használati problémák - amikor jogosulatlan bedolgozók hívnak meg korlátozott kódot
  2. API inkompatibilitás - amikor a két változat közti módosítások nem kompatibilisek egymással
  3. Verziószám problémák - amikor a bedolgozó vagy kód verziószámok (@since címkék) helytelenek
  4. Elemzési beállítások - általános beállítások

A problémák súlyosságát projektenkénti alapon is beállíthatja a projekt API hibák/figyelmeztetések adatlapján.

API használat

API használat beállítási oldal

Általános

Beállítás

Leírás

Alapértelmezés

API Javadoc címkék nem támogatott használata

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrizni fogja az API Javadoc címkék helytelen használatát.

Figyelmen kívül hagyás

A hivatkozás nincs meghatározva a megadott végrehajtási környezetben

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi a rendszerfüggvénytárakra mutató hivatkozásokat, melyek a köteg számára megadottvégrehajtási környezetben érvénytelenek lehetnek.

Figyelmen kívül hagyás

Korlátozások

Option

Leírás

Alapértelmezés

'@noimplement' címkével megjelölt felület megvalósítása

Ha engedélyezve van, akkor az API elemzéskészítő megkeresi a megjelölt felületek illegális megvalósításait.

Figyelmeztetés

'@noextend' címkével megjelölt típus kiterjesztése

Ha engedélyezve van, akkor az API elemzéskészítő megkeresi a megjelölt típusokat kiterjesztő osztályokat.

Figyelmeztetés

Hivatkozás '@noreference' címkével megjelölt mezőre vagy metódusra

Ha engedélyezve van, akkor az API elemzéskészítő megkeresi a megjelölt tagokra hivatkozó mezőket vagy metódusokat.

Figyelmeztetés

'@noinstantiate' címkével ellátott osztály példányosítása

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrizni fogja, hogy a címkével megjelölt osztályok nincsenek-e példányosítva.

Figyelmeztetés

'@nooverride' címkével megjelölt metódus újradefiniálása

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrizni fogja, hogy a szülőosztály címkével megjelölt metódusai nincsenek-e újradefiniálva bármely utód osztályban, akár kiterjesztéssel (ismételt megvalósítás az újradefiniált szülő hívásával) vagy ismételt megvalósítással (az újradefiniált szülő hívása nélkül).

Figyelmeztetés

Szivárgások

Option

Leírás

Alapértelmezés

Nem API osztályt terjeszt ki

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy bármely API osztály kiterjeszt-e nem API típusokat.

Figyelmeztetés

Nem API felület megvalósítása

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy bármely API osztály megvalósít-e nem API felületet.

Figyelmeztetés

Nem API típusú mező

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy bármely API típusnak vannak-e nem API típusú nyilvános (public) vagy védett (protected) mezői.

Figyelmeztetés

Nem API visszatérési típussal rendelkező metódus

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy bármely API típusnak vannak-e nem API visszatérési típussal rendelkező nyilvános (public) vagy védett (protected) metódusai.

Figyelmeztetés

Nem API paraméterrel rendelkező metódus

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy bármely API típusnak vannak-e nem API paramétertípussal rendelkező nyilvános (public) vagy védett (protected) metódusai.

Figyelmeztetés

API kompatibilitás

API kompatibilitás beállításai oldal

Option

Leírás

Alapértelmezés

API törés jelentése akkor is, ha főverziószám növelése engedélyezi

Ha engedélyezve van, akkor az API elemzéskészítő API törés problémákat jelent akkor is, ha a köteg főverziószáma már növelve lett.

Letiltva

Köteg

Option

Leírás

Alapértelmezés

Egy API típus nem API típussá változott

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy az aktuális kötegben lévő API típusok közül bármelyik módosult-e nem API típusra.

Hiba

Egy típus el lett távolítva

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy bármely API típus el lett-e távolítva az adott köteg API hatóköréből.

Hiba

Egy újraexportált API típus nem API típussá változott

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy az aktuális kötegben lévő újraexportált API típusok közül bármelyik módosult-e nem API típusra.

Hiba

Egy újraexportált típus el lett távolítva

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy bármely újraexportált API típus el lett-e távolítva az adott köteg API hatóköréből.

Hiba

Osztály

Option

Leírás

Alapértelmezés

Hozzá lett adva egy (megvalósítandó) metódus:

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy bármely API típushoz hozzá lett-e adva bármilyen megvalósítandó nyilvános vagy védett metódus.

Hiba

Korlátozások lettek hozzáadva

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy bármely API osztályhoz lettek-e hozzáadva API korlátozások.

Hiba

Hozzá lett adva egy típus paraméter

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lettek-e hozzáadva típus paraméterek bármely API osztályhoz.

Hiba

A szülőfelületek hierarchia csökkentve lett

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lettek-e eltávolítva szülőfelületek bármely API osztályból.

Hiba

Az 'abstract' kulcsszó hozzáadásra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy hozzá lett-e adva az 'abstract' kulcsszó bármely API osztályhoz.

Hiba

A 'final' kulcsszó hozzáadásra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy hozzá lett-e adva a 'final' kulcsszó bármely API osztályhoz.

Hiba

Átalakítva annotációra, felsorolásra vagy felületre

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy bármely API osztály át lett-e alakítva annotációra, felsorolásra vagy felületre.

Hiba

A láthatóság csökkentve lett

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy bármely nyilvános (public) API osztály át lett-e alakítva privát vagy alapértelmezett hatókörű osztállyá.

Hiba

A mező eltávolításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lettek-e eltávolítva nyilvános (public) vagy védett (protected) mezők bármely API osztályból.

Hiba

A metódus eltávolításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lettek-e eltávolítva nyilvános (public) vagy védett (protected) metódusok bármely API osztályból.

Hiba

A konstruktor eltávolításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lettek-e eltávolítva nyilvános (public) vagy védett (protected) konstruktorok bármely API osztályból.

Hiba

A szülőosztály hierarchia csökkentve lett

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy a hierarchiából eltávolításra került-e bármely ősosztály.

Hiba

Egy tagtípus el lett távolítva

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy bármely API osztályból eltávolításra kerültek-e tagtípusok.

Hiba

Típus paraméter eltávolításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lettek-e eltávolítva típus paraméterek bármely API osztályból.

Hiba

Felület

Option

Leírás

Alapértelmezés

Mező (nem '@noimplement' címkével jelölt felület) hozzáadásra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lettek-e hozzáadva nyilvános mezők bármely API felülethez.

Hiba

Metódus (nem '@noimplement' címkével jelölt felület) hozzáadásra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lettek-e hozzáadva nyilvános metódusok bármely API felülethez.

Hiba

Korlátozások lettek hozzáadva

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy hozzá lettek-e adva a korlátozások bármely API felülethez.

Hiba

Hozzá lett adva egy típus paraméter

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lettek-e hozzáadva típus paraméterek bármely API felülethez.

Hiba

Átalakítva osztállyá, felsorolássá vagy annotációvá

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy bármely API felület át lett-e alakítva osztállyá, felsorolássá vagy annotációvá.

Hiba

A szülőfelületek hierarchia csökkentve lett

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy bármely szülőfelület el lett-e távolítva bármely API felületből.

Hiba

Típus paraméter eltávolításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lettek-e eltávolítva típus paraméterek bármely API felületből.

Hiba

A mező eltávolításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lettek-e eltávolítva nyilvános mezők bármely API felületből.

Hiba

A metódus eltávolításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lettek-e eltávolítva nyilvános metódusok bármely API felületből.

Hiba

Egy tagtípus el lett távolítva

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lettek-e eltávolítva típustagok bármely API felületből.

Hiba

Felsorolás

Option

Leírás

Alapértelmezés

A szülőfelületek hierarchia csökkentve lett

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lettek-e eltávolítva szülőfelületek bármely API felsorolásból.

Hiba

Átalakítva annotációra, osztályra vagy felületre

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy bármely API felsorolás át lett-e alakítva annotációra, osztályra vagy felületre.

Hiba

A mező eltávolításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lettek-e eltávolítva nyilvános mezők bármely API felsorolásból.

Hiba

A felsorolás konstans eltávolításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lettek-e eltávolítva felsorolás konstansok bármely API felsorolásból.

Hiba

A metódus eltávolításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lettek-e eltávolítva nyilvános metódusok bármely API felsorolásból.

Hiba

Egy tagtípus el lett távolítva

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lettek-e eltávolítva típustagok bármely API felsorolásból.

Hiba

Annotáció

Option

Leírás

Alapértelmezés

Alapértelmezett érték nélküli metódus hozzáadásra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lett-e hozzáadva új alapértelmezett érték nélküli metódus az API annotációkhoz.

Hiba

Átalakítva osztállyá, felsorolásra vagy felületre

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy bármely API annotáció át lett-e alakítva osztállyá, felsorolásra vagy felületre.

Hiba

A mező eltávolításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lettek-e eltávolítva nyilvános mezők bármely API annotációból.

Hiba

A metódus eltávolításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lettek-e eltávolítva nyilvános metódusok bármely API annotációból.

Hiba

Egy tagtípus el lett távolítva

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy bármely API annotációból eltávolításra kerültek-e nyilvános tagtípusok.

Hiba

Mező

Option

Leírás

Alapértelmezés

A konstans érték hozzáadásra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lett-e hozzáadva egy konstans érték bármely korábban nem inicializált nyilvános (public) vagy védett (protected) mezőkonstanshoz bármely API típusban.

Hiba

A típus módosításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy nyilvános (public) vagy védett (protected) mezők típusa módosítva lett-e bármely API típusban.

Hiba

A konstans érték módosításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy nyilvános (public) vagy védett (protected) mező konstans értéke módosítva lett-e bármely API típusban.

Hiba

A láthatóság csökkentve lett

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy van-e olyan nyilvános (public) vagy védett (protected) mező, amely privát (private) mezővé lett alakítva bármely API típusban.

Hiba

A 'final' kulcsszó eltávolításra került a statikus konstans esetén

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy van-e olyan nyilvános (public) vagy védett (protected) mező, amelyből el lett távolítva a 'final' kulcsszó bármely API típusban.

Hiba

A 'final' kulcsszó hozzáadásra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy hozzá lett-e adva a 'final' kulcsszó bármely nyilvános (public) vagy védett (protected) mezőhöz, bármely API típusban.

Hiba

A 'static' kulcsszó eltávolításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy a 'static' kulcsszó el lett-e távolítva bármely nyilvános (public) vagy védett (protected) mezőből, bármely API típusban.

Hiba

A 'static' kulcsszó hozzáadásra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy hozzá lett-e adva a 'static' kulcsszó bármely nyilvános (public) vagy védett (protected) mezőhöz, bármely API típusban.

Hiba

A konstans érték eltávolításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy egy konstans mező értéke el lett-e távolítva bármely nyilvános (public) vagy védett (protected) mező konstansból, bármely API típusban.

Hiba

Típus argumentum eltávolításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lett-e törölve típus argumentum bármely nyilvános (public) vagy védett (protected) mezőből, bármely API típusban.

Hiba

Metódus

Option

Leírás

Alapértelmezés

@nooverride korlátozás lett hozzáadva

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy bármely nyilvános vagy védett metódus korlátozásai módosultak-e bármely API típusban a @nooverride címke hozzáadásával.

Hiba

Hozzá lett adva egy típus paraméter

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy hozzá lett-e adva egy típus paraméter bármely nyilvános (public) vagy védett (protected) metódushoz, bármely API típusban.

Hiba

Változó argumentum átalakítva tömb típusra

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy egy varargs argumentum ki lett-e bővítve objektum tömbbé bármely nyilvános (public) vagy védett (protected) metódushoz, bármely API típusban.

Hiba

A láthatóság csökkentve lett

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy van-e olyan nyilvános (public) vagy védett (protected) metódus, amely privát (private) metódussá lett alakítva bármely API típusban.

Hiba

Az 'abstract' kulcsszó hozzáadásra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy van-e olyan nyilvános (public) vagy védett (protected) metódus, amely absztrakt (abstract) metódussá lett alakítva bármely API típusban.

Hiba

A 'static' kulcsszó hozzáadásra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy van-e olyan nyilvános (public) vagy védett (protected) metódus, amely statikussá (static) metódussá lett alakítva bármely API típusban.

Hiba

A 'static' kulcsszó eltávolításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy van-e olyan nyilvános (public) vagy védett (protected) metódus, amelyből a 'static' kulcsszó el lett távolítva bármely API típusban.

Hiba

A 'final' kulcsszó hozzáadásra került ('@noextend' címkével megjelölt típus)

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy van-e olyan nyilvános (public) vagy védett (protected) metódus, amely végleges (final) metódussá lett alakítva bármely API típusban.

Hiba

Az annotáció alapértelmezett értéke eltávolításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy az API annotáció metódusokhoz társított alapértelmezett értékek el lettek-e távolítva.

Hiba

Típus paraméter eltávolításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lett-e törölve típus paraméter bármely nyilvános (public) vagy védett (protected) metódusból, bármely API típusban.

Hiba

Konstruktor

Option

Leírás

Alapértelmezés

Hozzá lett adva egy típus paraméter

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy hozzá lett-e adva egy típus paraméter bármely API típus bármely nyilvános (public) konstruktorához.

Hiba

Változó argumentum átalakítva tömb típusra

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy vannak-e objektum tömbbé kibővített varargs paraméterek bármely API típus bármely nyilvános (public) konstruktorához.

Hiba

A láthatóság csökkentve lett

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy van-e olyan nyilvános (public) konstruktor bármely API típusban, amely nem nyilvánossá lett átalakítva.

Hiba

Típus paraméter eltávolításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lett-e eltávoltva típus paraméter bármely API típus bármely nyilvános (public) konstruktorából.

Hiba

Típus paraméter

Option

Leírás

Alapértelmezés

Osztálykötés hozzáadásra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lett-e hozzáadva osztálykötés bármely API típus bármely típus paraméteréhez.

Hiba

A felületkötés hozzáadásra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lett-e hozzáadva felületkötés bármely API típus bármely típus paraméteréhez.

Hiba

Az osztálykötés módosításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy módosultak-e osztálykötések bármely API típus bármely típus paramétere esetén.

Hiba

A felületkötés módosításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy módosultak-e felületkötések bármely API típus bármely típus paramétere esetén.

Hiba

Az osztálykötés eltávolításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lettek-e eltávolítva osztálykötések bármely API típus bármely típus paraméteréből.

Hiba

A felületkötés eltávolításra került

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy lettek-e eltávolítva felületkötések bármely API típus bármely típus paraméteréből.

Hiba

Verziókezelés

API verziókezelés beállítási oldal

Option

Leírás

Alapértelmezés

Hiányzó '@since' címkék jelentése

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy a használt API alapsor változat óta hozzáadott típusok vagy tagok között vannak-e olyanok, amelyekhez hiányzik a @since címke.

Hiba

Rosszul formázott '@since' címkék jelentése

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy a pillanatnyilag használatban lévő @since címkék között vannak-e rosszul formázottak (helytelen szintaxis).

Hiba

Érvénytelen '@since' címkeváltozat jelentése

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy a pillanatnyilag használatban lévő @since címkék bármelyikéhez rossz-e a verziószám.

Hiba

Inkompatibilis kötegváltozat jelentése

Ha engedélyezve van, akkor az API elemzéskészítő ellenőrzi, hogy a bedolgozó kötegváltozata helytelen-e bármely API módosítás és a jelenleg használt API alapsor alapján.

Hiba

API változásokat nem tartalmazó alverziószám növelés figyelmen kívül hagyása

Ha engedélyezve van az inkompatibilis verziószámok jelentése, akkor ezzel a beállítással lehet megadni az API elemzéskészítőnek, hogy hagyja figyelmen kívül az alverziószámok módosításait, ha nem volt API változás a jelenlegi API alapsorhoz képest.

Be

API módosítást nem okozó főverziószám növekedés figyelmen kívül hagyása

Ha engedélyezve van az inkompatibilis verziószámok jelentése, akkor ezzel a beállítással lehet megadni az API elemzéskészítőnek, hogy hagyja figyelmen kívül a főverziószámok módosításait, ha nem volt API változás a jelenlegi API alapsorhoz képest.

Be

Elemzési beállítások

Elemzési beállítások oldal

Option

Leírás

Alapértelmezés

A köteghez hiányzik a szükséges megszorítás/előfeltétel

Ha engedélyezve van, akkor az API elemzéskészítő jelent minden olyan hiányzó megszorítást vagy előfeltételt, amely megakadályozza a készítőt a teljes elemzés végrehajtásában. A beállítás értékétől függetlenül a megfelelő köteg elemzése ki lesz hagyva.

Hiba

Használaton kívüli API problémaszűrők

Ha engedélyezve van, akkor az API elemzéskészítő jelenteni fogja az összes már nem használt API probléma szűrőt.

Figyelmeztetés

API használati elemzések beállításai

API használati elemzések beállításai adatlap

Beállítás

Leírás

Alapértelmezés

Feloldatlan típus probléma

Ha engedélyezve van, az API elemzés összeépítő jelenti az olyan eltávolított API típusokat, amelyek az API használati elemzések beállítási oldalon felsorolt bármely használati elemzésben szerepelnek.

Hiba

Feloldatlan metódus probléma

Ha engedélyezve van, az API elemzés összeépítő jelenti az olyan eltávolított metódusokat, amelyek az API használati elemzések beállítási oldalon felsorolt bármely használati elemzésben szerepelnek.

Hiba

Feloldatlan mező probléma

Ha engedélyezve van, az API elemzés összeépítő jelenti az olyan eltávolított mezőket, amelyek az API használati elemzések beállítási oldalon felsorolt bármely használati elemzésben szerepelnek.

Hiba


Kapcsolódó leírások

PDE beállítások
API hibák és figyelmeztetések adatlap
API alapsorok beállításai
API használati elemzések beállításai