Module com.microsoft.gctoolkit.api

Package com.microsoft.gctoolkit.aggregator

Enum EventSource

java.lang.Object

java.lang.Enum<EventSource>

com.microsoft.gctoolkit.aggregator.EventSource

All Implemented Interfaces:

Serializable, Comparable<EventSource>

public enum EventSource
extends Enum<EventSource>

EventSource indicates to the source of the GC events that an Aggregator is meant to process.

See Also:

Aggregates

Enum Constant Summary

Enum Constants

Enum Constant	Description
CMS_PREUNIFIED	Deprecated, for removal: This API element is subject to removal in a future version. use the GENERATIONAL event source instead.
CMS_UNIFIED
G1GC	Events come from the G1 collector.
GENERATIONAL	Event come from CMS, Parallel or Serial collectors.
JVM	Events that come from all sources
SAFEPOINT	Events come from the safe points in the GC log, or from a separate safepoint log.
SHENANDOAH	Events come from the Shenandoah collector.
SURVIVOR	Events come from the survivor space.
TENURED	Events come from the tenured space.
ZGC	Events come from the ZGC collector.

Method Summary

Modifier and Type	Method	Description
ChannelName	toChannel()
static EventSource	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EventSource[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GENERATIONAL

public static final EventSource GENERATIONAL

Event come from CMS, Parallel or Serial collectors.

CMS_UNIFIED

public static final EventSource CMS_UNIFIED

CMS_PREUNIFIED

@Deprecated(since="3.0.8",
            forRemoval=true)
public static final EventSource CMS_PREUNIFIED

Deprecated, for removal: This API element is subject to removal in a future version.

use the GENERATIONAL event source instead.

Events that come from the CMS collection cycles

G1GC

public static final EventSource G1GC

Events come from the G1 collector.

SHENANDOAH

public static final EventSource SHENANDOAH

Events come from the Shenandoah collector.

ZGC

public static final EventSource ZGC

Events come from the ZGC collector.

SAFEPOINT

public static final EventSource SAFEPOINT

Events come from the safe points in the GC log, or from a separate safepoint log.

SURVIVOR

public static final EventSource SURVIVOR

Events come from the survivor space.

TENURED

public static final EventSource TENURED

Events come from the tenured space.

JVM

public static final EventSource JVM

Events that come from all sources

Method Detail

values

public static EventSource[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (EventSource c : EventSource.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EventSource valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toChannel

public ChannelName toChannel()