[gatein-commits] gatein SVN: r4636 - portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/controller/router.

Author: julien_viet Date: 2010-10-12 06:11:29 -0400 (Tue, 12 Oct 2010) New Revision: 4636 Modified: portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/controller/router/RenderContext.java portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/controller/router/Router.java Log: javadoc Modified: portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/controller/router/RenderContext.java =================================================================== --- portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/controller/router/RenderContext.java 2010-10-12 10:06:09 UTC (rev 4635) +++ portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/controller/router/RenderContext.java 2010-10-12 10:11:29 UTC (rev 4636) @@ -20,16 +20,37 @@ package org.exoplatform.web.controller.router; /** + * The render context provides callback when URL generation is performed by the {@link Router#render(java.util.Map)} + * method. + * * @author <a href="mailto:julien.viet@exoplatform.com">Julien Viet</a> * @version $Revision$ */ public interface RenderContext { - void appendPath(char s); + /** + * Append a char to the path. + * + * @param c the char to append + */ + void appendPath(char c); + /** + * Append a string to the path. + * + * @param s the string to append. + */ void appendPath(String s); + /** + * Append a query parameter to the parameter set. Note that the query parameters are ordered + * and the sequence of call to this method should be honoured when an URL is generated. Note also that + * the same parameter name can be used multiple times. + * + * @param parameterName the parameter name + * @param paramaterValue the parameter value + */ void appendQueryParameter(String parameterName, String paramaterValue); } Modified: portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/controller/router/Router.java =================================================================== --- portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/controller/router/Router.java 2010-10-12 10:06:09 UTC (rev 4635) +++ portal/branches/navcontroller/component/web/controller/src/main/java/org/exoplatform/web/controller/router/Router.java 2010-10-12 10:11:29 UTC (rev 4636) @@ -28,6 +28,8 @@ import java.util.Map; /** + * The router takes care of mapping a request to a a map. + * * @author <a href="mailto:julien.viet@exoplatform.com">Julien Viet</a> * @version $Revision$ */