/* * Copyright (c) 2011, 2013, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package com.sun.management; import javax.management.Notification; import javax.management.openmbean.CompositeData; import javax.management.openmbean.CompositeDataView; import javax.management.openmbean.CompositeType; import java.util.Collection; import java.util.Collections; import sun.management.GarbageCollectionNotifInfoCompositeData; /** * The information about a garbage collection * *
* A garbage collection notification is emitted by {@link GarbageCollectorMXBean}
* when the Java virtual machine completes a garbage collection action
* The notification emitted will contain the garbage collection notification
* information about the status of the memory:
*
* A {@link CompositeData CompositeData} representing * the {@code GarbageCollectionNotificationInfo} object * is stored in the * {@linkplain javax.management.Notification#setUserData userdata} * of a {@linkplain javax.management.Notification notification}. * The {@link #from from} method is provided to convert from * a {@code CompositeData} to a {@code GarbageCollectionNotificationInfo} * object. For example: * *
* ** Notification notif; * * // receive the notification emitted by a GarbageCollectorMXBean and set to notif * ... * * String notifType = notif.getType(); * if (notifType.equals(GarbageCollectionNotificationInfo.GARBAGE_COLLECTION_NOTIFICATION)) { * // retrieve the garbage collection notification information * CompositeData cd = (CompositeData) notif.getUserData(); * GarbageCollectionNotificationInfo info = GarbageCollectionNotificationInfo.from(cd); * .... * } *
* The type of the notification emitted by a {@code GarbageCollectorMXBean} is: *
** * @param cd {@code CompositeData} representing a * {@code GarbageCollectionNotificationInfo} * * @throws IllegalArgumentException if {@code cd} does not * represent a {@code GarbaageCollectionNotificationInfo} object. * * @return a {@code GarbageCollectionNotificationInfo} object represented * by {@code cd} if {@code cd} is not {@code null}; * {@code null} otherwise. */ public static GarbageCollectionNotificationInfo from(CompositeData cd) { if (cd == null) { return null; } if (cd instanceof GarbageCollectionNotifInfoCompositeData) { return ((GarbageCollectionNotifInfoCompositeData) cd).getGarbageCollectionNotifInfo(); } else { return new GarbageCollectionNotificationInfo(cd); } } public CompositeData toCompositeData(CompositeType ct) { return cdata; } }*
** *Attribute Name *Type ** *gcName *{@code java.lang.String} ** *gcAction *{@code java.lang.String} ** *gcCause *{@code java.lang.String} ** *gcInfo *{@code javax.management.openmbean.CompositeData} *