Commits

Anonymous committed ecdccc2

Issue number: WW-1202
Obtained from:
Submitted by:
Reviewed by:

javadoc for PortletUrlHelper

git-svn-id: http://svn.opensymphony.com/svn/webwork/trunk@2520573baa09-0c28-0410-bef9-dab3c582ae83

Comments (0)

Files changed (1)

src/java/com/opensymphony/webwork/portlet/util/PortletUrlHelper.java

     private static final String AMP = "&";
 
     /**
-     *
-     * @param action
-     * @param namespace
-     * @param params
-     * @param type
-     * @param mode
-     * @param state
+     * Create a portlet URL with for the specified action and namespace.
+     * 
+     * @param action The action the URL should invoke.
+     * @param namespace The namespace of the action to invoke.
+     * @param params The parameters of the URL.
+     * @param type The type of the url, either <tt>action</tt> or <tt>render</tt>
+     * @param mode The PortletMode of the URL.
+     * @param state The WindowState of the URL.
      * @return The URL String.
      */
     public static String buildUrl(String action, String namespace, Map params,
                 true, true);
     }
 
+    /**
+     * Create a portlet URL with for the specified action and namespace. 
+     * 
+     * @see #buildUrl(String, String, Map, String, String, String)
+     */
     public static String buildUrl(String action, String namespace, Map params,
             String scheme, String type, String portletMode, String windowState,
             boolean includeContext, boolean encodeResult) {
     }
 
     /**
-     * @param namespace
-     * @return prepended namespace
+     * 
+     * Prepend the namespace configuration for the specified namespace and PortletMode.
+     * 
+     * @param namespace The base namespace.
+     * @param portletMode The PortletMode.
+     * 
+     * @return prepended namespace.
      */
     private static String prependNamespace(String namespace, String portletMode) {
         StringBuffer sb = new StringBuffer();
     }
 
     /**
-     * @param portletReq
-     * @param windowState
+     * Convert the given String to a WindowState object.
+     * 
+     * @param portletReq The RenderRequest.
+     * @param windowState The WindowState as a String.
+     * @return The WindowState that mathces the <tt>windowState</tt> String, or if
+     * the Sring is blank, the current WindowState.
      */
     private static WindowState getWindowState(RenderRequest portletReq,
             String windowState) {
     }
 
     /**
-     * @param portletReq
-     * @param portletMode
+     * Convert the given String to a PortletMode object.
+     * 
+     * @param portletReq The RenderRequest.
+     * @param portletMode The PortletMode as a String.
+     * @return The PortletMode that mathces the <tt>portletMode</tt> String, or if
+     * the Sring is blank, the current PortletMode.
      */
     private static PortletMode getPortletMode(RenderRequest portletReq,
             String portletMode) {