net.openhft.chronicle.testframework

Enum GcControls

java.lang.Object

java.lang.Enum<GcControls>

net.openhft.chronicle.testframework.GcControls

All Implemented Interfaces:

Serializable, Comparable<GcControls>

public enum GcControls
extends Enum<GcControls>

Provides utility methods for interacting with garbage collection (GC) within the JVM.

These utilities are used to request and wait for garbage collection cycles. Please note that relying on explicit garbage collection is inherently unreliable, and these methods should be used with caution.

Method Summary

Modifier and Type	Method and Description
static long	getGcCount() Retrieves the total count of garbage collection (GC) cycles that have occurred.
static void	requestGcCycle() Requests a garbage collection (GC) cycle to be performed.
static GcControls	valueOf(String name) Returns the enum constant of this type with the specified name.
static GcControls[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static void	waitForGcCycle() Requests a garbage collection (GC) cycle and blocks until it occurs or a timeout is reached.

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

Method Detail

values

public static GcControls[] 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 (GcControls c : GcControls.values())
    System.out.println(c);

Returns:

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

valueOf

public static GcControls 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

requestGcCycle

public static void requestGcCycle()

Requests a garbage collection (GC) cycle to be performed.

This method is a hint to the JVM, and there's no guarantee the GC will actually be performed.

waitForGcCycle

public static void waitForGcCycle()

Requests a garbage collection (GC) cycle and blocks until it occurs or a timeout is reached.

This method waits for up to one second for a GC cycle to occur. If the GC does not occur within this time, an IllegalStateException is thrown.

Throws:

IllegalStateException - if the GC doesn't occur within one second

getGcCount

public static long getGcCount()

Retrieves the total count of garbage collection (GC) cycles that have occurred.

This method returns the sum of collection counts for all types of garbage collectors within the JVM.

Returns:

The number of GCs of all types that have occurred