From 6c6ac180d8d2fd749a59b7a4cb817111a80cc4ec Mon Sep 17 00:00:00 2001
From: Keith Donald <kdonald@vmware.com>
Date: Wed, 23 Apr 2008 13:05:53 +0000
Subject: [PATCH] javadoc

---
 .../webflow/mvc/servlet/FlowHandler.java             | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/spring-webflow/src/main/java/org/springframework/webflow/mvc/servlet/FlowHandler.java b/spring-webflow/src/main/java/org/springframework/webflow/mvc/servlet/FlowHandler.java
index 82911d9c..5182bd01 100644
--- a/spring-webflow/src/main/java/org/springframework/webflow/mvc/servlet/FlowHandler.java
+++ b/spring-webflow/src/main/java/org/springframework/webflow/mvc/servlet/FlowHandler.java
@@ -54,9 +54,15 @@ public interface FlowHandler {
 	 * Handles a specific flow execution outcome. Used by a Controller to get the location of the resource to redirect
 	 * to after the outcome is handled.
 	 * <p>
-	 * If the location string returned begins with a forward-slash, the location is treated as relative to the web
-	 * application context path. If the location string does not begin with a slash, the location is treated as relative
-	 * to the current servlet path.
+	 * The following prefixes are supported for qualifying the returned location string:
+	 * <ul>
+	 * <li>servletPath: - the location is relative to the current servlet
+	 * <li>contextPath: - the location is relative to the current web application</li>
+	 * <li>serverPath: - the location is relative to the current server, which may host several applications
+	 * <li>url: - the location is an absolute URI beginning with a scheme like "http://" If the location string
+	 * </ul>
+	 * Also, if the returned location no prefix, for example "/hotels/index", the location is treated as relative to the
+	 * current servlet by default.
 	 * 
 	 * @param outcome the outcome that was reached
 	 * @param request the current request