svn commit: r1095679 - /wicket/trunk/wicket-core/src/main/java/org/apache/wicket/request/mapper/ResourceMapper.java

[mg...@apache.org]

Author: mgrigorov
Date: Thu Apr 21 12:29:15 2011
New Revision: 1095679

URL: http://svn.apache.org/viewvc?rev=1095679&view=rev
Log:
Improve javadoc of ResourceMapper.


Modified:
    wicket/trunk/wicket-core/src/main/java/org/apache/wicket/request/mapper/ResourceMapper.java

Modified: wicket/trunk/wicket-core/src/main/java/org/apache/wicket/request/mapper/ResourceMapper.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket-core/src/main/java/org/apache/wicket/request/mapper/ResourceMapper.java?rev=1095679&r1=1095678&r2=1095679&view=diff
==============================================================================
--- wicket/trunk/wicket-core/src/main/java/org/apache/wicket/request/mapper/ResourceMapper.java (original)
+++ wicket/trunk/wicket-core/src/main/java/org/apache/wicket/request/mapper/ResourceMapper.java Thu Apr 21 12:29:15 2011
@@ -28,7 +28,7 @@ import org.apache.wicket.request.resourc
 import org.apache.wicket.util.lang.Args;
 
 /**
- * mapper to mount resources to a custom mount path
+ * A {@link IRequestMapper} to mount resources to a custom mount path
  * <ul>
  * <li>maps indexed parameters to path segments</li>
  * <li>maps named parameters to query string arguments or placeholder path segments</li>
@@ -37,7 +37,7 @@ import org.apache.wicket.util.lang.Args;
  * <strong>sample structure of url</strong>
  * 
  * <pre>
- *    /resources/${category}/images/[indexed-param-0]/[indexed-param-1]?[named-param-1=value]&[named-param-2=value2]
+ *    /myresources/${category}/images/[indexed-param-0]/[indexed-param-1]?[named-param-1=value]&[named-param-2=value2]
  * </pre>
  * 
  * <h4>sample usage</h4>
@@ -46,9 +46,12 @@ import org.apache.wicket.util.lang.Args;
  * <p/>
  * 
  * <pre>
- * getRootRequestMapperAsCompound().add(new ResourceMapper(&quot;/images&quot;, new ImagesResourceReference()));
+ * mountResource(&quot;/images&quot;, new ImagesResourceReference()));
  * </pre>
  * 
+ * Note: Mounted this way the resource reference has application scope, i.e. it is shared between
+ * all users of the application. It is recommended to not keep any state in it.
+ * 
  * @see org.apache.wicket.protocol.http.WebApplication#mountResource(String,
  *      org.apache.wicket.request.resource.ResourceReference)
  *