Apache/struts
1
0
Fork 0
mirror of https://github.com/apache/struts.git synced 2026-08-11 01:27:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated URL component's default value documentation to reflect WW-2901 change; now "none".

Browse Source 
I don't think I like this lack of cohesion in cases like this; if the default value is coming from a default configuration file then documenting it manually with @StrutsTagAttribute seems dangerous and potentially misleading.

git-svn-id: https://svn.apache.org/repos/asf/struts/struts2/trunk@722331 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
David Newton
2008-12-02 02:04:42 +00:00
parent 157eacdecd
commit 4bc9f8f62d
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
core/src/main/java/org/apache/struts2/components/URL.java
+7 -7
View File
@@ -46,17 +46,17 @@ import com.opensymphony.xwork2.util.logging.LoggerFactory;
* <p>This tag is used to create a URL.</p>
*
* <p>You can use the &lt;param&gt; tag inside the body to provide
* additional request parameters. If the value of a param is an Array or
* additional request parameters. If the value of a param is an Array or
* an Iterable all the values will be added to the URL.</p>
*
* <b>NOTE:</b>
* <p>By default request parameters will be separated using escaped ampersands (i.e., &amp;amp;).
* This is necessary for XHTML compliance, however, when using the URL generated by this tag
* with the &lt;s:property&gt; tag, the <b>escapeAmp</b> attribute should be used to disable
* ampersand escaping.</p>
*
* ampersand escaping.</p>
*
* <b>NOTE:</b>
* <p>When includeParams is 'all' or 'get', the parameter defined in a &lt;param&gt;
* <p>When includeParams is 'all' or 'get', the parameter defined in a &lt;param&gt;
* tag will take precedence over any params included due to the includeParams attribute. For
* example, in Example 3 below, if there is a id parameter in the url where the page this
* tag is included like http://&lt;host&gt;:&lt;port&gt;/&lt;context&gt;/editUser.action?id=3333&name=John
@@ -163,7 +163,7 @@ public class URL extends ContextBean {
public void setUrlIncludeParams(String urlIncludeParams) {
this.urlIncludeParams = urlIncludeParams;
}
@Inject
public void setUrlRenderer(UrlRenderer urlRenderer) {
this.urlRenderer = urlRenderer;
@@ -185,7 +185,7 @@ public class URL extends ContextBean {
return super.end(writer, body);
}
@StrutsTagAttribute(description="The includeParams attribute may have the value 'none', 'get' or 'all'", defaultValue="get")
@StrutsTagAttribute(description="The includeParams attribute may have the value 'none', 'get' or 'all'", defaultValue="none")
public void setIncludeParams(String includeParams) {
this.includeParams = includeParams;
}
@@ -244,7 +244,7 @@ public class URL extends ContextBean {
public void setAnchor(String anchor) {
this.anchor = anchor;
}
@StrutsTagAttribute(description="Specifies whether to escape ampersand (&amp;) to (&amp;amp;) or not", type="Boolean", defaultValue="true")
public void setEscapeAmp(boolean escapeAmp) {
this.escapeAmp = escapeAmp;