org.junit.runner.manipulation

Class Ordering

java.lang.Object

org.junit.runner.manipulation.Ordering

Direct Known Subclasses:

Sorter

public abstract class Ordering
extends java.lang.Object

Reorders tests. An Ordering can reverse the order of tests, sort the order or even shuffle the order.

In general you will not need to use a Ordering directly. Instead, use Request.orderWith(Ordering).

Since:

4.13

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Ordering.Context Context about the ordering being applied.
static interface	Ordering.Factory Factory for creating Ordering instances.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	CONSTRUCTOR_ERROR_FORMAT

Constructor Summary

Constructors

Constructor and Description
Ordering()

Method Summary

Modifier and Type	Method and Description
void	apply(java.lang.Object target) Order the tests in target using this ordering.
static Ordering	definedBy(java.lang.Class<? extends Ordering.Factory> factoryClass, Description annotatedTestClass) Creates an Ordering from the given factory class.
static Ordering	definedBy(Ordering.Factory factory, Description annotatedTestClass) Creates an Ordering from the given factory.
private static java.lang.String	getClassName(java.lang.Class<?> clazz)
protected abstract java.util.List<Description>	orderItems(java.util.Collection<Description> descriptions) Implemented by sub-classes to order the descriptions.
static Ordering	shuffledBy(java.util.Random random) Creates an Ordering that shuffles the items using the given Random instance.
(package private) boolean	validateOrderingIsCorrect() Returns true if this ordering could produce invalid results (i.e.

Methods inherited from class java.lang.Object

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

Field Detail

CONSTRUCTOR_ERROR_FORMAT

private static final java.lang.String CONSTRUCTOR_ERROR_FORMAT

See Also:

Constant Field Values

Constructor Detail

Ordering

public Ordering()

Method Detail

shuffledBy

public static Ordering shuffledBy(java.util.Random random)

Creates an Ordering that shuffles the items using the given Random instance.

definedBy

public static Ordering definedBy(java.lang.Class<? extends Ordering.Factory> factoryClass,
                                 Description annotatedTestClass)
                          throws InvalidOrderingException

Creates an Ordering from the given factory class. The class must have a public no-arg constructor.

Parameters:

factoryClass - class to use to create the ordering

annotatedTestClass - test class that is annotated with OrderWith.

Throws:

InvalidOrderingException - if the instance could not be created

definedBy

public static Ordering definedBy(Ordering.Factory factory,
                                 Description annotatedTestClass)
                          throws InvalidOrderingException

Creates an Ordering from the given factory.

Parameters:

factory - factory to use to create the ordering

annotatedTestClass - test class that is annotated with OrderWith.

Throws:

InvalidOrderingException - if the instance could not be created

getClassName

private static java.lang.String getClassName(java.lang.Class<?> clazz)

apply

public void apply(java.lang.Object target)
           throws InvalidOrderingException

Order the tests in target using this ordering.

Throws:

InvalidOrderingException - if ordering does something invalid (like remove or add children)

validateOrderingIsCorrect

boolean validateOrderingIsCorrect()

Returns true if this ordering could produce invalid results (i.e. if it could add or remove values).

orderItems

protected abstract java.util.List<Description> orderItems(java.util.Collection<Description> descriptions)

Implemented by sub-classes to order the descriptions.

Returns:

descriptions in order