microsoft/gctoolkit
Publicmirrored from https://github.com/microsoft/gctoolkitAvailable
api/src/main/java/module-info.java
46lines · modeblame
3ce8e8bbKirk Pepperdine4 years ago | 1 | // Copyright (c) Microsoft Corporation. |
| 2 | // Licensed under the MIT License. | |
| 3 | | |
| 4 | /** | |
38a277aeDavid Grieve4 years ago | 5 | * Contains the core API for the Microsoft, Java Garbage Collection Toolkit. |
| 6 | * The toolkit is a GC log parser and a framework for consuming and extracting data from | |
| 7 | * GC log events. | |
| 8 | * <p> | |
| 9 | * The main entry points are: | |
| 10 | * <dl> | |
279969cckabutz4 years ago | 11 | * <dt>{@link com.microsoft.gctoolkit.GCToolKit}</dt> |
38a277aeDavid Grieve4 years ago | 12 | * <dd>This is the main API that an application will use.</dd> |
279969cckabutz4 years ago | 13 | * <dt>{@link com.microsoft.gctoolkit.io.GCLogFile}</dt> |
5509b357Kirk Pepperdine4 years ago | 14 | * <dd>A GCLogFile is passed to GCToolKit for analysis.</dd> |
279969cckabutz4 years ago | 15 | * <dt>{@link com.microsoft.gctoolkit.jvm.JavaVirtualMachine}</dt> |
38a277aeDavid Grieve4 years ago | 16 | * <dd>This contains the results from running an analysis on a GC log.</dd> |
279969cckabutz4 years ago | 17 | * <dt>{@link com.microsoft.gctoolkit.event.jvm.JVMEvent}</dt> |
38a277aeDavid Grieve4 years ago | 18 | * <dd>The parser generates JVMEvents.</dd> |
279969cckabutz4 years ago | 19 | * <dt>{@link com.microsoft.gctoolkit.aggregator.Aggregator}</dt> |
38a277aeDavid Grieve4 years ago | 20 | * <dd>An Aggregator captures JVMEvents for analysis.</dd> |
279969cckabutz4 years ago | 21 | * <dt>{@link com.microsoft.gctoolkit.aggregator.Aggregation}</dt> |
38a277aeDavid Grieve4 years ago | 22 | * <dd>An Aggregation works with an Aggregator to collect and analyze data from JVMEvents.</dd> |
| 23 | * </dl> | |
279969cckabutz4 years ago | 24 | * |
| 25 | * @uses com.microsoft.gctoolkit.jvm.JavaVirtualMachine | |
| 26 | * @uses com.microsoft.gctoolkit.aggregator.Aggregator | |
3ce8e8bbKirk Pepperdine4 years ago | 27 | */ |
8b6201adChristian Stein4 years ago | 28 | module com.microsoft.gctoolkit.api { |
d96119e6kabutz4 years ago | 29 | requires java.logging; |
3ce8e8bbKirk Pepperdine4 years ago | 30 | |
5509b357Kirk Pepperdine4 years ago | 31 | exports com.microsoft.gctoolkit; |
| 32 | exports com.microsoft.gctoolkit.aggregator; | |
| 33 | exports com.microsoft.gctoolkit.event; | |
| 34 | exports com.microsoft.gctoolkit.event.g1gc; | |
| 35 | exports com.microsoft.gctoolkit.event.generational; | |
| 36 | exports com.microsoft.gctoolkit.event.jvm; | |
| 37 | exports com.microsoft.gctoolkit.event.shenandoah; | |
| 38 | exports com.microsoft.gctoolkit.event.zgc; | |
| 39 | exports com.microsoft.gctoolkit.io; | |
| 40 | exports com.microsoft.gctoolkit.jvm; | |
| 41 | exports com.microsoft.gctoolkit.time; | |
3ce8e8bbKirk Pepperdine4 years ago | 42 | |
279969cckabutz4 years ago | 43 | uses com.microsoft.gctoolkit.aggregator.Aggregation; |
d96119e6kabutz4 years ago | 44 | uses com.microsoft.gctoolkit.jvm.JavaVirtualMachine; |
49a86dfbKirk Pepperdine4 years ago | 45 | uses com.microsoft.gctoolkit.jvm.Diarizer; |
3ce8e8bbKirk Pepperdine4 years ago | 46 | } |