jdk/src/java.management/share/classes/com/sun/management/GarbageCollectionNotificationInfo.java
changeset 28059 e576535359cc
parent 25859 3317bb8137f4
child 30042 4728ebcf8fd0
equal deleted inserted replaced
28058:87940c838900 28059:e576535359cc
    40  * A garbage collection notification is emitted by {@link GarbageCollectorMXBean}
    40  * A garbage collection notification is emitted by {@link GarbageCollectorMXBean}
    41  * when the Java virtual machine completes a garbage collection action
    41  * when the Java virtual machine completes a garbage collection action
    42  * The notification emitted will contain the garbage collection notification
    42  * The notification emitted will contain the garbage collection notification
    43  * information about the status of the memory:
    43  * information about the status of the memory:
    44  * <u1>
    44  * <u1>
    45  *   <li>The name of the garbage collector used perform the collection.</li>
    45  *   <li>The name of the garbage collector used to perform the collection.</li>
    46  *   <li>The action performed by the garbage collector.</li>
    46  *   <li>The action performed by the garbage collector.</li>
    47  *   <li>The cause of the garbage collection action.</li>
    47  *   <li>The cause of the garbage collection action.</li>
    48  *   <li>A {@link GcInfo} object containing some statistics about the GC cycle
    48  *   <li>A {@link GcInfo} object containing some statistics about the GC cycle
    49           (start time, end time) and the memory usage before and after
    49           (start time, end time) and the memory usage before and after
    50           the GC cycle.</li>
    50           the GC cycle.</li>
   107     /**
   107     /**
   108      * Constructs a {@code GarbageCollectionNotificationInfo} object.
   108      * Constructs a {@code GarbageCollectionNotificationInfo} object.
   109      *
   109      *
   110      * @param gcName The name of the garbage collector used to perform the collection
   110      * @param gcName The name of the garbage collector used to perform the collection
   111      * @param gcAction The name of the action performed by the garbage collector
   111      * @param gcAction The name of the action performed by the garbage collector
   112      * @param gcCause The cause the garbage collection action
   112      * @param gcCause The cause of the garbage collection action
   113      * @param gcInfo  a GcInfo object providing statistics about the GC cycle
   113      * @param gcInfo  a GcInfo object providing statistics about the GC cycle
   114      */
   114      */
   115     public GarbageCollectionNotificationInfo(String gcName,
   115     public GarbageCollectionNotificationInfo(String gcName,
   116                                              String gcAction,
   116                                              String gcAction,
   117                                              String gcCause,
   117                                              String gcCause,
   150     public String getGcName() {
   150     public String getGcName() {
   151         return gcName;
   151         return gcName;
   152     }
   152     }
   153 
   153 
   154     /**
   154     /**
   155      * Returns the action of the performed by the garbage collector
   155      * Returns the action performed by the garbage collector
   156      *
   156      *
   157      * @return the the action of the performed by the garbage collector
   157      * @return the action performed by the garbage collector
   158      */
   158      */
   159     public String getGcAction() {
   159     public String getGcAction() {
   160         return gcAction;
   160         return gcAction;
   161     }
   161     }
   162 
   162 
   163     /**
   163     /**
   164      * Returns the cause  the garbage collection
   164      * Returns the cause of the garbage collection
   165      *
   165      *
   166      * @return the the cause  the garbage collection
   166      * @return the cause of the garbage collection
   167      */
   167      */
   168     public String getGcCause() {
   168     public String getGcCause() {
   169         return gcCause;
   169         return gcCause;
   170     }
   170     }
   171 
   171