Author: julien(a)jboss.com Date: 2008-01-22 15:17:41 -0500 (Tue, 22 Jan 2008) New Revision: 9566 Modified: modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/unit/TestAction.java Log: Add javadoc to explain the purpose of the assertParameterMap method Modified: modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/unit/TestAction.java =================================================================== --- modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/unit/TestAction.java 2008-01-22 20:13:25 UTC (rev 9565) +++ modules/portlet/trunk/portlet/src/test/java/org/jboss/portal/unit/TestAction.java 2008-01-22 20:17:41 UTC (rev 9566) @@ -38,7 +38,24 @@ public abstract class TestAction { - public final void assertParameterMap(Map<String, String[]> expectedMap, PortletRequest request) + /** + * Check that the parameter map contains the value expected. The check is done with the different + * ways that the <code>PortletRequest</code> API provides: + * + * <ul> + * <li><code>PortletRequest.getParameter(String)</li> + * <li><code>PortletRequest.getParameterValues(String)</li> + * <li><code>PortletRequest.getParameterNames()</li> + * <li><code>PortletRequest.getParameterMap()</li> + * </ul> + * + * This method allows a full coverage of the API. + * + * @param expectedMap the expected map + * @param request the actual portlet request + * @throws AssertionError if the provided request does not match the expected map state + */ + public final void assertParameterMap(Map<String, String[]> expectedMap, PortletRequest request) throws AssertionError { assertNotNull(request);