[portal-commits] JBoss Portal SVN: r6197 - trunk/portlet/src/main/org/jboss/portal/portlet/impl.
Author: julien(a)jboss.com
Date: 2007-02-09 12:42:03 -0500 (Fri, 09 Feb 2007)
New Revision: 6197
Modified:
trunk/portlet/src/main/org/jboss/portal/portlet/impl/PortletRequestEncoder.java
Log:
javadoc for PortletRequestEncoder
Modified: trunk/portlet/src/main/org/jboss/portal/portlet/impl/PortletRequestEncoder.java
===================================================================
---
trunk/portlet/src/main/org/jboss/portal/portlet/impl/PortletRequestEncoder.java 2007-02-09
16:02:20 UTC (rev 6196)
+++
trunk/portlet/src/main/org/jboss/portal/portlet/impl/PortletRequestEncoder.java 2007-02-09
17:42:03 UTC (rev 6197)
@@ -36,6 +36,14 @@
import java.util.Map;
/**
+ * This class is designed to provide the encoding in the query string of a URL of the
following state :
+ * <ul>
+ * <li>A set of parameters</li>
+ * <li>A mode value</li>
+ * <li>A window state value</li>
+ * <li>A invocation type (action or render)</li>
+ * </ul>
+ *
* @author <a href="mailto:julien@jboss.org">Julien Viet</a>
* @version $Revision: 1.1 $
*/
@@ -61,7 +69,7 @@
this(new PortletParameters());
}
- public void encode(PortletURL portletURL)
+ public void encode(PortletURL portletURL) throws IllegalArgumentException
{
if (portletURL instanceof RenderURL)
{
@@ -83,7 +91,7 @@
StateString navigationalState,
StateString interactionState,
Mode mode,
- WindowState windowState)
+ WindowState windowState) throws IllegalArgumentException
{
queryParameters.clear();