Package org.junit.runner.manipulation
Class Ordering
java.lang.Object
org.junit.runner.manipulation.Ordering
- Direct Known Subclasses:
Sorter
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 ClassesModifier and TypeClassDescriptionstatic classContext about the ordering being applied.static interfaceFactory for creatingOrderinginstances. -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidOrder the tests intargetusing this ordering.static OrderingdefinedBy(Class<? extends Ordering.Factory> factoryClass, Description annotatedTestClass) Creates anOrderingfrom the given factory class.static OrderingdefinedBy(Ordering.Factory factory, Description annotatedTestClass) Creates anOrderingfrom the given factory.private static StringgetClassName(Class<?> clazz) protected abstract List<Description> orderItems(Collection<Description> descriptions) Implemented by sub-classes to order the descriptions.static OrderingshuffledBy(Random random) (package private) booleanReturnstrueif this ordering could produce invalid results (i.e.
-
Field Details
-
CONSTRUCTOR_ERROR_FORMAT
- See Also:
-
-
Constructor Details
-
Ordering
public Ordering()
-
-
Method Details
-
shuffledBy
-
definedBy
public static Ordering definedBy(Class<? extends Ordering.Factory> factoryClass, Description annotatedTestClass) throws InvalidOrderingException Creates anOrderingfrom the given factory class. The class must have a public no-arg constructor.- Parameters:
factoryClass- class to use to create the orderingannotatedTestClass- test class that is annotated withOrderWith.- Throws:
InvalidOrderingException- if the instance could not be created
-
definedBy
public static Ordering definedBy(Ordering.Factory factory, Description annotatedTestClass) throws InvalidOrderingException Creates anOrderingfrom the given factory.- Parameters:
factory- factory to use to create the orderingannotatedTestClass- test class that is annotated withOrderWith.- Throws:
InvalidOrderingException- if the instance could not be created
-
getClassName
-
apply
Order the tests intargetusing this ordering.- Throws:
InvalidOrderingException- if ordering does something invalid (like remove or add children)
-
validateOrderingIsCorrect
boolean validateOrderingIsCorrect()Returnstrueif this ordering could produce invalid results (i.e. if it could add or remove values). -
orderItems
Implemented by sub-classes to order the descriptions.- Returns:
- descriptions in order
-