de.saxsys.mvvmfx.testingutils

Class GCVerifier

java.lang.Object

de.saxsys.mvvmfx.testingutils.GCVerifier

public class GCVerifier
extends Object

This is a small testing helper to verify that a given object is available for Garbage Collection. The typical usage is:

 Object testObject = new Object();
 
 GCVerifier verifier = GCVerifier.create(testObject);
 
 
 testObject = null;  // now there is no reference to the object anymore so it should be available for GC
 
 
 verifier.verify();  // this will throw an AssertionError if there is still a reference to the object somewhere
 

Method Summary

Modifier and Type	Method and Description
static GCVerifier	create(Object instance) Create a Verifier instance for the given Object.
static void	forceGC() This method can be used to "force" the garbage collection.
void	verify()
void	verify(String message)

Methods inherited from class java.lang.Object

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

Method Detail

create

public static GCVerifier create(Object instance)

Create a Verifier instance for the given Object. No hard reference to this object is stored internally.

Parameters:

instance - the instance that is verified.

Returns:

an instance of the GCVerifier that can be used to verify the garbage collection of the given instance.

verify

public void verify(String message)

verify

public void verify()

forceGC

public static void forceGC()

This method can be used to "force" the garbage collection. This can be useful because with "System.gc()" you can't tell if the GC was actually done. This method will only return when the GC was done. Be careful: This method will block until the GC was done so when for some reason the java runtime doesn't run the GC your application won't continue.