http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/interceptor/CheckboxInterceptor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/CheckboxInterceptor.java b/core/src/main/java/org/apache/struts2/interceptor/CheckboxInterceptor.java index 8fd638b..bad1c25 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/CheckboxInterceptor.java +++ b/core/src/main/java/org/apache/struts2/interceptor/CheckboxInterceptor.java @@ -33,19 +33,21 @@ import java.util.Set; /** * <!-- START SNIPPET: description --> + * <p> * Looks for a hidden identification field that specifies the original value of the checkbox. * If the checkbox isn't submitted, insert it into the parameters as if it was with the value * of 'false'. + * </p> * <!-- END SNIPPET: description --> - * <p/> + * * <!-- START SNIPPET: parameters --> - * <ul><li>setUncheckedValue - - * The default value of an unchecked box can be overridden by setting the 'uncheckedValue' property. - * </li></ul> + * <ul> + * <li>setUncheckedValue - The default value of an unchecked box can be overridden by setting the 'uncheckedValue' property.</li> + * </ul> * <!-- END SNIPPET: parameters --> - * <p/> + * * <!-- START SNIPPET: extending --> - * <p/> + * * <!-- END SNIPPET: extending --> */ public class CheckboxInterceptor extends AbstractInterceptor {
http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/interceptor/ClearSessionInterceptor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/ClearSessionInterceptor.java b/core/src/main/java/org/apache/struts2/interceptor/ClearSessionInterceptor.java index aa4f3e5..9bf7699 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/ClearSessionInterceptor.java +++ b/core/src/main/java/org/apache/struts2/interceptor/ClearSessionInterceptor.java @@ -31,19 +31,18 @@ import java.util.Map; /** * <!-- START SNIPPET: description --> - * + * <p> * This interceptor clears the HttpSession. - * <p/> + * </p> * * <!-- END SNIPPET: description --> * - * <p/> <u>Interceptor parameters:</u> - * + * <p><u>Interceptor parameters:</u></p> * * <!-- START SNIPPET: extending --> * * <ul> - * <li>none</li> + * <li>None</li> * </ul> * * <!-- END SNIPPET: extending --> @@ -52,14 +51,12 @@ import java.util.Map; * <!-- START SNIPPET: parameters --> * * <ul> - * * <li>None</li> - * * </ul> * * <!-- END SNIPPET: parameters --> * - * <b>Example:</b> + * <p><b>Example:</b></p> * * <pre> * <!-- START SNIPPET: example --> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/interceptor/CookieInterceptor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/CookieInterceptor.java b/core/src/main/java/org/apache/struts2/interceptor/CookieInterceptor.java index c25180b..771ed63 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/CookieInterceptor.java +++ b/core/src/main/java/org/apache/struts2/interceptor/CookieInterceptor.java @@ -42,25 +42,37 @@ import java.util.Set; /** * <!-- START SNIPPET: description --> * - * The aim of this intercepter is to set values in the stack/action based on cookie name/value - * of interest. <p/> + * <p> + * The aim of this interceptor is to set values in the stack/action based on cookie name/value + * of interest. + * </p> * + * <p> * If an asterisk is present in cookiesName parameter, it will be assume that * all cookies name are to be injected into struts' action, even though - * cookiesName is comma-separated by other values, e.g. (cookie1,*,cookie2). <p/> + * cookiesName is comma-separated by other values, e.g. (cookie1,*,cookie2). + * </p> * + * <p> * If cookiesName is left empty it will assume that no cookie will be injected - * into Struts' action. <p/> + * into Struts' action. + * </p> * + * <p> * If an asterisk is present in cookiesValue parameter, it will assume that all * cookies name irrespective of its value will be injected into Struts' action so - * long as the cookie name matches those specified in cookiesName parameter.<p/> + * long as the cookie name matches those specified in cookiesName parameter. + * </p> * + * <p> * If cookiesValue is left empty it will assume that all cookie that match the cookieName - * parameter will be injected into Struts' action.<p/> + * parameter will be injected into Struts' action. + * </p> * + * <p> * The action could implement {@link CookiesAware} in order to have a {@link Map} - * of filtered cookies set into it. <p/> + * of filtered cookies set into it. + * </p> * * <!-- END SNIPPET: description --> * http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/interceptor/CreateSessionInterceptor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/CreateSessionInterceptor.java b/core/src/main/java/org/apache/struts2/interceptor/CreateSessionInterceptor.java index 6f604d0..8bdbc4e 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/CreateSessionInterceptor.java +++ b/core/src/main/java/org/apache/struts2/interceptor/CreateSessionInterceptor.java @@ -33,21 +33,24 @@ import javax.servlet.http.HttpSession; /** * <!-- START SNIPPET: description --> * + * <p> * This interceptor creates the HttpSession if it doesn't exist, also SessionMap is recreated and put in ServletActionContext. - * <p/> + * </p> + * + * <p> * This is particular useful when using the <@s.token> tag in freemarker templates. * The tag <b>do</b> require that a HttpSession is already created since freemarker commits * the response to the client immediately. - * + * </p> * <!-- END SNIPPET: description --> * - * <p/> <u>Interceptor parameters:</u> + * <p><u>Interceptor parameters:</u></p> * * * <!-- START SNIPPET: extending --> * * <ul> - * <li>none</li> + * <li>None</li> * </ul> * * <!-- END SNIPPET: extending --> @@ -56,14 +59,12 @@ import javax.servlet.http.HttpSession; * <!-- START SNIPPET: parameters --> * * <ul> - * * <li>None</li> - * * </ul> * * <!-- END SNIPPET: parameters --> * - * <b>Example:</b> + * <p><b>Example:</b></p> * * <pre> * <!-- START SNIPPET: example --> @@ -76,8 +77,6 @@ import javax.servlet.http.HttpSession; * * <!-- END SNIPPET: example --> * </pre> - * - * @version $Date$ $Id$ */ public class CreateSessionInterceptor extends AbstractInterceptor { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/interceptor/ExecuteAndWaitInterceptor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/ExecuteAndWaitInterceptor.java b/core/src/main/java/org/apache/struts2/interceptor/ExecuteAndWaitInterceptor.java index 8b107ee..5add14a 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/ExecuteAndWaitInterceptor.java +++ b/core/src/main/java/org/apache/struts2/interceptor/ExecuteAndWaitInterceptor.java @@ -40,47 +40,54 @@ import java.util.Map; /** * <!-- START SNIPPET: description --> - * + * <p> * The ExecuteAndWaitInterceptor is great for running long-lived actions in the background while showing the user a nice * progress meter. This also prevents the HTTP request from timing out when the action takes more than 5 or 10 minutes. + * </p> * - * <p/> Using this interceptor is pretty straight forward. Assuming that you are including struts-default.xml, this + * <p> Using this interceptor is pretty straight forward. Assuming that you are including struts-default.xml, this * interceptor is already configured but is not part of any of the default stacks. Because of the nature of this * interceptor, it must be the <b>last</b> interceptor in the stack. + * </p> * - * <p/> This interceptor works on a per-session basis. That means that the same action name (myLongRunningAction, in the + * <p> This interceptor works on a per-session basis. That means that the same action name (myLongRunningAction, in the * above example) cannot be run more than once at a time in a given session. On the initial request or any subsequent * requests (before the action has completed), the <b>wait</b> result will be returned. <b>The wait result is * responsible for issuing a subsequent request back to the action, giving the effect of a self-updating progress * meter</b>. + * </p> * - * <p/> If no "wait" result is found, Struts will automatically generate a wait result on the fly. This result is + * <p> If no "wait" result is found, Struts will automatically generate a wait result on the fly. This result is * written in FreeMarker and cannot run unless FreeMarker is installed. If you don't wish to deploy with FreeMarker, you * must provide your own wait result. This is generally a good thing to do anyway, as the default wait page is very * plain. + * </p> * - * <p/>Whenever the wait result is returned, the <b>action that is currently running in the background will be placed on + * <p>Whenever the wait result is returned, the <b>action that is currently running in the background will be placed on * top of the stack</b>. This allows you to display progress data, such as a count, in the wait page. By making the wait * page automatically reload the request to the action (which will be short-circuited by the interceptor), you can give * the appearance of an automatic progress meter. + * </p> * - * <p/>This interceptor also supports using an initial wait delay. An initial delay is a time in milliseconds we let the + * <p>This interceptor also supports using an initial wait delay. An initial delay is a time in milliseconds we let the * server wait before the wait page is shown to the user. During the wait this interceptor will wake every 100 millis * to check if the background process is done premature, thus if the job for some reason doesn't take to long the wait * page is not shown to the user. * <br/> This is useful for e.g. search actions that have a wide span of execution time. Using a delay time of 2000 * millis we ensure the user is presented fast search results immediately and for the slow results a wait page is used. + * </p> * - * <p/><b>Important</b>: Because the action will be running in a seperate thread, you can't use ActionContext because it + * <p><b>Important</b>: Because the action will be running in a separate thread, you can't use ActionContext because it * is a ThreadLocal. This means if you need to access, for example, session data, you need to implement SessionAware * rather than calling ActionContext.getSession(). + * </p> * - * <p/>The thread kicked off by this interceptor will be named in the form <b><u>actionName</u>BackgroundProcess</b>. + * <p>The thread kicked off by this interceptor will be named in the form <b><u>actionName</u>BackgroundProcess</b>. * For example, the <i>search</i> action would run as a thread named <i>searchBackgroundProcess</i>. - * + * </p> * <!-- END SNIPPET: description --> * - * <p/> <u>Interceptor parameters:</u> + * <p><u>Interceptor parameters:</u></p> * * <!-- START SNIPPET: parameters --> * @@ -94,20 +101,18 @@ import java.util.Map; * * <!-- END SNIPPET: parameters --> * - * <p/> <u>Extending the interceptor:</u> - * - * <p/> + * <p><u>Extending the interceptor:</u></p> * * <!-- START SNIPPET: extending --> - * + * <p> * If you wish to make special preparations before and/or after the invocation of the background thread, you can extend * the BackgroundProcess class and implement the beforeInvocation() and afterInvocation() methods. This may be useful * for obtaining and releasing resources that the background process will need to execute successfully. To use your * background process extension, extend ExecuteAndWaitInterceptor and implement the getNewBackgroundProcess() method. - * + * </p> * <!-- END SNIPPET: extending --> * - * <p/> <u>Example code:</u> + * <p><u>Example code:</u></p> * * <pre> * <!-- START SNIPPET: example --> @@ -131,9 +136,11 @@ import java.util.Map; * </html> * </pre> * - * <p/> <u>Example code2:</u> + * <p><u>Example code2:</u></p> + * <p> * This example will wait 2 second (2000 millis) before the wait page is shown to the user. Therefore * if the long process didn't last long anyway the user isn't shown a wait page. + * </p> * * <pre> * <action name="someAction" class="com.examples.SomeAction"> @@ -146,10 +153,12 @@ import java.util.Map; * </action> * </pre> * - * <p/> <u>Example code3:</u> + * <p><u>Example code3:</u></p> + * <p> * This example will wait 1 second (1000 millis) before the wait page is shown to the user. * And at every 50 millis this interceptor will check if the background process is done, if so * it will return before the 1 second has elapsed, and the user isn't shown a wait page. + * </p> * * <pre> * <action name="someAction" class="com.examples.SomeAction"> @@ -303,13 +312,17 @@ public class ExecuteAndWaitInterceptor extends MethodFilterInterceptor { } /** + * <p> * Performs the initial delay. - * <p/> + * </p> + * + * <p> * When this interceptor is executed for the first time this methods handles any provided initial delay. * An initial delay is a time in milliseconds we let the server wait before we continue. * <br/> During the wait this interceptor will wake every 100 millis to check if the background * process is done premature, thus if the job for some reason doesn't take to long the wait * page is not shown to the user. + * </p> * * @param bp the background process * @throws InterruptedException is thrown by Thread.sleep http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/interceptor/FileUploadInterceptor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/FileUploadInterceptor.java b/core/src/main/java/org/apache/struts2/interceptor/FileUploadInterceptor.java index 5e12df0..644203a 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/FileUploadInterceptor.java +++ b/core/src/main/java/org/apache/struts2/interceptor/FileUploadInterceptor.java @@ -40,79 +40,81 @@ import java.util.*; /** * <!-- START SNIPPET: description --> - * <p/> + * <p> * Interceptor that is based off of {@link MultiPartRequestWrapper}, which is automatically applied for any request that * includes a file. It adds the following parameters, where [File Name] is the name given to the file uploaded by the * HTML form: - * <p/> + * </p> * <ul> - * <p/> + * * <li>[File Name] : File - the actual File</li> - * <p/> + * * <li>[File Name]ContentType : String - the content type of the file</li> - * <p/> + * * <li>[File Name]FileName : String - the actual name of the file uploaded (not the HTML name)</li> - * <p/> + * * </ul> - * <p/> - * <p/> You can get access to these files by merely providing setters in your action that correspond to any of the three + * + * <p>You can get access to these files by merely providing setters in your action that correspond to any of the three * patterns above, such as setDocument(File document), setDocumentContentType(String contentType), etc. * <br/>See the example code section. - * <p/> - * <p/> This interceptor will add several field errors, assuming that the action implements {@link ValidationAware}. + * </p> + * + * <p> This interceptor will add several field errors, assuming that the action implements {@link ValidationAware}. * These error messages are based on several i18n values stored in struts-messages.properties, a default i18n file * processed for all i18n requests. You can override the text of these messages by providing text for the following * keys: - * <p/> + * </p> + * * <ul> - * <p/> + * * <li>struts.messages.error.uploading - a general error that occurs when the file could not be uploaded</li> - * <p/> + * * <li>struts.messages.error.file.too.large - occurs when the uploaded file is too large</li> - * <p/> + * * <li>struts.messages.error.content.type.not.allowed - occurs when the uploaded file does not match the expected * content types specified</li> - * <p/> + * * <li>struts.messages.error.file.extension.not.allowed - occurs when the uploaded file does not match the expected * file extensions specified</li> - * <p/> + * * </ul> - * <p/> + * * <!-- END SNIPPET: description --> - * <p/> - * <p/> <u>Interceptor parameters:</u> - * <p/> + * + * <p><u>Interceptor parameters:</u></p> + * * <!-- START SNIPPET: parameters --> - * <p/> + * * <ul> - * <p/> + * * <li>maximumSize (optional) - the maximum size (in bytes) that the interceptor will allow a file reference to be set * on the action. Note, this is <b>not</b> related to the various properties found in struts.properties. * Default to approximately 2MB.</li> - * <p/> + * * <li>allowedTypes (optional) - a comma separated list of content types (ie: text/html) that the interceptor will allow * a file reference to be set on the action. If none is specified allow all types to be uploaded.</li> - * <p/> + * * <li>allowedExtensions (optional) - a comma separated list of file extensions (ie: .html) that the interceptor will allow * a file reference to be set on the action. If none is specified allow all extensions to be uploaded.</li> * </ul> - * <p/> - * <p/> + * + * * <!-- END SNIPPET: parameters --> - * <p/> - * <p/> <u>Extending the interceptor:</u> - * <p/> - * <p/> - * <p/> + * + * <p><u>Extending the interceptor:</u></p> + * + * + * * <!-- START SNIPPET: extending --> - * <p/> + * <p> * You can extend this interceptor and override the acceptFile method to provide more control over which files * are supported and which are not. - * <p/> + * </p> * <!-- END SNIPPET: extending --> - * <p/> - * <p/> <u>Example code:</u> - * <p/> + * + * <p><u>Example code:</u></p> + * * <pre> * <!-- START SNIPPET: example-configuration --> * <action name="doUpload" class="com.example.UploadAction"> @@ -122,13 +124,13 @@ import java.util.*; * </action> * <!-- END SNIPPET: example-configuration --> * </pre> - * <p/> + * * <!-- START SNIPPET: multipart-note --> - * <p/> + * <p> * You must set the encoding to <code>multipart/form-data</code> in the form where the user selects the file to upload. - * <p/> + * </p> * <!-- END SNIPPET: multipart-note --> - * <p/> + * * <pre> * <!-- START SNIPPET: example-form --> * <s:form action="doUpload" method="post" enctype="multipart/form-data"> @@ -137,10 +139,11 @@ import java.util.*; * </s:form> * <!-- END SNIPPET: example-form --> * </pre> - * <p/> + * <p> * And then in your action code you'll have access to the File object if you provide setters according to the * naming convention documented in the start. - * <p/> + * </p> + * * <pre> * <!-- START SNIPPET: example-action --> * package com.example; http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/interceptor/I18nInterceptor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/I18nInterceptor.java b/core/src/main/java/org/apache/struts2/interceptor/I18nInterceptor.java index 2112401..d250a8f 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/I18nInterceptor.java +++ b/core/src/main/java/org/apache/struts2/interceptor/I18nInterceptor.java @@ -32,29 +32,31 @@ import java.util.Map; /** * <!-- START SNIPPET: description --> + * <p> * This interceptor extends the original xwork i18n interceptor * and adds functionality to support cookies. + * </p> * * <!-- END SNIPPET: description --> * * <!-- START SNIPPET: parameters --> - * <p/> + * * <ul> - * <p/> + * * <li>parameterName (optional) - the name of the HTTP request parameter that dictates the locale to switch to and save * in the session. By default this is <b>request_locale</b></li> - * <p/> + * * <li>requestCookieParameterName (optional) - the name of the HTTP request parameter that dictates the locale to switch to * and save in a cookien. By default this is <b>request_cookie_locale</b></li> - * <p/> + * * <li>requestOnlyParameterName (optional) - the name of the HTTP request parameter that dictates the locale to switch to * for the current request only, without saving it in the session. By default this is <b>request_only_locale</b></li> - * <p/> + * * <li>attributeName (optional) - the name of the session key to store the selected locale. By default this is * <b>WW_TRANS_I18N_LOCALE</b></li> - * <p/> + * * </ul> - * <p/> + * * <!-- END SNIPPET: parameters --> * * <!-- START SNIPPET: example --> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/interceptor/MessageStoreInterceptor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/MessageStoreInterceptor.java b/core/src/main/java/org/apache/struts2/interceptor/MessageStoreInterceptor.java index f10cd48..a3f83db 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/MessageStoreInterceptor.java +++ b/core/src/main/java/org/apache/struts2/interceptor/MessageStoreInterceptor.java @@ -36,39 +36,42 @@ import java.util.Map; /** * <!-- START SNIPPET: description --> - * + * <p> * An interceptor to store a {@link ValidationAware} action's messages / errors and field errors into * HTTP Session, such that it will be retrievable at a later stage. This allows the action's message / * errors and field errors to be available longer that just the particular HTTP request. + * </p> * + * <p> * If no session exists, nothing will be stored and can be retrieved later. In other terms, * the application is responsible to open the session. + * </p> * - * <p/> - * + * <p> * In the 'STORE' mode, the interceptor will store the {@link ValidationAware} action's message / errors * and field errors into HTTP session. + * </p> * - * <p/> - * + * <p> * In the 'RETRIEVE' mode, the interceptor will retrieve the stored action's message / errors and field * errors and put them back into the {@link ValidationAware} action. - * - * <p/> + * </p> * + * <p> * In the 'AUTOMATIC' mode, the interceptor will always retrieve the stored action's message / errors * and field errors and put them back into the {@link ValidationAware} action, and after Action execution, * if the {@link com.opensymphony.xwork2.Result} is an instance of {@link ServletRedirectResult}, the action's message / errors * and field errors into automatically be stored in the HTTP session.. + * </p> * - * <p/> - * + * <p> * The interceptor does nothing in the 'NONE' mode, which is the default. + * </p> * - * <p/> - * - * The operation mode could be switched using :- <p/> - * 1] Setting the iterceptor parameter eg. + * <p> + * The operation mode could be switched using:<br> + * 1] Setting the interceptor parameter eg. + * </p> * <pre> * <action name="submitApplication" ...> * <interceptor-ref name="store"> @@ -79,7 +82,10 @@ import java.util.Map; * </action> * </pre> * + * <p> * 2] Through request parameter (allowRequestParameterSwitch must be 'true' which is the default) + * </p> + * * <pre> * // the request will have the operation mode in 'STORE' * http://localhost:8080/context/submitApplication.action?operationMode=STORE @@ -101,11 +107,12 @@ import java.util.Map; * * <!-- END SNIPPET: parameters --> * - * <p/> * * <!-- START SNIPPET: extending --> + * <p> + * The following method could be overridden: + * </p> * - * The following method could be overriden :- * <ul> * <li>getRequestOperationMode - get the operation mode of this interceptor based on the request parameters</li> * <li>mergeCollection - merge two collections</li> @@ -137,15 +144,13 @@ import java.util.Map; * </pre> * * <!-- START SNIPPET: exampleDescription --> - * + * <p> * With the example above, 'submitApplication.action' will have the action messages / errors / field errors stored * in the HTTP Session. Later when needed, (in this case, when 'applicationFailed.action' is fired, it * will get the action messages / errors / field errors stored in the HTTP Session and put them back into * the action. - * + * </p> * <!-- END SNIPPET: exampleDescription --> - * - * @version $Date$ $Id$ */ public class MessageStoreInterceptor extends AbstractInterceptor { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/interceptor/ParameterAware.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/ParameterAware.java b/core/src/main/java/org/apache/struts2/interceptor/ParameterAware.java index 6e53960..c440946 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/ParameterAware.java +++ b/core/src/main/java/org/apache/struts2/interceptor/ParameterAware.java @@ -25,15 +25,20 @@ import java.util.Map; /** + * <p> * This interface gives actions an alternative way of receiving input parameters. The map will - * contain all input parameters as name/value entries. Actions that need this should simply implement it. <p> - * <p/> + * contain all input parameters as name/value entries. Actions that need this should simply implement it. + * </p> + * + * <p> * One common use for this is to have the action propagate parameters to internally instantiated data - * objects. <p> - * <p/> + * objects. + * </p> + * + * <p> * Note that all parameter values for a given name will be returned, so the type of the objects in * the map is <tt>java.lang.String[]</tt>. - * + * </p> */ public interface ParameterAware { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/interceptor/RequestAware.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/RequestAware.java b/core/src/main/java/org/apache/struts2/interceptor/RequestAware.java index 666f891..2a13300 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/RequestAware.java +++ b/core/src/main/java/org/apache/struts2/interceptor/RequestAware.java @@ -24,9 +24,13 @@ package org.apache.struts2.interceptor; import java.util.Map; /** - * Actions that want access to the current serlvet request attributes should implement this interface.<p /> + * <p> + * Actions that want access to the current servlet request attributes should implement this interface. + * </p> * - * This interface is only relevant if the Action is used in a servlet environment.<p/> + * <p> + * This interface is only relevant if the Action is used in a servlet environment. + * </p> */ public interface RequestAware { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/interceptor/RolesInterceptor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/RolesInterceptor.java b/core/src/main/java/org/apache/struts2/interceptor/RolesInterceptor.java index a8fce67..6518b7c 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/RolesInterceptor.java +++ b/core/src/main/java/org/apache/struts2/interceptor/RolesInterceptor.java @@ -35,10 +35,12 @@ import java.util.List; /** * <!-- START SNIPPET: description --> + * <p> * This interceptor ensures that the action will only be executed if the user has the correct role. + * </p> * <!-- END SNIPPET: description --> * - * <p/> <u>Interceptor parameters:</u> + * <p><u>Interceptor parameters:</u></p> * * <!-- START SNIPPET: parameters --> * @@ -60,7 +62,10 @@ import java.util.List; * <!-- END SNIPPET: parameters --> * * <!-- START SNIPPET: extending --> + * <p> * There are three extensions to the existing interceptor: + * </p> + * * <ul> * <li>isAllowed(HttpServletRequest,Object) - whether or not to allow * the passed action execution with this request</li> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/interceptor/ScopeInterceptor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/ScopeInterceptor.java b/core/src/main/java/org/apache/struts2/interceptor/ScopeInterceptor.java index dfcd4d3..4ce9c15 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/ScopeInterceptor.java +++ b/core/src/main/java/org/apache/struts2/interceptor/ScopeInterceptor.java @@ -41,29 +41,33 @@ import java.util.Map; /** * <!-- START SNIPPET: description --> - * + * <p> * This is designed to solve a few simple issues related to wizard-like functionality in Struts. One of those issues is * that some applications have a application-wide parameters commonly used, such <i>pageLen</i> (used for records per * page). Rather than requiring that each action check if such parameters are supplied, this interceptor can look for * specified parameters and pull them out of the session. + * </p> * - * <p/> This works by setting listed properties at action start with values from session/application attributes keyed + * <p>This works by setting listed properties at action start with values from session/application attributes keyed * after the action's class, the action's name, or any supplied key. After action is executed all the listed properties * are taken back and put in session or application context. + * </p> * - * <p/> To make sure that each execution of the action is consistent it makes use of session-level locking. This way it + * <p>To make sure that each execution of the action is consistent it makes use of session-level locking. This way it * guarantees that each action execution is atomic at the session level. It doesn't guarantee application level * consistency however there has yet to be enough reasons to do so. Application level consistency would also be a big * performance overkill. + * </p> * - * <p/> Note that this interceptor takes a snapshot of action properties just before result is presented (using a {@link + * <p>Note that this interceptor takes a snapshot of action properties just before result is presented (using a {@link * PreResultListener}), rather than after action is invoked. There is a reason for that: At this moment we know that * action's state is "complete" as it's values may depend on the rest of the stack and specifically - on the values of * nested interceptors. + * </p> * * <!-- END SNIPPET: description --> * - * <p/> <u>Interceptor parameters:</u> + * <p><u>Interceptor parameters:</u></p> * * <!-- START SNIPPET: parameters --> * @@ -110,17 +114,15 @@ import java.util.Map; * * <!-- END SNIPPET: parameters --> * - * <p/> <u>Extending the interceptor:</u> - * - * <p/> + * <p><u>Extending the interceptor:</u></p> * * <!-- START SNIPPET: extending --> * - * There are no know extension points for this interceptor. + * <p>There are no know extension points for this interceptor.</p> * * <!-- END SNIPPET: extending --> * - * <p/> <u>Example code:</u> + * <p><u>Example code:</u></p> * * <pre> * <!-- START SNIPPET: example --> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/interceptor/ServletConfigInterceptor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/ServletConfigInterceptor.java b/core/src/main/java/org/apache/struts2/interceptor/ServletConfigInterceptor.java index 12f3cbf..3a3f132 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/ServletConfigInterceptor.java +++ b/core/src/main/java/org/apache/struts2/interceptor/ServletConfigInterceptor.java @@ -38,12 +38,14 @@ import com.opensymphony.xwork2.interceptor.AbstractInterceptor; /** * <!-- START SNIPPET: description --> - * + * <p> * An interceptor which sets action properties based on the interfaces an action implements. For example, if the action * implements {@link ParameterAware} then the action context's parameter map will be set on it. + * </p> * - * <p/> This interceptor is designed to set all properties an action needs if it's aware of servlet parameters, the + * <p>This interceptor is designed to set all properties an action needs if it's aware of servlet parameters, the * servlet context, the session, etc. Interfaces that it supports are: + * </p> * * <ul> * @@ -67,7 +69,7 @@ import com.opensymphony.xwork2.interceptor.AbstractInterceptor; * * <!-- END SNIPPET: description --> * - * <p/> <u>Interceptor parameters:</u> + * <p><u>Interceptor parameters:</u></p> * * <!-- START SNIPPET: parameters --> * @@ -79,17 +81,15 @@ import com.opensymphony.xwork2.interceptor.AbstractInterceptor; * * <!-- END SNIPPET: parameters --> * - * <p/> <u>Extending the interceptor:</u> - * - * <p/> + * <p><u>Extending the interceptor:</u></p> * * <!-- START SNIPPET: extending --> * - * There are no known extension points for this interceptor. + * <p>There are no known extension points for this interceptor.</p> * * <!-- END SNIPPET: extending --> * - * <p/> <u>Example code:</u> + * <p><u>Example code:</u></p> * * <pre> * <!-- START SNIPPET: example --> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/interceptor/ServletRequestAware.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/ServletRequestAware.java b/core/src/main/java/org/apache/struts2/interceptor/ServletRequestAware.java index 7adb5dc..814864c 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/ServletRequestAware.java +++ b/core/src/main/java/org/apache/struts2/interceptor/ServletRequestAware.java @@ -25,13 +25,18 @@ import javax.servlet.http.HttpServletRequest; /** - * All Actions that want to have access to the servlet request object must implement this interface.<p> - * <p/> - * This interface is only relevant if the Action is used in a servlet environment. <p> - * <p/> + * <p> + * All Actions that want to have access to the servlet request object must implement this interface. + * </p> + * + * <p> + * This interface is only relevant if the Action is used in a servlet environment. + * </p> + * + * <p> * Note that using this interface makes the Action tied to a servlet environment, so it should be * avoided if possible since things like unit testing will become more difficult. - * + * </p> */ public interface ServletRequestAware { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/interceptor/ServletResponseAware.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/ServletResponseAware.java b/core/src/main/java/org/apache/struts2/interceptor/ServletResponseAware.java index 5674c69..2fa5537 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/ServletResponseAware.java +++ b/core/src/main/java/org/apache/struts2/interceptor/ServletResponseAware.java @@ -25,13 +25,16 @@ import javax.servlet.http.HttpServletResponse; /** - * All Actions that want to have access to the servlet response object must implement this interface.<p> - * <p/> - * This interface is only relevant if the Action is used in a servlet environment.<p> - * <p/> + * <p> + * All Actions that want to have access to the servlet response object must implement this interface. + * </p> + * <p> + * This interface is only relevant if the Action is used in a servlet environment. + * </p> + * <p> * Note that using this interface makes the Action tied to a servlet environment, so it should be * avoided if possible since things like unit testing will become more difficult. - * + * </p> */ public interface ServletResponseAware { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/interceptor/SessionAware.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/SessionAware.java b/core/src/main/java/org/apache/struts2/interceptor/SessionAware.java index 4791f18..ea101bb 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/SessionAware.java +++ b/core/src/main/java/org/apache/struts2/interceptor/SessionAware.java @@ -25,13 +25,16 @@ import java.util.Map; /** - * Actions that want access to the user's HTTP session attributes should implement this interface.<p> - * <p/> + * <p> + * Actions that want access to the user's HTTP session attributes should implement this interface. + * </p> + * <p> * This will give them access to a Map where they can put objects that can be made available - * to subsequent requests.<p/> - * <p/> + * to subsequent requests. + * </p> + * <p> * Typical uses may be cached user data such as name, or a shopping cart. - * + * </p> */ public interface SessionAware { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/interceptor/StrutsConversionErrorInterceptor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/StrutsConversionErrorInterceptor.java b/core/src/main/java/org/apache/struts2/interceptor/StrutsConversionErrorInterceptor.java index 7998489..aad8d76 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/StrutsConversionErrorInterceptor.java +++ b/core/src/main/java/org/apache/struts2/interceptor/StrutsConversionErrorInterceptor.java @@ -28,14 +28,14 @@ import com.opensymphony.xwork2.util.ValueStack; /** * <!-- START SNIPPET: description --> - * + * <p> * This interceptor extends {@link ConversionErrorInterceptor} but only adds conversion errors from the ActionContext to * the field errors of the action if the field value is not null, "", or {""} (a size 1 String array with only an empty * String). See {@link ConversionErrorInterceptor} for more information, as well as the Type Conversion documentation. - * + * </p> * <!-- END SNIPPET: description --> * - * <p/> <u>Interceptor parameters:</u> + * <p><u>Interceptor parameters:</u></p> * * <!-- START SNIPPET: parameters --> * @@ -47,14 +47,12 @@ import com.opensymphony.xwork2.util.ValueStack; * * <!-- END SNIPPET: parameters --> * - * <p/> <u>Extending the interceptor:</u> - * - * <p/> + * <p><u>Extending the interceptor:</u></p> * * <!-- START SNIPPET: extending --> - * + * <p> * There are no known extension points for this interceptor. - * + * </p> * <!-- END SNIPPET: extending --> * * <pre> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/interceptor/TokenInterceptor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/TokenInterceptor.java b/core/src/main/java/org/apache/struts2/interceptor/TokenInterceptor.java index 229fcaf..7854213 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/TokenInterceptor.java +++ b/core/src/main/java/org/apache/struts2/interceptor/TokenInterceptor.java @@ -33,38 +33,39 @@ import javax.servlet.http.HttpSession; /** * <!-- START SNIPPET: description --> - * + * <p> * Ensures that only one request per token is processed. This interceptor can make sure that back buttons and double * clicks don't cause un-intended side affects. For example, you can use this to prevent careless users who might double * click on a "checkout" button at an online store. This interceptor uses a fairly primitive technique for when an * invalid token is found: it returns the result <b>invalid.token</b>, which can be mapped in your action configuration. * A more complex implementation, {@link TokenSessionStoreInterceptor}, can provide much better logic for when invalid * tokens are found. + * </p> * - * <p/> - * + * <p> * <b>Note:</b> To set a token in your form, you should use the <b>token tag</b>. This tag is required and must be used * in the forms that submit to actions protected by this interceptor. Any request that does not provide a token (using * the token tag) will be processed as a request with an invalid token. + * </p> * - * <p/> - * + * <p> * <b>Internationalization Note:</b> The following key could be used to internationalized the action errors generated * by this token interceptor + * </p> * * <ul> * <li>struts.messages.invalid.token</li> * </ul> * - * <p/> - * + * <p> * <b>NOTE:</b> As this method extends off MethodFilterInterceptor, it is capable of * deciding if it is applicable only to selective methods in the action class. See * <code>MethodFilterInterceptor</code> for more info. + * </p> * * <!-- END SNIPPET: description --> * - * <p/> <u>Interceptor parameters:</u> + * <p><u>Interceptor parameters:</u></p> * * <!-- START SNIPPET: parameters --> * @@ -76,19 +77,17 @@ import javax.servlet.http.HttpSession; * * <!-- END SNIPPET: parameters --> * - * <p/> <u>Extending the interceptor:</u> - * - * <p/> + * <p><u>Extending the interceptor:</u></p> * * <!-- START SNIPPET: extending --> - * + * <p> * While not very common for users to extend, this interceptor is extended by the {@link TokenSessionStoreInterceptor}. * The {@link #handleInvalidToken} and {@link #handleValidToken} methods are protected and available for more * interesting logic, such as done with the token session interceptor. - * + * </p> * <!-- END SNIPPET: extending --> * - * <p/> <u>Example code:</u> + * <p><u>Example code:</u></p> * * <pre> * <!-- START SNIPPET: example --> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/interceptor/TokenSessionStoreInterceptor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/TokenSessionStoreInterceptor.java b/core/src/main/java/org/apache/struts2/interceptor/TokenSessionStoreInterceptor.java index 871f24d..4ad4431 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/TokenSessionStoreInterceptor.java +++ b/core/src/main/java/org/apache/struts2/interceptor/TokenSessionStoreInterceptor.java @@ -37,23 +37,24 @@ import java.util.Map; /** * <!-- START SNIPPET: description --> - * + * <p> * This interceptor builds off of the {@link TokenInterceptor}, providing advanced logic for handling invalid tokens. * Unlike the normal token interceptor, this interceptor will attempt to provide intelligent fail-over in the event of * multiple requests using the same session. That is, it will block subsequent requests until the first request is * complete, and then instead of returning the <i>invalid.token</i> code, it will attempt to display the same response * that the original, valid action invocation would have displayed if no multiple requests were submitted in the first * place. + * </p> * - * <p/> - * + * <p> * <b>NOTE:</b> As this method extends off MethodFilterInterceptor, it is capable of * deciding if it is applicable only to selective methods in the action class. See * <code>MethodFilterInterceptor</code> for more info. + * </p> * * <!-- END SNIPPET: description --> * - * <p/> <u>Interceptor parameters:</u> + * <p><u>Interceptor parameters:</u></p> * * <!-- START SNIPPET: parameters --> * @@ -65,17 +66,15 @@ import java.util.Map; * * <!-- END SNIPPET: parameters --> * - * <p/> <u>Extending the interceptor:</u> - * - * <p/> + * <p><u>Extending the interceptor:</u></p> * * <!-- START SNIPPET: extending --> - * + * <p> * There are no known extension points for this interceptor. - * + * </p> * <!-- END SNIPPET: extending --> * - * <p/> <u>Example code:</u> + * <p><u>Example code:</u></p> * * <pre> * <!-- START SNIPPET: example --> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/interceptor/debugging/DebuggingInterceptor.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/interceptor/debugging/DebuggingInterceptor.java b/core/src/main/java/org/apache/struts2/interceptor/debugging/DebuggingInterceptor.java index 33b19f4..6eed280 100644 --- a/core/src/main/java/org/apache/struts2/interceptor/debugging/DebuggingInterceptor.java +++ b/core/src/main/java/org/apache/struts2/interceptor/debugging/DebuggingInterceptor.java @@ -49,11 +49,15 @@ import java.util.*; /** * <!-- START SNIPPET: description --> + * <p> * Provides several different debugging screens to provide insight into the * data behind the page. + * </p> * <!-- END SNIPPET: description --> + * <p> * The value of the 'debug' request parameter determines * the screen: + * </p> * <!-- START SNIPPET: parameters --> * <ul> * <li> <code>xml</code> - Dumps the parameters, context, session, and value @@ -69,18 +73,20 @@ import java.util.*; * debug=browser&object=%23parameters</li> * </ul> * <!-- END SNIPPET: parameters --> - * <p/> - * Example: + * <p> + * Example: + * </p> * <!-- START SNIPPET: example --> * http://localhost:8080/Welcome.action?debug=xml * <!-- END SNIPPET: example --> - * <p/> + * <p> * <!-- START SNIPPET: remarks --> * This interceptor only is activated when devMode is enabled in * struts.properties. The 'debug' parameter is removed from the parameter list * before the action is executed. All operations occur before the natural * Result has a chance to execute. * <!-- END SNIPPET: remarks --> + * </p> */ public class DebuggingInterceptor extends AbstractInterceptor { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/result/HttpHeaderResult.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/result/HttpHeaderResult.java b/core/src/main/java/org/apache/struts2/result/HttpHeaderResult.java index 4745475..d68769e 100644 --- a/core/src/main/java/org/apache/struts2/result/HttpHeaderResult.java +++ b/core/src/main/java/org/apache/struts2/result/HttpHeaderResult.java @@ -37,40 +37,41 @@ import java.util.Map; /** * <!-- START SNIPPET: description --> - * <p/> + * <p> * A custom Result type for setting HTTP headers and status by optionally evaluating against the ValueStack. * This result can also be used to send and error to the client. All the parameters can be evaluated against the ValueStack. - * <p/> + * </p> + * * <!-- END SNIPPET: description --> - * <p/> + * <p> * <b>This result type takes the following parameters:</b> - * <p/> + * </p> * <!-- START SNIPPET: params --> - * <p/> + * * <ul> - * <p/> + * * <li><b>status</b> - the http servlet response status code that should be set on a response.</li> - * <p/> + * * <li><b>parse</b> - true by default. If set to false, the headers param will not be parsed for Ognl expressions.</li> - * <p/> + * * <li><b>headers</b> - header values.</li> - * <p/> + * * <li><b>error</b> - the http servlet response error code that should be set on a response.</li> - * <p/> + * * <li><b>errorMessage</b> - error message to be set on response if 'error' is set.</li> * </ul> - * <p/> + * * <!-- END SNIPPET: params --> - * <p/> + * <p> * <b>Example:</b> - * <p/> + * </p> * <pre><!-- START SNIPPET: example --> * <result name="success" type="httpheader"> * <param name="status">204</param> * <param name="headers.a">a custom header value</param> * <param name="headers.b">another custom header value</param> * </result> - * <p/> + * * <result name="proxyRequired" type="httpheader"> * <param name="error">305</param> * <param name="errorMessage">this action must be accessed through a prozy</param> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/result/PostbackResult.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/result/PostbackResult.java b/core/src/main/java/org/apache/struts2/result/PostbackResult.java index ee14384..95b3927 100644 --- a/core/src/main/java/org/apache/struts2/result/PostbackResult.java +++ b/core/src/main/java/org/apache/struts2/result/PostbackResult.java @@ -36,12 +36,15 @@ import java.util.Map; /** * <!-- START SNIPPET: description --> + * <p> * A result that renders the current request parameters as a form which * immediately submits a <a href="http://en.wikipedia.org/wiki/Postback";>postback</a> * to the specified destination. + * </p> * <!-- END SNIPPET: description --> - * <p/> + * <p> * <b>Parameters:</b> + * </p> * <!-- START SNIPPET: params --> * <ul> * <li>location - http location to post the form</li> @@ -53,8 +56,9 @@ import java.util.Map; * <li>parse (true|false) - when set to true actionName, namespace and method are parsed, default "true"</li> * </ul> * <!-- END SNIPPET: params --> - * <p/> + * <p> * <b>Examples:</b> + * </p> * <pre> * <!-- START SNIPPET: example --> * <action name="registerThirdParty" > http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/result/ServletDispatcherResult.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/result/ServletDispatcherResult.java b/core/src/main/java/org/apache/struts2/result/ServletDispatcherResult.java index 8d20e99..42bfbf3 100644 --- a/core/src/main/java/org/apache/struts2/result/ServletDispatcherResult.java +++ b/core/src/main/java/org/apache/struts2/result/ServletDispatcherResult.java @@ -40,14 +40,17 @@ import java.util.Map; /** * <!-- START SNIPPET: description --> - * + * <p> * Includes or forwards to a view (usually a jsp). Behind the scenes Struts * will use a RequestDispatcher, where the target servlet/JSP receives the same * request/response objects as the original servlet/JSP. Therefore, you can pass * data between them using request.setAttribute() - the Struts action is * available. - * <p/> + * </p> + * + * <p> * There are three possible ways the result can be executed: + * </p> * * <ul> * @@ -65,7 +68,7 @@ import java.util.Map; * </ul> * <!-- END SNIPPET: description --> * - * <b>This result type takes the following parameters:</b> + * <p><b>This result type takes the following parameters:</b></p> * * <!-- START SNIPPET: params --> * @@ -79,7 +82,7 @@ import java.util.Map; * * <!-- END SNIPPET: params --> * - * <b>Example:</b> + * <p><b>Example:</b></p> * * <pre><!-- START SNIPPET: example --> * <result name="success" type="dispatcher"> @@ -87,7 +90,9 @@ import java.util.Map; * </result> * <!-- END SNIPPET: example --></pre> * + * <p> * This result follows the same rules from {@link StrutsResultSupport}. + * </p> * * @see javax.servlet.RequestDispatcher */ http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/result/ServletRedirectResult.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/result/ServletRedirectResult.java b/core/src/main/java/org/apache/struts2/result/ServletRedirectResult.java index c3fe70b..7f2e148 100644 --- a/core/src/main/java/org/apache/struts2/result/ServletRedirectResult.java +++ b/core/src/main/java/org/apache/struts2/result/ServletRedirectResult.java @@ -47,7 +47,7 @@ import static javax.servlet.http.HttpServletResponse.SC_FOUND; /** * <!-- START SNIPPET: description --> - * + * <p> * Calls the {@link HttpServletResponse#sendRedirect(String) sendRedirect} * method to the location specified. The response is told to redirect the * browser to the specified location (a new request from the client). The @@ -56,11 +56,11 @@ import static javax.servlet.http.HttpServletResponse.SC_FOUND; * available. This is because actions are built on a single-thread model. The * only way to pass data is through the session or with web parameters * (url?name=value) which can be OGNL expressions. - * + * </p> * <!-- END SNIPPET: description --> - * <p/> + * <p> * <b>This result type takes the following parameters:</b> - * + * </p> * <!-- START SNIPPET: params --> * * <ul> @@ -79,9 +79,10 @@ import static javax.servlet.http.HttpServletResponse.SC_FOUND; * </p> * * <!-- END SNIPPET: params --> - * + * <p> * <b>Example:</b> - * + * </p> + * * <pre> * <!-- START SNIPPET: example --> * <!-- http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/result/StreamResult.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/result/StreamResult.java b/core/src/main/java/org/apache/struts2/result/StreamResult.java index 8438fbc..7829e3c 100644 --- a/core/src/main/java/org/apache/struts2/result/StreamResult.java +++ b/core/src/main/java/org/apache/struts2/result/StreamResult.java @@ -32,14 +32,14 @@ import java.io.OutputStream; /** * <!-- START SNIPPET: description --> - * + * <p> * A custom Result type for sending raw data (via an InputStream) directly to the * HttpServletResponse. Very useful for allowing users to download content. - * + * </p> * <!-- END SNIPPET: description --> - * <p/> + * <p> * <b>This result type takes the following parameters:</b> - * + * </p> * <!-- START SNIPPET: params --> * * <ul> @@ -73,8 +73,9 @@ import java.io.OutputStream; * provide <code>getContentType()</code> to override that parameter for the current action.</p> * * <!-- END SNIPPET: params --> - * + * <p> * <b>Example:</b> + * </p> * * <pre><!-- START SNIPPET: example --> * <result name="success" type="stream"> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/result/StrutsResultSupport.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/result/StrutsResultSupport.java b/core/src/main/java/org/apache/struts2/result/StrutsResultSupport.java index bdb1b93..06a1f12 100644 --- a/core/src/main/java/org/apache/struts2/result/StrutsResultSupport.java +++ b/core/src/main/java/org/apache/struts2/result/StrutsResultSupport.java @@ -36,11 +36,15 @@ import java.util.Collection; /** * <!-- START SNIPPET: javadoc --> - * + * <p> * A base class for all Struts action execution results. * The "location" param is the default parameter, meaning the most common usage of this result would be: - * <p/> + * </p> + * + * <p> * This class provides two common parameters for any subclass: + * </p> + * * <ul> * <li>location - the location to go to after execution (could be a jsp page or another action). * It can be parsed as per the rules definied in the @@ -50,54 +54,64 @@ import java.util.Collection; * <li>encode - false by default. If set to false, the location param will not be url encoded. This only have effect when parse is true</li> * </ul> * + * <p> * <b>NOTE:</b> * The encode param will only have effect when parse is true + * </p> * * <!-- END SNIPPET: javadoc --> * - * <p/> - * * <!-- START SNIPPET: example --> * - * <p/> + * <p> * In the struts.xml configuration file, these would be included as: - * <p/> + * </p> + * * <pre> * <result name="success" type="redirect"> * <param name="<b>location</b>">foo.jsp</param> * </result></pre> - * <p/> + * * or - * <p/> + * * <pre> * <result name="success" type="redirect" > * <param name="<b>location</b>">foo.jsp?url=${myUrl}</param> * <param name="<b>parse</b>">true</param> * <param name="<b>encode</b>">true</param> - * </result></pre> - * <p/> - * In the above case, myUrl will be parsed against Ognl Value Stack and then - * URL encoded. - * <p/> + * </result> + * </pre> + * + * <p>In the above case, myUrl will be parsed against Ognl Value Stack and then + * URL encoded.1 + * </p> + * <p> * or when using the default parameter feature - * <p/> + * </p> + * * <pre> - * <result name="success" type="redirect"><b>foo.jsp</b></result></pre> - * <p/> + * <result name="success" type="redirect"><b>foo.jsp</b></result> + * </pre> + * <p> * You should subclass this class if you're interested in adding more parameters or functionality * to your Result. If you do subclass this class you will need to - * override {@link #doExecute(String, ActionInvocation)}.<p> - * <p/> + * override {@link #doExecute(String, ActionInvocation)}. + * </p> + * + * <p> * Any custom result can be defined in struts.xml as: - * <p/> + * </p> + * * <pre> * <result-types> * ... * <result-type name="myresult" class="com.foo.MyResult" /> - * </result-types></pre> - * <p/> - * Please see the {@link com.opensymphony.xwork2.Result} class for more info on Results in general. + * </result-types> + * </pre> * + * <p> + * Please see the {@link com.opensymphony.xwork2.Result} class for more info on Results in general. + * </p> * <!-- END SNIPPET: example --> * * @see com.opensymphony.xwork2.Result http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/result/VelocityResult.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/result/VelocityResult.java b/core/src/main/java/org/apache/struts2/result/VelocityResult.java index 810d191..2720209 100644 --- a/core/src/main/java/org/apache/struts2/result/VelocityResult.java +++ b/core/src/main/java/org/apache/struts2/result/VelocityResult.java @@ -53,9 +53,9 @@ import java.io.Writer; * streamed directly to the servlet output. * * <!-- END SNIPPET: description --> - * <p/> + * <p> * <b>This result type takes the following parameters:</b> - * + * </p> * <!-- START SNIPPET: params --> * * <ul> @@ -71,14 +71,16 @@ import java.io.Writer; * </p> * * <!-- END SNIPPET: params --> - * + * <p> * <b>Example:</b> - * - * <pre><!-- START SNIPPET: example --> + * </p> + * <pre> + * <!-- START SNIPPET: example --> * <result name="success" type="velocity"> * <param name="location">foo.vm</param> * </result> - * <!-- END SNIPPET: example --></pre> + * <!-- END SNIPPET: example --> + * </pre> * */ public class VelocityResult extends StrutsResultSupport { @@ -170,8 +172,9 @@ public class VelocityResult extends StrutsResultSupport { /** * Retrieve the content type for this template. - * <p/> + * <p> * People can override this method if they want to provide specific content types for specific templates (eg text/xml). + * </p> * * @return The content type associated with this template (default "text/html") */ @@ -181,8 +184,9 @@ public class VelocityResult extends StrutsResultSupport { /** * Retrieve the encoding for this template. - * <p/> + * <p> * People can override this method if they want to provide specific encodings for specific templates. + * </p> * * @return The encoding associated with this template (defaults to the value of 'struts.i18n.encoding' property) */ http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/util/AttributeMap.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/util/AttributeMap.java b/core/src/main/java/org/apache/struts2/util/AttributeMap.java index 48498e3..4e95cb5 100644 --- a/core/src/main/java/org/apache/struts2/util/AttributeMap.java +++ b/core/src/main/java/org/apache/struts2/util/AttributeMap.java @@ -32,14 +32,17 @@ import java.util.Set; /** * A Map that holds 4 levels of scope. - * <p/> - * The scopes are the ones known in the web world.: + * <p> + * The scopes are the ones known in the web world: + * </p> + * * <ul> * <li>Page scope</li> * <li>Request scope</li> * <li>Session scope</li> * <li>Application scope</li> * </ul> + * * A object is searched in the order above, starting from page and ending at application scope. * */ http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/util/Counter.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/util/Counter.java b/core/src/main/java/org/apache/struts2/util/Counter.java index aa5a600..08bec42 100644 --- a/core/src/main/java/org/apache/struts2/util/Counter.java +++ b/core/src/main/java/org/apache/struts2/util/Counter.java @@ -26,9 +26,9 @@ import java.io.Serializable; /** * A bean that can be used to keep track of a counter. - * <p/> + * <p> * Since it is an Iterator it can be used by the iterator tag - * + * </p> */ public class Counter implements java.util.Iterator, Serializable { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/util/StrutsTypeConverter.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/util/StrutsTypeConverter.java b/core/src/main/java/org/apache/struts2/util/StrutsTypeConverter.java index d01ec7a..d37c79f 100644 --- a/core/src/main/java/org/apache/struts2/util/StrutsTypeConverter.java +++ b/core/src/main/java/org/apache/struts2/util/StrutsTypeConverter.java @@ -28,19 +28,22 @@ import com.opensymphony.xwork2.conversion.impl.DefaultTypeConverter; /** * <!-- START SNIPPET: javadoc --> * + * <p> * Base class for type converters used in Struts. This class provides two abstract methods that are used to convert - * both to and from strings -- the critical functionality that is core to Struts's type coversion system. - * - * <p/> Type converters do not have to use this class. It is merely a helper base class, although it is recommended that + * both to and from strings -- the critical functionality that is core to Struts's type conversion system. + * </p> + * <p> Type converters do not have to use this class. It is merely a helper base class, although it is recommended that * you use this class as it provides the common type conversion contract required for all web-based type conversion. + * </p> * - * <p/> There's a hook (fall back method) called <code>performFallbackConversion</code> of which + * <p> There's a hook (fall back method) called <code>performFallbackConversion</code> of which * could be used to perform some fallback conversion if <code>convertValue</code> method of this * failed. By default it just ask its super class (Ognl's DefaultTypeConverter) to do the conversion. + * </p> * - * <p/> To allow the framework to recognize that a conversion error has occurred, throw an XWorkException or + * <p> To allow the framework to recognize that a conversion error has occurred, throw an XWorkException or * preferable a TypeConversionException. - * + * </p> * <!-- END SNIPPET: javadoc --> * */ http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/util/StrutsUtil.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/util/StrutsUtil.java b/core/src/main/java/org/apache/struts2/util/StrutsUtil.java index 14265bb..aee854f 100644 --- a/core/src/main/java/org/apache/struts2/util/StrutsUtil.java +++ b/core/src/main/java/org/apache/struts2/util/StrutsUtil.java @@ -144,8 +144,9 @@ public class StrutsUtil { /** * the selectedList objects are matched to the list.listValue - * <p/> + * <p> * listKey and listValue are optional, and if not provided, the list item is used + * </p> * * @param selectedList the name of the action property * that contains the list of selected items http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/views/freemarker/FreemarkerManager.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/views/freemarker/FreemarkerManager.java b/core/src/main/java/org/apache/struts2/views/freemarker/FreemarkerManager.java index 1508cb7..c4fde80 100644 --- a/core/src/main/java/org/apache/struts2/views/freemarker/FreemarkerManager.java +++ b/core/src/main/java/org/apache/struts2/views/freemarker/FreemarkerManager.java @@ -55,11 +55,13 @@ import java.util.*; /** + * <p> * Static Configuration Manager for the FreemarkerResult's configuration + * </p> * - * <p/> + * <p> + * Possible extension points are: * - * Possible extension points are :- * <ul> * <li>createConfiguration method</li> * <li>loadSettings method</li> @@ -67,27 +69,31 @@ import java.util.*; * <li>populateContext method</li> * </ul> * - * <p/> + * <p> * <b> createConfiguration method </b><br/> * Create a freemarker Configuration. - * <p/> + * </p> * + * <p> * <b> loadSettings method </b><br/> * Load freemarker settings, default to freemarker.properties (if found in classpath) - * <p/> + * </p> * + * <p> * <b> createTemplateLoader method</b><br/> - * create a freemarker TemplateLoader that loads freemarker template in the following order :- + * create a freemarker TemplateLoader that loads freemarker template in the following order: + * </p> + * * <ol> * <li>path defined in ServletContext init parameter named 'templatePath' or 'TemplatePath' (must be an absolute path)</li> * <li>webapp classpath</li> * <li>struts's static folder (under [STRUT2_SOURCE]/org/apache/struts2/static/</li> * </ol> - * <p/> * + * <p> * <b> populateContext method</b><br/> * populate the created model. - * + * </p> */ public class FreemarkerManager { @@ -289,8 +295,10 @@ public class FreemarkerManager { /** * Create the instance of the freemarker Configuration object. - * <p/> + * <p> * this implementation + * </p> + * * <ul> * <li>obtains the default configuration from Configuration.getDefaultConfiguration() * <li>sets up template loading from a ClassTemplateLoader and a WebappTemplateLoader http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/views/freemarker/FreemarkerResult.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/views/freemarker/FreemarkerResult.java b/core/src/main/java/org/apache/struts2/views/freemarker/FreemarkerResult.java index 0775f55..b052da0 100644 --- a/core/src/main/java/org/apache/struts2/views/freemarker/FreemarkerResult.java +++ b/core/src/main/java/org/apache/struts2/views/freemarker/FreemarkerResult.java @@ -148,12 +148,14 @@ public class FreemarkerResult extends StrutsResultSupport { /** * Execute this result, using the specified template locationArg. - * <p/> - * The template locationArg has already been interoplated for any variable substitutions - * <p/> + * <p> + * The template locationArg has already been interpolated for any variable substitutions + * </p> + * <p> * this method obtains the freemarker configuration and the object wrapper from the provided hooks. * It them implements the template processing workflow by calling the hooks for * preTemplateProcess and postTemplateProcess + * </p> */ public void doExecute(String locationArg, ActionInvocation invocation) throws IOException, TemplateException { this.location = locationArg; @@ -230,27 +232,35 @@ public class FreemarkerResult extends StrutsResultSupport { } /** + * <p> * This method is called from {@link #doExecute(String, ActionInvocation)} to obtain the * FreeMarker configuration object that this result will use for template loading. This is a * hook that allows you to custom-configure the configuration object in a subclass, or to fetch * it from an IoC container. - * <p/> + * </p> + * + * <p> * <b> * The default implementation obtains the configuration from the ConfigurationManager instance. * </b> + * </p> */ protected Configuration getConfiguration() throws TemplateException { return freemarkerManager.getConfiguration(ServletActionContext.getServletContext()); } /** + * <p> * This method is called from {@link #doExecute(String, ActionInvocation)} to obtain the * FreeMarker object wrapper object that this result will use for adapting objects into template * models. This is a hook that allows you to custom-configure the wrapper object in a subclass. - * <p/> + * </p> + * + * <p> * <b> * The default implementation returns {@link Configuration#getObjectWrapper()} * </b> + * </p> */ protected ObjectWrapper getObjectWrapper() { return configuration.getObjectWrapper(); @@ -273,9 +283,10 @@ public class FreemarkerResult extends StrutsResultSupport { /** * Build the instance of the ScopesHashModel, including JspTagLib support - * <p/> + * <p> * Objects added to the model are - * <p/> + * </p> + * * <ul> * <li>Application - servlet context attributes hash model * <li>JspTaglibs - jsp tag lib factory model http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/views/freemarker/ScopesHashModel.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/views/freemarker/ScopesHashModel.java b/core/src/main/java/org/apache/struts2/views/freemarker/ScopesHashModel.java index 47ea5ef..98cec4b 100644 --- a/core/src/main/java/org/apache/struts2/views/freemarker/ScopesHashModel.java +++ b/core/src/main/java/org/apache/struts2/views/freemarker/ScopesHashModel.java @@ -35,13 +35,19 @@ import java.util.Map; /** + * <p> * Simple Hash model that also searches other scopes. - * <p/> + * </p> + * + * <p> * If the key doesn't exist in this hash, this template model tries to * resolve the key within the attributes of the following scopes, * in the order stated: Request, Session, Servlet Context + * </p> * + * <p> * Updated to subclass AllHttpScopesHashModel.java to incorporate invisible scopes and compatibility with freemarker. + * </p> */ public class ScopesHashModel extends SimpleHash implements TemplateModel { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/views/freemarker/StrutsBeanWrapper.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/views/freemarker/StrutsBeanWrapper.java b/core/src/main/java/org/apache/struts2/views/freemarker/StrutsBeanWrapper.java index df9d64a..ad1222f 100644 --- a/core/src/main/java/org/apache/struts2/views/freemarker/StrutsBeanWrapper.java +++ b/core/src/main/java/org/apache/struts2/views/freemarker/StrutsBeanWrapper.java @@ -36,17 +36,18 @@ import freemarker.template.TemplateModel; /** * <!-- START SNIPPET: javadoc --> - * + * <p> * The StrutsBeanWrapper extends the default FreeMarker BeansWrapper and provides almost no change in functionality, * <b>except</b> for how it handles maps. Normally, FreeMarker has two modes of operation: either support for friendly * map built-ins (?keys, ?values, etc) but only support for String keys; OR no special built-in support (ie: ?keys * returns the methods on the map instead of the keys) but support for String and non-String keys alike. Struts * provides an alternative implementation that gives us the best of both worlds. + * </p> * - * <p/> It is possible that this special behavior may be confusing or can cause problems. Therefore, you can set the + * <p> It is possible that this special behavior may be confusing or can cause problems. Therefore, you can set the * <b>struts.freemarker.wrapper.altMap</b> property in struts.properties to false, allowing the normal BeansWrapper * logic to take place instead. - * + * </p> * <!-- END SNIPPET: javadoc --> */ public class StrutsBeanWrapper extends BeansWrapper { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/views/velocity/VelocityManager.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/views/velocity/VelocityManager.java b/core/src/main/java/org/apache/struts2/views/velocity/VelocityManager.java index 8f49856..9828eaf 100644 --- a/core/src/main/java/org/apache/struts2/views/velocity/VelocityManager.java +++ b/core/src/main/java/org/apache/struts2/views/velocity/VelocityManager.java @@ -118,9 +118,11 @@ public class VelocityManager { } /** + * <p> * This method is responsible for creating the standard VelocityContext used by all WW2 velocity views. The * following context parameters are defined: - * <p/> + * </p> + * * <ul> * <li><strong>request</strong> - the current HttpServletRequest</li> * <li><strong>response</strong> - the current HttpServletResponse</li> @@ -394,22 +396,24 @@ public class VelocityManager { /** - * <p/> + * <p> * Instantiates a new VelocityEngine. * </p> - * <p/> + * <p> * The following is the default Velocity configuration * </p> + * * <pre> * resource.loader = file, class * file.resource.loader.path = real path of webapp * class.resource.loader.description = Velocity Classpath Resource Loader * class.resource.loader.class = org.apache.struts2.views.velocity.StrutsResourceLoader * </pre> - * <p/> + * <p> * this default configuration can be overridden by specifying a struts.velocity.configfile property in the * struts.properties file. the specified config file will be searched for in the following order: * </p> + * * <ul> * <li>relative to the servlet context path</li> * <li>relative to the WEB-INF directory</li> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/views/xslt/AdapterFactory.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/views/xslt/AdapterFactory.java b/core/src/main/java/org/apache/struts2/views/xslt/AdapterFactory.java index 69a8ad3..67202fc 100644 --- a/core/src/main/java/org/apache/struts2/views/xslt/AdapterFactory.java +++ b/core/src/main/java/org/apache/struts2/views/xslt/AdapterFactory.java @@ -156,16 +156,22 @@ public class AdapterFactory { } /** + * <p> * Construct a proxy adapter for a value that is an existing DOM Node. * This allows arbitrary DOM Node trees to be mixed in with our results. * The proxied nodes are read-only and currently support only * limited types of Nodes including Element, Text, and Attributes. (Other * Node types may be ignored by the proxy and not appear in the result tree). - * <p/> + * </p> + * + * <p> * // TODO: * NameSpaces are not yet supported. - * <p/> + * </p> + * + * <p> * This method is primarily for use by the adapter node classes. + * </p> */ public Node proxyNode(AdapterNode parent, Node node) { // If the property is a Document, "unwrap" it to the root element http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/java/org/apache/struts2/views/xslt/StringAdapter.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/struts2/views/xslt/StringAdapter.java b/core/src/main/java/org/apache/struts2/views/xslt/StringAdapter.java index 59f77d0..194d52b 100644 --- a/core/src/main/java/org/apache/struts2/views/xslt/StringAdapter.java +++ b/core/src/main/java/org/apache/struts2/views/xslt/StringAdapter.java @@ -57,13 +57,17 @@ public class StringAdapter extends AbstractAdapterElement { } /** + * <p> * Get the object to be adapted as a String value. - * <p/> + * </p> + * + * <p> * This method can be overridden by subclasses that wish to use StringAdapter * as a simplified customizable XML adapter for Java types. A subclass can * enable parsing of the value string as containing XML text via the * setParseStringAsXML() method and then override getStringValue() to return a * String containing the custom formatted XML. + * </p> */ protected String getStringValue() { return getPropertyValue().toString(); http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/main/resources/org/apache/struts2/interceptor/wait.ftl ---------------------------------------------------------------------- diff --git a/core/src/main/resources/org/apache/struts2/interceptor/wait.ftl b/core/src/main/resources/org/apache/struts2/interceptor/wait.ftl index ff87ccb..83bf03c 100644 --- a/core/src/main/resources/org/apache/struts2/interceptor/wait.ftl +++ b/core/src/main/resources/org/apache/struts2/interceptor/wait.ftl @@ -26,8 +26,8 @@ </head> <body> Please wait while we process your request... - <p/> - + <p> This page will reload automatically and display your request when it is completed. + </p> </body> </html> http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/test/java/com/opensymphony/xwork2/ExternalReferenceAction.java ---------------------------------------------------------------------- diff --git a/core/src/test/java/com/opensymphony/xwork2/ExternalReferenceAction.java b/core/src/test/java/com/opensymphony/xwork2/ExternalReferenceAction.java index ecf2ceb..90313f7 100644 --- a/core/src/test/java/com/opensymphony/xwork2/ExternalReferenceAction.java +++ b/core/src/test/java/com/opensymphony/xwork2/ExternalReferenceAction.java @@ -21,13 +21,6 @@ */ package com.opensymphony.xwork2; - -/** - * @author Mike - * <p/> - * To change the template for this generated type comment go to Window - - * Preferences - Java - Code Generation - Code and Comments - */ public class ExternalReferenceAction implements Action { private Foo foo; http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/test/java/com/opensymphony/xwork2/Foo.java ---------------------------------------------------------------------- diff --git a/core/src/test/java/com/opensymphony/xwork2/Foo.java b/core/src/test/java/com/opensymphony/xwork2/Foo.java index 25d5bb0..ddf0b22 100644 --- a/core/src/test/java/com/opensymphony/xwork2/Foo.java +++ b/core/src/test/java/com/opensymphony/xwork2/Foo.java @@ -21,13 +21,6 @@ */ package com.opensymphony.xwork2; - -/** - * @author Mike - * <p/> - * To change the template for this generated type comment go to - * Window - Preferences - Java - Code Generation - Code and Comments - */ public class Foo { String name = null; http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/test/java/com/opensymphony/xwork2/config/ConfigurationTest.java ---------------------------------------------------------------------- diff --git a/core/src/test/java/com/opensymphony/xwork2/config/ConfigurationTest.java b/core/src/test/java/com/opensymphony/xwork2/config/ConfigurationTest.java index e8bf7d1..397341f 100644 --- a/core/src/test/java/com/opensymphony/xwork2/config/ConfigurationTest.java +++ b/core/src/test/java/com/opensymphony/xwork2/config/ConfigurationTest.java @@ -34,10 +34,6 @@ import java.util.Map; /** - * ConfigurationTest - * <p/> - * Created : Jan 27, 2003 1:30:08 AM - * * @author Jason Carreira */ public class ConfigurationTest extends XWorkTestCase { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/test/java/com/opensymphony/xwork2/config/providers/NoNoArgsConstructorAction.java ---------------------------------------------------------------------- diff --git a/core/src/test/java/com/opensymphony/xwork2/config/providers/NoNoArgsConstructorAction.java b/core/src/test/java/com/opensymphony/xwork2/config/providers/NoNoArgsConstructorAction.java index 8f1435d..ecdf526 100644 --- a/core/src/test/java/com/opensymphony/xwork2/config/providers/NoNoArgsConstructorAction.java +++ b/core/src/test/java/com/opensymphony/xwork2/config/providers/NoNoArgsConstructorAction.java @@ -4,8 +4,10 @@ import com.opensymphony.xwork2.Action; /** * Action with no public constructor taking no args. - * <p/> + * + * <p> * Used for unit test of {@link com.opensymphony.xwork2.config.providers.XmlConfigurationProvider}. + * </p> * * @author Claus Ibsen */ http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/test/java/com/opensymphony/xwork2/config/providers/PrivateConstructorAction.java ---------------------------------------------------------------------- diff --git a/core/src/test/java/com/opensymphony/xwork2/config/providers/PrivateConstructorAction.java b/core/src/test/java/com/opensymphony/xwork2/config/providers/PrivateConstructorAction.java index 640a171..4c3b1df 100644 --- a/core/src/test/java/com/opensymphony/xwork2/config/providers/PrivateConstructorAction.java +++ b/core/src/test/java/com/opensymphony/xwork2/config/providers/PrivateConstructorAction.java @@ -18,9 +18,11 @@ package com.opensymphony.xwork2.config.providers; import com.opensymphony.xwork2.Action; /** - * Action with nu public constructor. - * <p/> + * Action with no public constructor. + * + * <p> * Used for unit test of {@link XmlConfigurationProvider}. + * </p> * * @author Claus Ibsen */ http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/test/java/com/opensymphony/xwork2/interceptor/AliasInterceptorTest.java ---------------------------------------------------------------------- diff --git a/core/src/test/java/com/opensymphony/xwork2/interceptor/AliasInterceptorTest.java b/core/src/test/java/com/opensymphony/xwork2/interceptor/AliasInterceptorTest.java index 751f84a..9449c4e 100644 --- a/core/src/test/java/com/opensymphony/xwork2/interceptor/AliasInterceptorTest.java +++ b/core/src/test/java/com/opensymphony/xwork2/interceptor/AliasInterceptorTest.java @@ -28,16 +28,18 @@ import java.util.Map; /** * AliasInterceptorTest * + * <p> * Test of aliasInterceptor specifically depends on actionTest test defined in /test/xwork.xml * stack.getContext().putAll(params); - * <p/> + * </p> * e.g. + * <pre> * <action name="aliasTest" class="com.opensymphony.xwork2.SimpleAction"> * <param name="aliases">#{ "aliasSource" : "aliasDest", "bar":"baz" }</param> * <interceptor-ref name="defaultStack"/> * <interceptor-ref name="alias"/> * </action> - * + * </pre> * @author Matthew Payne */ public class AliasInterceptorTest extends XWorkTestCase { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/test/java/com/opensymphony/xwork2/ognl/accessor/XWorkListPropertyAccessorTest.java ---------------------------------------------------------------------- diff --git a/core/src/test/java/com/opensymphony/xwork2/ognl/accessor/XWorkListPropertyAccessorTest.java b/core/src/test/java/com/opensymphony/xwork2/ognl/accessor/XWorkListPropertyAccessorTest.java index 6942a1f..fab0fc9 100644 --- a/core/src/test/java/com/opensymphony/xwork2/ognl/accessor/XWorkListPropertyAccessorTest.java +++ b/core/src/test/java/com/opensymphony/xwork2/ognl/accessor/XWorkListPropertyAccessorTest.java @@ -12,10 +12,6 @@ import java.util.ArrayList; import java.util.List; /** - * XWorkListPropertyAccessorTest - * <p/> - * Created : Nov 7, 2005 3:54:44 PM - * * @author Jason Carreira <[email protected]> */ public class XWorkListPropertyAccessorTest extends XWorkTestCase { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/test/java/com/opensymphony/xwork2/validator/DefaultValidatorFileParserTest.java ---------------------------------------------------------------------- diff --git a/core/src/test/java/com/opensymphony/xwork2/validator/DefaultValidatorFileParserTest.java b/core/src/test/java/com/opensymphony/xwork2/validator/DefaultValidatorFileParserTest.java index b900b55..eb90b75 100644 --- a/core/src/test/java/com/opensymphony/xwork2/validator/DefaultValidatorFileParserTest.java +++ b/core/src/test/java/com/opensymphony/xwork2/validator/DefaultValidatorFileParserTest.java @@ -27,10 +27,6 @@ import java.util.List; /** - * DefaultValidatorFileParserTest - * <p/> - * Created : Jan 20, 2003 3:41:26 PM - * * @author Jason Carreira * @author James House * @author tm_jee ( tm_jee (at) yahoo.co.uk ) http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/test/java/com/opensymphony/xwork2/validator/IntRangeValidatorTest.java ---------------------------------------------------------------------- diff --git a/core/src/test/java/com/opensymphony/xwork2/validator/IntRangeValidatorTest.java b/core/src/test/java/com/opensymphony/xwork2/validator/IntRangeValidatorTest.java index d096e1e..aadb478 100644 --- a/core/src/test/java/com/opensymphony/xwork2/validator/IntRangeValidatorTest.java +++ b/core/src/test/java/com/opensymphony/xwork2/validator/IntRangeValidatorTest.java @@ -28,10 +28,6 @@ import java.util.Map; /** - * IntRangeValidatorTest - * <p/> - * Created : Jan 21, 2003 12:16:01 AM - * * @author Jason Carreira */ public class IntRangeValidatorTest extends XWorkTestCase { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/test/java/com/opensymphony/xwork2/validator/LongRangeValidatorTest.java ---------------------------------------------------------------------- diff --git a/core/src/test/java/com/opensymphony/xwork2/validator/LongRangeValidatorTest.java b/core/src/test/java/com/opensymphony/xwork2/validator/LongRangeValidatorTest.java index 5d10079..467deb9 100644 --- a/core/src/test/java/com/opensymphony/xwork2/validator/LongRangeValidatorTest.java +++ b/core/src/test/java/com/opensymphony/xwork2/validator/LongRangeValidatorTest.java @@ -27,11 +27,6 @@ import java.util.List; import java.util.Map; -/** - * LongRangeValidatorTest - * <p/> - * - */ public class LongRangeValidatorTest extends XWorkTestCase { public void testRangeValidation() { http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/test/java/com/opensymphony/xwork2/validator/RegexFieldValidatorTest.java ---------------------------------------------------------------------- diff --git a/core/src/test/java/com/opensymphony/xwork2/validator/RegexFieldValidatorTest.java b/core/src/test/java/com/opensymphony/xwork2/validator/RegexFieldValidatorTest.java index bebf255..6aa5873 100644 --- a/core/src/test/java/com/opensymphony/xwork2/validator/RegexFieldValidatorTest.java +++ b/core/src/test/java/com/opensymphony/xwork2/validator/RegexFieldValidatorTest.java @@ -23,10 +23,14 @@ import com.opensymphony.xwork2.validator.validators.RegexFieldValidator; import java.util.List; /** + * <p> * Unit test for RegexFieldValidator. - * <p/> + * </p> + * + * <p> * This unit test is only to test that the regex field validator works, not to * unit test the build in reg.exp from JDK. That is why the expressions are so simple. + * </p> * * @author Claus Ibsen */ http://git-wip-us.apache.org/repos/asf/struts/blob/eb564a25/core/src/test/java/com/opensymphony/xwork2/validator/ShortRangeValidatorTest.java ---------------------------------------------------------------------- diff --git a/core/src/test/java/com/opensymphony/xwork2/validator/ShortRangeValidatorTest.java b/core/src/test/java/com/opensymphony/xwork2/validator/ShortRangeValidatorTest.java index 123ad3b..a89865e 100644 --- a/core/src/test/java/com/opensymphony/xwork2/validator/ShortRangeValidatorTest.java +++ b/core/src/test/java/com/opensymphony/xwork2/validator/ShortRangeValidatorTest.java @@ -27,11 +27,6 @@ import java.util.List; import java.util.Map; -/** - * ShortRangeValidatorTest - * <p/> - * - */ public class ShortRangeValidatorTest extends XWorkTestCase { public void testRangeValidation() {
