com.carrotsearch.randomizedtesting.rules

Class StaticFieldsInvariantRule

java.lang.Object

com.carrotsearch.randomizedtesting.rules.StaticFieldsInvariantRule

All Implemented Interfaces:

org.junit.rules.TestRule

public class StaticFieldsInvariantRule
extends java.lang.Object
implements org.junit.rules.TestRule

A TestRule that ensures static, reference fields of the suite class (and optionally its superclasses) are cleaned up after a suite is completed. This is helpful in finding out static memory leaks (a class references something huge but is no longer used).

See Also:

ClassRule, accept(Field)

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_LEAK_THRESHOLD

Constructor Summary

Constructors

Constructor and Description
StaticFieldsInvariantRule() By default use DEFAULT_LEAK_THRESHOLD as the threshold and count in superclasses.
StaticFieldsInvariantRule(long leakThresholdBytes, boolean countSuperclasses)

Method Summary

Modifier and Type	Method and Description
protected boolean	accept(java.lang.reflect.Field field)
org.junit.runners.model.Statement	apply(org.junit.runners.model.Statement s, org.junit.runner.Description d)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LEAK_THRESHOLD

public static final long DEFAULT_LEAK_THRESHOLD

See Also:

Constant Field Values

Constructor Detail

StaticFieldsInvariantRule

public StaticFieldsInvariantRule()

By default use DEFAULT_LEAK_THRESHOLD as the threshold and count in superclasses.

StaticFieldsInvariantRule

public StaticFieldsInvariantRule(long leakThresholdBytes,
                                 boolean countSuperclasses)

Method Detail

apply

public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement s,
                                               org.junit.runner.Description d)

Specified by:

apply in interface org.junit.rules.TestRule

accept

protected boolean accept(java.lang.reflect.Field field)

Returns:

Return false to exclude a given field from being counted. By default final fields are rejected.