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