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>

Some utilities to try and reliably execute GCs.

Note this is inherently unreliable for a number of reasons so shouldn't be expected to work.

Method Summary

Modifier and Type	Method and Description
static long	getGcCount() Get the GC count
static void	requestGcCycle() Request a GC
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() Request a GC and block until it occurs

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()

Request a GC

waitForGcCycle

public static void waitForGcCycle()

Request a GC and block until it occurs

Throws:

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

getGcCount

public static long getGcCount()

Get the GC count

Returns:

The number of GCs of all types that have occurred