Класс GarbageCollectionNotificationInfo

java.lang.Object

com.sun.management.GarbageCollectionNotificationInfo

Все реализованные интерфейсы:: CompositeDataView

public class GarbageCollectionNotificationInfo extends Object implements CompositeDataView

Информация о сборе мусора

Уведомление о сборе мусора генерируется GarbageCollectorMXBean после завершения действия по сбору мусора в виртуальной машине Java. Уведомление будет содержать информацию о статусе памяти:

Имя сборщика мусора, использовавшегося для выполнения сбора.
Действие, выполненное сборщиком мусора.
Причина действия по сбору мусора.
Объект GcInfo, содержащий некоторые статистические данные о цикле GC (время начала, время окончания) и использование памяти до и после цикла GC.

CompositeData, представляющий объект GarbageCollectionNotificationInfo, хранится в userdata уведомления уведомления. Метод from предназначен для преобразования из CompositeData в объект GarbageCollectionNotificationInfo. Например:

      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);
          ....
      }

Тип уведомления, генерируемого GarbageCollectorMXBean:

Уведомление о сборе мусора
Используется каждым уведомлением, генерируемым сборщиком мусора. Подробности уведомления указаны в строке action

Краткое описание полей

Модификатор и тип	Поле	Описание
`static final String`	`GARBAGE_COLLECTION_NOTIFICATION`	Тип уведомления, обозначающий, что виртуальная машина Java завершила цикл сбора мусора.

Краткое описание конструкторов

Конструктор	Описание
`GarbageCollectionNotificationInfo(String gcName, String gcAction, String gcCause, GcInfo gcInfo)`	Создает объект `GarbageCollectionNotificationInfo`.

Краткое описание методов

Модификатор и тип	Метод	Описание
`static GarbageCollectionNotificationInfo`	`from(CompositeData cd)`	Возвращает объект `GarbageCollectionNotificationInfo`, представленный заданным `CompositeData`.
`String`	`getGcAction()`	Возвращает действие, выполненное сборщиком мусора
`String`	`getGcCause()`	Возвращает причину сбора мусора
`GcInfo`	`getGcInfo()`	Возвращает информацию о GC, относящуюся к последнему сбору мусора
`String`	`getGcName()`	Возвращает имя сборщика мусора, использовавшегося для выполнения сбора
`CompositeData`	`toCompositeData(CompositeType ct)`	Возвращает `CompositeData` соответствующее значениям в этом объекте.

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание полей

GARBAGE_COLLECTION_NOTIFICATION

public static final String GARBAGE_COLLECTION_NOTIFICATION

Тип уведомления, обозначающий, что виртуальная машина Java завершила цикл сбора мусора. Это уведомление генерируется GarbageCollectorMXBean. Значение этого типа уведомления равно com.sun.management.gc.notification.

См. также:

Подробное описание конструкторов

GarbageCollectionNotificationInfo

public GarbageCollectionNotificationInfo(String gcName, String gcAction, String gcCause, GcInfo gcInfo)

Создает объект GarbageCollectionNotificationInfo.

Параметры:: gcName - Имя сборщика мусора, использовавшегося для выполнения сбора; gcAction - Название действия, выполненного сборщиком мусора; gcCause - Причина действия по сбору мусора; gcInfo - Объект GcInfo, предоставляющий статистику о цикле GC

Подробное описание методов

getGcName

public String getGcName()

Возвращает имя сборщика мусора, использовавшегося для выполнения сбора

Возвращает:: имя сборщика мусора, использовавшегося для выполнения сбора

getGcAction

public String getGcAction()

Возвращает действие, выполненное сборщиком мусора

Возвращает:: действие, выполненное сборщиком мусора

getGcCause

public String getGcCause()

Возвращает причину сбора мусора

Возвращает:: причину сбора мусора

getGcInfo

public GcInfo getGcInfo()

Возвращает информацию о GC, относящуюся к последнему сбору мусора

Возвращает:: информацию о GC, относящуюся к последнему сбору мусора

from

public static GarbageCollectionNotificationInfo from(CompositeData cd)

Возвращает объект GarbageCollectionNotificationInfo, представленный заданным CompositeData. Заданный CompositeData должен содержать следующие атрибуты:

description

Имя атрибута Тип

gcName java.lang.String

gcAction java.lang.String

gcCause java.lang.String

gcInfo javax.management.openmbean.CompositeData

description
Имя атрибута	Тип
gcName	`java.lang.String`
gcAction	`java.lang.String`
gcCause	`java.lang.String`
gcInfo	`javax.management.openmbean.CompositeData`

Параметры:: cd - CompositeData представляющий GarbageCollectionNotificationInfo
Возвращает:: объект GarbageCollectionNotificationInfo , представленный cd если cd не null; null в противном случае.
Исключения:: IllegalArgumentException - если cd не представляет объект GarbaageCollectionNotificationInfo.

toCompositeData

public CompositeData toCompositeData(CompositeType ct)

Описание скопировано из интерфейса: CompositeDataView

Возвращает CompositeData, соответствующее значениям в этом объекте. Возвращаемое значение обычно должно быть экземпляром CompositeDataSupport или класса, сериализуемого как CompositeDataSupport с помощью метода writeReplace. В противном случае удаленный клиент, получивший объект, может не смочь его восстановить.

Определено в:: toCompositeData в интерфейсе CompositeDataView
Параметры:: ct - Ожидаемый CompositeType возвращаемого значения. Если возвращаемое значение является cd, тогда cd.getCompositeType().equals(ct) должно быть true. Обычно это происходит потому, что cd является CompositeDataSupport, построенным с ct в качестве его CompositeType.
Возвращает:: значение CompositeData.

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html