public class

Assume

extends Object
java.lang.Object
   ↳ org.junit.Assume

Class Overview

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. The default JUnit runner treats tests with failing assumptions as ignored. Custom runners may behave differently. For example:

 // only provides information if database is reachable.
 \@Test public void calculateTotalSalary() {
    DBConnection dbc = Database.connect();
    assumeNotNull(dbc);
    // ...
 }
 
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(...);
 

Summary

Public Constructors
Assume()
Public Methods
static void assumeNoException(Throwable t)
Use to assume that an operation completes normally.
static void assumeNotNull(Object... objects)
If called with one or more null elements in objects, the test will halt and be ignored.
static <T> void assumeThat(T actual, Matcher<T> matcher)
Call to assume that actual satisfies the condition specified by matcher.
static void assumeTrue(boolean b)
If called with an expression evaluating to false, the test will halt and be ignored.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Assume ()

Public Methods

public static void assumeNoException (Throwable t)

Use to assume that an operation completes normally. If t is non-null, the test will halt and be ignored. For example:

 \@Test public void parseDataFile() {
   DataFile file;
   try {
     file = DataFile.open("sampledata.txt");
   } catch (IOException e) {
     // stop test and ignore if data can't be opened
     assumeNoException(e);
   }
   // ...
 }
 

Parameters
t if non-null, the offending exception

public static void assumeNotNull (Object... objects)

If called with one or more null elements in objects, the test will halt and be ignored.

public static void assumeThat (T actual, Matcher<T> matcher)

Call to assume that actual satisfies the condition specified by matcher. If not, the test halts and is ignored. Example:

:
   assumeThat(1, is(1)); // passes
   foo(); // will execute
   assumeThat(0, is(1)); // assumption failure! test halts
   int x = 1 / 0; // will never execute
 

Parameters
actual the computed value being compared
matcher an expression, built of Matchers, specifying allowed values
See Also

public static void assumeTrue (boolean b)

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