1 /*
2  * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle in the LICENSE file that accompanied this code.
10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 
26 package com.sun.management;
27 import javax.management.openmbean.CompositeData;
28 import javax.management.openmbean.CompositeType;
29 
30 /**
31  * Platform-specific management interface for a garbage collector
32  * which performs collections in cycles.
33  *
34  * <p> This platform extension is only available to the garbage
35  * collection implementation that supports this extension.
36  *
37  * @author  Mandy Chung
38  * @since   1.5
39  */
40 public interface GarbageCollectorMXBean
41     extends java.lang.management.GarbageCollectorMXBean {
42 
43     /**
44      * Returns the GC information about the most recent GC.
45      * This method returns a {@link GcInfo}.
46      * If no GC information is available, {@code null} is returned.
47      * The collector-specific attributes, if any, can be obtained
48      * via the {@link CompositeData CompositeData} interface.
49      * <p>
50      * <b>MBeanServer access:</b>
51      * The mapped type of {@code GcInfo} is {@code CompositeData}
52      * with attributes specified in {@link GcInfo#from GcInfo}.
53      *
54      * @return a {@code GcInfo} object representing
55      * the most GC information; or {@code null} if no GC
56      * information available.
57      */
getLastGcInfo()58     public GcInfo getLastGcInfo();
59 }
60