org.junit

Class Assume

java.lang.Object

org.junit.Assume

public class Assume
extends Object

A set of methods useful for stating assumptions about the conditions in which a test is meaningful. A failed assumption does not mean the code is broken, but that the test provides no useful information. Assume basically means "don't run this test if these conditions don't apply". The default JUnit runner skips tests with failing assumptions. Custom runners may behave differently.

A good example of using assumptions is in Theories where they are needed to exclude certain datapoints that aren't suitable or allowed for a certain test case. Failed assumptions are usually not logged, because there may be many tests that don't apply to certain configurations.

These methods can be used directly: Assume.assumeTrue(...), however, they read better if they are referenced through static import:

 import static org.junit.Assume.*;
    ...
    assumeTrue(...);
 

Method Summary

Modifier and Type	Method and Description
static void	assumeFalse(boolean b) The inverse of assumeTrue(boolean).
static void	assumeFalse(String message, boolean b) The inverse of assumeTrue(String, boolean).
static void	assumeTrue(boolean b) If called with an expression evaluating to false, the test will halt and be ignored.
static void	assumeTrue(String message, boolean b) If called with an expression evaluating to false, the test will halt and be ignored.

Methods inherited from class java.lang.Object

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

Method Detail

assumeFalse

public static void assumeFalse(boolean b)

The inverse of assumeTrue(boolean).

assumeFalse

public static void assumeFalse(String message,
                               boolean b)

The inverse of assumeTrue(String, boolean).

assumeTrue

public static void assumeTrue(boolean b)

If called with an expression evaluating to false, the test will halt and be ignored.

Parameters:

b - If false, the method will attempt to stop the test and ignore it by throwing AssumptionViolatedException.

assumeTrue

public static void assumeTrue(String message,
                              boolean b)

If called with an expression evaluating to false, the test will halt and be ignored.

Parameters:

message - A message to pass to AssumptionViolatedException.

b - If false, the method will attempt to stop the test and ignore it by throwing AssumptionViolatedException.