public abstract class

ModelAndViewAssert

extends Object
java.lang.Object
   ↳ org.springframework.test.web.ModelAndViewAssert

Class Overview

A collection of assertions intended to simplify testing scenarios dealing with Spring Web MVC ModelAndView objects.

Intended for use with JUnit 4 and TestNG. All assert*() methods throw AssertionErrors.

See Also

Summary

Public Constructors
ModelAndViewAssert()
Public Methods
static <T> T assertAndReturnModelAttributeOfType(ModelAndView mav, String modelName, Class<T> expectedType)
Checks whether the model value under the given modelName exists and checks it type, based on the expectedType.
static void assertCompareListModelAttribute(ModelAndView mav, String modelName, List expectedList)
Compare each individual entry in a list, without first sorting the lists.
static void assertModelAttributeAvailable(ModelAndView mav, String modelName)
Assert whether or not a model attribute is available.
static void assertModelAttributeValue(ModelAndView mav, String modelName, Object expectedValue)
Compare a given expectedValue to the value from the model bound under the given modelName.
static void assertModelAttributeValues(ModelAndView mav, Map<StringObject> expectedModel)
Inspect the expectedModel to see if all elements in the model appear and are equal.
static void assertSortAndCompareListModelAttribute(ModelAndView mav, String modelName, List expectedList, Comparator comparator)
Compare each individual entry in a list after having sorted both lists (optionally using a comparator).
static void assertViewName(ModelAndView mav, String expectedName)
Check to see if the view name in the ModelAndView matches the given expectedName.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ModelAndViewAssert ()

Public Methods

public static T assertAndReturnModelAttributeOfType (ModelAndView mav, String modelName, Class<T> expectedType)

Checks whether the model value under the given modelName exists and checks it type, based on the expectedType. If the model entry exists and the type matches, the model value is returned.

Parameters
mav ModelAndView to test against (never null)
modelName name of the object to add to the model (never null)
expectedType expected type of the model value
Returns
  • the model value

public static void assertCompareListModelAttribute (ModelAndView mav, String modelName, List expectedList)

Compare each individual entry in a list, without first sorting the lists.

Parameters
mav ModelAndView to test against (never null)
modelName name of the object to add to the model (never null)
expectedList the expected list

public static void assertModelAttributeAvailable (ModelAndView mav, String modelName)

Assert whether or not a model attribute is available.

Parameters
mav ModelAndView to test against (never null)
modelName name of the object to add to the model (never null)

public static void assertModelAttributeValue (ModelAndView mav, String modelName, Object expectedValue)

Compare a given expectedValue to the value from the model bound under the given modelName.

Parameters
mav ModelAndView to test against (never null)
modelName name of the object to add to the model (never null)
expectedValue the model value

public static void assertModelAttributeValues (ModelAndView mav, Map<StringObject> expectedModel)

Inspect the expectedModel to see if all elements in the model appear and are equal.

Parameters
mav ModelAndView to test against (never null)
expectedModel the expected model

public static void assertSortAndCompareListModelAttribute (ModelAndView mav, String modelName, List expectedList, Comparator comparator)

Compare each individual entry in a list after having sorted both lists (optionally using a comparator).

Parameters
mav ModelAndView to test against (never null)
modelName name of the object to add to the model (never null)
expectedList the expected list
comparator the comparator to use (may be null). If not specifying the comparator, both lists will be sorted not using any comparator.

public static void assertViewName (ModelAndView mav, String expectedName)

Check to see if the view name in the ModelAndView matches the given expectedName.

Parameters
mav ModelAndView to test against (never null)
expectedName the name of the model value