En API-användningsrapport beskriver referenser från en paketuppsättning till en annan paketuppsättning. A report can be generated using the Ant-uppgiften API Use. Det finns ett användargränssnitt för konfigurering och generering av rapporter i dialogrutan Externa verktyg. Du dubbelklickar helt enkelt på konfigurationstypen API-användningsrapport när du vill skapa en ny konfiguration för användningssökning.
På fliken API-användningsrapport konfigurerar du analysen.
Följande exempel visar en konfiguration som extraherar alla referenser till Eclipse-paketen i en 3.4-installation.

| Alternativ |
Beskrivning |
Standard |
|---|---|---|
| Analysera | Du kan välja vad som ska analyseras. Det kan vara en API-basnivå, en måldefinition eller paketkatalog. Du kan också välja att enbart generera HTML för en befintlig rapport. Du kan bara välja att konfigurera ett alternativ. Exempel: Få till inställningssidan för API-basnivå och redigera befintliga basnivåer om du väljer att analysera en API-basnivå. | API-basnivå |
| Analysera > API-basnivå | Välj en API-basnivå att analysera från kombinationsrutan | Standardbasnivå eller tom |
| Analysera > Basnivåer | Ger åtkomst till inställningssidan API-basnivåer där du konfigurerar basnivån som ska analyseras. | |
| Analysera > Måldefinition | Du kan välja valfri måldefinition från kombinationsrutan för analys | Den aktiva måldefinitionen eller tomt |
| Analysera > Mål | Ger åtkomst till inställningssidan Målplattform där du konfigurerar måldefinitionen som ska analyseras. | |
| Analysera > Katalog | Ange den absoluta sökvägen till en katalog som innehåller paketen. | tomt |
| Analysera > Bläddra | Bläddra efter en mapp med paket att analysera. | |
| Analysera > Generera HTML-rapport för befintlig användningssökning | Skapa en rapport för en befintlig sökning så att du inte behöver utföra analysen igen. | |
| Sök efter > Referenser till | Ange namnet (eller matchande RegEx) för det paket som du vill se referenser för.
Exempel: org\.eclipse.*. Exemplet anger att vi vill se alla referenser till paket som börjar med namnet org.eclipse.. |
tomt |
| Sök efter > API-referenser | Sök efter API-referenser. | avmarkerat |
| Sök efter > Interna referenser | Sök efter interna referenser. | markerat |
| Sök efter > Ogiltig API-användning | Sök efter ogiltig API-användning, dvs. användning av begränsade API-medlemmar. | avmarkerat |
| Sök i > Paketmatchning | Ange namnet (eller matchande RegEx) för de paket som du vill söka efter referenser från, dvs. ett sökomfång.
Exempel: .*. Exemplet anger att vi vill söka i all paket vars namn matchar valfri teckensekvens.
Effekten blir densamma om vi lämnar fältet tomt. |
tomt |
| Rapportering > Rapporttyp | Gör det möjligt att välja mellan två HTML-rapportformat. Om Referenspaketrapport (producenter) väljs som rapport listas alla paket som innehåller de typer som refereras till i de genomsökta paketen. Om Referenspaketrapport (konsumenter) väljs som rapport listas alla paket i sökomfånget som innehåller referenser.
När du växlar mellan rapporttyperna ska du se till att de reguljära uttrycken Referenser till och Paktmatchning har korrekta värden. Om du använder ett jokerteckenuttryck som .* i en inställning, kräver ofta bytet till en annan rapporttyp att jokertecknet flyttas till den andra inställningen för att få de mest användbara rapporten. |
Referenspaketrapport (producenter) |
| Rapportering > Rapportutdataplats | Ange den absoluta sökvägen där generade rapporter ska placeras. | tomt |
| Rapportering > Bläddra | Bläddra och välj utdataplats för rapporter. | |
| Rapportering > Rensa rapportkatalog innan nya resultat rapporteras | Rensar befintlig XML-rapportplats innan nya sökningsresultat rapporteras. Tänk på att alternativet tömmer hela den angivna rapportkatalogen plus eventuella underordnade kataloger. | avmarkerat |
| Rapportering > Skapa HTML-rapporter | Konverterar alla XML-utdata till formaterad HTML och placerar resultatet på <rapportplats>\html |
avmarkerat |
| Rapportering > Rensa HTML-rapportplats | Rensar befintlig XML-rapportplats innan nya rapporter skapas. Tänk på att alternativet tömmer hela den angivna HTML-katalogen plus eventuella underordnade kataloger. Alternativet är tillgängligt om du valt alternativet Skapa HTML-rapporter. | avmarkerat |
| Rapportering > Öppna rapport när sökningen är klar | Öppnar HTML-rapporten när analysen är klar. Alternativet är tillgängligt om du valt alternativet Skapa HTML-rapporter. | avmarkerat |
| Rapportering > Beskrivning | Ange en beskrivning i klartext för rapporten. | tomt |
På fliken Mönster kan du skapa en rad olika mönster för reguljära uttryck som styr användningsanalysen. Det finns för närvarande tre olika slags mönster:

| Alternativ |
Beskrivning |
Standard |
|---|---|---|
| Lägg till | Du kan lägga till ett nytt mönster. Knappen startar guiden Mönster. | |
| Redigera | Du kan redigera det valda mönstret. Endast ett mönster kan redigeras åt gången. | |
| Ta bort | Du kan ta bort de valda mönstren. Du kan ta bort mer än ett mönster åt gången. |

Jämföra med en API-basnivå
Konfigurera en basnivå

Inställningar för API-basnivåer
Guiden API-användningsmönster