Replace <code> with {@code} throughout Javadoc

Issue: SPR-10128
This commit is contained in:
Chris Beams
2012-12-18 14:45:36 +01:00
parent 8597ec25ec
commit 9540d2c81b
1503 changed files with 8001 additions and 8060 deletions

View File

@@ -43,7 +43,7 @@ import org.springframework.web.util.WebUtils;
* <p>Derives from the Tiles {@link ControllerSupport} class rather than
* implementing the Tiles {@link org.apache.struts.tiles.Controller} interface
* in order to be compatible with Struts 1.1 and 1.2. Implements both Struts 1.1's
* <code>perform</code> and Struts 1.2's <code>execute</code> method accordingly.
* {@code perform} and Struts 1.2's {@code execute} method accordingly.
*
* @author Juergen Hoeller
* @author Alef Arendsen
@@ -60,7 +60,7 @@ public abstract class ComponentControllerSupport extends ControllerSupport {
/**
* This implementation delegates to <code>execute</code>,
* This implementation delegates to {@code execute},
* converting non-Servlet/IO Exceptions to ServletException.
* <p>This is the only execution method available in Struts 1.1.
* @see #execute
@@ -86,10 +86,10 @@ public abstract class ComponentControllerSupport extends ControllerSupport {
}
/**
* This implementation delegates to <code>doPerform</code>,
* This implementation delegates to {@code doPerform},
* lazy-initializing the application context reference if necessary.
* <p>This is the preferred execution method in Struts 1.2.
* When running with Struts 1.1, it will be called by <code>perform</code>.
* When running with Struts 1.1, it will be called by {@code perform}.
* @see #perform
* @see #doPerform
*/
@@ -162,7 +162,7 @@ public abstract class ComponentControllerSupport extends ControllerSupport {
* The ServletContext can be retrieved via getServletContext, if necessary.
* The Spring WebApplicationContext can be accessed via getWebApplicationContext.
* <p>This method will be called both in the Struts 1.1 and Struts 1.2 case,
* by <code>perform</code> or <code>execute</code>, respectively.
* by {@code perform} or {@code execute}, respectively.
* @param componentContext current Tiles component context
* @param request current HTTP request
* @param response current HTTP response

View File

@@ -167,7 +167,7 @@ public class TilesView extends InternalResourceView {
* given Tiles definition, if any.
* @param definition the Tiles definition to render
* @param request current HTTP request
* @return the component controller to execute, or <code>null</code> if none
* @return the component controller to execute, or {@code null} if none
* @throws Exception if preparations failed
*/
protected Controller getController(ComponentDefinition definition, HttpServletRequest request)

View File

@@ -25,7 +25,7 @@ import org.springframework.beans.factory.config.DestructionAwareBeanPostProcesso
* {@link org.springframework.beans.factory.config.BeanPostProcessor}
* implementation that passes the ActionServlet to beans that extend
* the Struts {@link org.apache.struts.action.Action} class.
* Invokes <code>Action.setServlet</code> with <code>null</dode> on
* Invokes {@code Action.setServlet} with {@code null} on
* bean destruction, providing the same lifecycle handling as the
* native Struts ActionServlet.
*

View File

@@ -277,8 +277,8 @@ public class ContextLoaderPlugIn implements PlugIn {
/**
* Initialize and publish the WebApplicationContext for the ActionServlet.
* <p>Delegates to {@link #createWebApplicationContext} for actual creation.
* <p>Can be overridden in subclasses. Call <code>getActionServlet()</code>
* and/or <code>getModuleConfig()</code> to access the Struts configuration
* <p>Can be overridden in subclasses. Call {@code getActionServlet()}
* and/or {@code getModuleConfig()} to access the Struts configuration
* that this PlugIn is associated with.
* @throws org.springframework.beans.BeansException if the context couldn't be initialized
* @throws IllegalStateException if there is already a context for the Struts ActionServlet

View File

@@ -30,20 +30,20 @@ import org.springframework.beans.BeansException;
import org.springframework.web.context.WebApplicationContext;
/**
* Proxy for a Spring-managed Struts <code>Action</code> that is defined in
* Proxy for a Spring-managed Struts {@code Action} that is defined in
* {@link ContextLoaderPlugIn ContextLoaderPlugIn's}
* {@link WebApplicationContext}.
*
* <p>The proxy is defined in the Struts config file, specifying this
* class as the action class. This class will delegate to a Struts
* <code>Action</code> bean in the <code>ContextLoaderPlugIn</code> context.
* {@code Action} bean in the {@code ContextLoaderPlugIn} context.
*
* <pre class="code">&lt;action path="/login" type="org.springframework.web.struts.DelegatingActionProxy"/&gt;</pre>
*
* The name of the <code>Action</code> bean in the
* <code>WebApplicationContext</code> will be determined from the mapping
* The name of the {@code Action} bean in the
* {@code WebApplicationContext} will be determined from the mapping
* path and module prefix. This can be customized by overriding the
* <code>determineActionBeanName</code> method.
* {@code determineActionBeanName} method.
*
* <p>Example:
* <ul>
@@ -52,8 +52,8 @@ import org.springframework.web.context.WebApplicationContext;
* bean name "/mymodule/login"
* </ul>
*
* <p>A corresponding bean definition in the <code>ContextLoaderPlugin</code>
* context would look as follows; notice that the <code>Action</code> is now
* <p>A corresponding bean definition in the {@code ContextLoaderPlugin}
* context would look as follows; notice that the {@code Action} is now
* able to leverage fully Spring's configuration facilities:
*
* <pre class="code">
@@ -61,28 +61,28 @@ import org.springframework.web.context.WebApplicationContext;
* &lt;property name="..."&gt;...&lt;/property&gt;
* &lt;/bean&gt;</pre>
*
* Note that you can use a single <code>ContextLoaderPlugIn</code> for all
* Note that you can use a single {@code ContextLoaderPlugIn} for all
* Struts modules. That context can in turn be loaded from multiple XML files,
* for example split according to Struts modules. Alternatively, define one
* <code>ContextLoaderPlugIn</code> per Struts module, specifying appropriate
* {@code ContextLoaderPlugIn} per Struts module, specifying appropriate
* "contextConfigLocation" parameters. In both cases, the Spring bean name
* has to include the module prefix.
*
* <p>If you want to avoid having to specify <code>DelegatingActionProxy</code>
* as the <code>Action</code> type in your struts-config file (for example to
* <p>If you want to avoid having to specify {@code DelegatingActionProxy}
* as the {@code Action} type in your struts-config file (for example to
* be able to generate your Struts config file with XDoclet) consider using the
* {@link DelegatingRequestProcessor DelegatingRequestProcessor}.
* The latter's disadvantage is that it might conflict with the need
* for a different <code>RequestProcessor</code> subclass.
* for a different {@code RequestProcessor} subclass.
*
* <p>The default implementation delegates to the {@link DelegatingActionUtils}
* class as much as possible, to reuse as much code as possible with
* <code>DelegatingRequestProcessor</code> and
* {@code DelegatingRequestProcessor} and
* {@link DelegatingTilesRequestProcessor}.
*
* <p>Note: The idea of delegating to Spring-managed Struts Actions originated in
* Don Brown's <a href="http://struts.sourceforge.net/struts-spring">Spring Struts Plugin</a>.
* <code>ContextLoaderPlugIn</code> and <code>DelegatingActionProxy</code>
* {@code ContextLoaderPlugIn} and {@code DelegatingActionProxy}
* constitute a clean-room implementation of the same idea, essentially
* superseding the original plugin. Many thanks to Don Brown and Matt Raible
* for the original work and for the agreement to reimplement the idea in
@@ -101,7 +101,7 @@ import org.springframework.web.context.WebApplicationContext;
public class DelegatingActionProxy extends Action {
/**
* Pass the execute call on to the Spring-managed delegate <code>Action</code>.
* Pass the execute call on to the Spring-managed delegate {@code Action}.
* @see #getDelegateAction
*/
@Override
@@ -115,13 +115,13 @@ public class DelegatingActionProxy extends Action {
/**
* Return the delegate <code>Action</code> for the given <code>mapping</code>.
* Return the delegate {@code Action} for the given {@code mapping}.
* <p>The default implementation determines a bean name from the
* given <code>ActionMapping</code> and looks up the corresponding bean in
* given {@code ActionMapping} and looks up the corresponding bean in
* the {@link WebApplicationContext}.
* @param mapping the Struts <code>ActionMapping</code>
* @return the delegate <code>Action</code>
* @throws BeansException if thrown by <code>WebApplicationContext</code> methods
* @param mapping the Struts {@code ActionMapping}
* @return the delegate {@code Action}
* @throws BeansException if thrown by {@code WebApplicationContext} methods
* @see #determineActionBeanName
*/
protected Action getDelegateAction(ActionMapping mapping) throws BeansException {
@@ -132,14 +132,14 @@ public class DelegatingActionProxy extends Action {
/**
* Fetch ContextLoaderPlugIn's {@link WebApplicationContext} from the
* <code>ServletContext</code>, falling back to the root
* <code>WebApplicationContext</code>.
* <p>This context is supposed to contain the Struts <code>Action</code>
* {@code ServletContext}, falling back to the root
* {@code WebApplicationContext}.
* <p>This context is supposed to contain the Struts {@code Action}
* beans to delegate to.
* @param actionServlet the associated <code>ActionServlet</code>
* @param moduleConfig the associated <code>ModuleConfig</code>
* @return the <code>WebApplicationContext</code>
* @throws IllegalStateException if no <code>WebApplicationContext</code> could be found
* @param actionServlet the associated {@code ActionServlet}
* @param moduleConfig the associated {@code ModuleConfig}
* @return the {@code WebApplicationContext}
* @throws IllegalStateException if no {@code WebApplicationContext} could be found
* @see DelegatingActionUtils#findRequiredWebApplicationContext
* @see ContextLoaderPlugIn#SERVLET_CONTEXT_PREFIX
*/
@@ -150,14 +150,14 @@ public class DelegatingActionProxy extends Action {
}
/**
* Determine the name of the <code>Action</code> bean, to be looked up in
* the <code>WebApplicationContext</code>.
* Determine the name of the {@code Action} bean, to be looked up in
* the {@code WebApplicationContext}.
* <p>The default implementation takes the
* {@link org.apache.struts.action.ActionMapping#getPath mapping path} and
* prepends the
* {@link org.apache.struts.config.ModuleConfig#getPrefix module prefix},
* if any.
* @param mapping the Struts <code>ActionMapping</code>
* @param mapping the Struts {@code ActionMapping}
* @return the name of the Action bean
* @see DelegatingActionUtils#determineActionBeanName
* @see org.apache.struts.action.ActionMapping#getPath

View File

@@ -79,8 +79,8 @@ public abstract class DelegatingActionUtils {
* <p>Checks for a module-specific context first, falling back to the
* context for the default module else.
* @param actionServlet the associated ActionServlet
* @param moduleConfig the associated ModuleConfig (can be <code>null</code>)
* @return the WebApplicationContext, or <code>null</code> if none
* @param moduleConfig the associated ModuleConfig (can be {@code null})
* @return the WebApplicationContext, or {@code null} if none
* @see ContextLoaderPlugIn#SERVLET_CONTEXT_PREFIX
*/
public static WebApplicationContext getWebApplicationContext(
@@ -110,7 +110,7 @@ public abstract class DelegatingActionUtils {
* <p>Checks for a module-specific context first, falling back to the
* context for the default module else.
* @param actionServlet the associated ActionServlet
* @param moduleConfig the associated ModuleConfig (can be <code>null</code>)
* @param moduleConfig the associated ModuleConfig (can be {@code null})
* @return the WebApplicationContext
* @throws IllegalStateException if no WebApplicationContext could be found
* @see ContextLoaderPlugIn#SERVLET_CONTEXT_PREFIX
@@ -135,7 +135,7 @@ public abstract class DelegatingActionUtils {
* <p>When checking the ContextLoaderPlugIn context: checks for a module-specific
* context first, falling back to the context for the default module else.
* @param actionServlet the associated ActionServlet
* @param moduleConfig the associated ModuleConfig (can be <code>null</code>)
* @param moduleConfig the associated ModuleConfig (can be {@code null})
* @return the WebApplicationContext
* @throws IllegalStateException if no WebApplicationContext could be found
* @see #getWebApplicationContext

View File

@@ -35,12 +35,12 @@ import org.springframework.web.context.WebApplicationContext;
* Subclass of Struts's default {@link RequestProcessor} that looks up
* Spring-managed Struts {@link Action Actions} defined in
* {@link ContextLoaderPlugIn ContextLoaderPlugIn's} {@link WebApplicationContext}
* (or, as a fallback, in the root <code>WebApplicationContext</code>).
* (or, as a fallback, in the root {@code WebApplicationContext}).
*
* <p>In the Struts config file, you can either specify the original
* <code>Action</code> class (as when generated by XDoclet), or no
* <code>Action</code> class at all. In any case, Struts will delegate to an
* <code>Action</code> bean in the <code>ContextLoaderPlugIn</code> context.
* {@code Action} class (as when generated by XDoclet), or no
* {@code Action} class at all. In any case, Struts will delegate to an
* {@code Action} bean in the {@code ContextLoaderPlugIn} context.
*
* <pre class="code">&lt;action path="/login" type="myapp.MyAction"/&gt;</pre>
*
@@ -48,8 +48,8 @@ import org.springframework.web.context.WebApplicationContext;
*
* <pre class="code">&lt;action path="/login"/&gt;</pre>
*
* The name of the <code>Action</code> bean in the
* <code>WebApplicationContext</code> will be determined from the mapping path
* The name of the {@code Action} bean in the
* {@code WebApplicationContext} will be determined from the mapping path
* and module prefix. This can be customized by overriding the
* {@link #determineActionBeanName} method.
*
@@ -60,8 +60,8 @@ import org.springframework.web.context.WebApplicationContext;
* bean name "/mymodule/login"
* </ul>
*
* <p>A corresponding bean definition in the <code>ContextLoaderPlugin</code>
* context would look as follows; notice that the <code>Action</code> is now
* <p>A corresponding bean definition in the {@code ContextLoaderPlugin}
* context would look as follows; notice that the {@code Action} is now
* able to leverage fully Spring's configuration facilities:
*
* <pre class="code">
@@ -69,31 +69,31 @@ import org.springframework.web.context.WebApplicationContext;
* &lt;property name="..."&gt;...&lt;/property&gt;
* &lt;/bean&gt;</pre>
*
* Note that you can use a single <code>ContextLoaderPlugIn</code> for all
* Note that you can use a single {@code ContextLoaderPlugIn} for all
* Struts modules. That context can in turn be loaded from multiple XML files,
* for example split according to Struts modules. Alternatively, define one
* <code>ContextLoaderPlugIn</code> per Struts module, specifying appropriate
* {@code ContextLoaderPlugIn} per Struts module, specifying appropriate
* "contextConfigLocation" parameters. In both cases, the Spring bean name has
* to include the module prefix.
*
* <p>If you also need the Tiles setup functionality of the original
* <code>TilesRequestProcessor</code>, use
* <code>DelegatingTilesRequestProcessor</code>. As there is just a
* {@code TilesRequestProcessor}, use
* {@code DelegatingTilesRequestProcessor}. As there is just a
* single central class to customize in Struts, we have to provide another
* subclass here, covering both the Tiles and the Spring delegation aspect.
*
* <p>If this <code>RequestProcessor</code> conflicts with the need for a
* different <code>RequestProcessor</code> subclass (other than
* <code>TilesRequestProcessor</code>), consider using
* {@link DelegatingActionProxy} as the Struts <code>Action</code> type in
* <p>If this {@code RequestProcessor} conflicts with the need for a
* different {@code RequestProcessor} subclass (other than
* {@code TilesRequestProcessor}), consider using
* {@link DelegatingActionProxy} as the Struts {@code Action} type in
* your struts-config file.
*
* <p>The default implementation delegates to the
* <code>DelegatingActionUtils</code> class as much as possible, to reuse as
* {@code DelegatingActionUtils} class as much as possible, to reuse as
* much code as possible despite the need to provide two
* <code>RequestProcessor</code> subclasses. If you need to subclass yet
* another <code>RequestProcessor</code>, take this class as a template,
* delegating to <code>DelegatingActionUtils</code> just like it.
* {@code RequestProcessor} subclasses. If you need to subclass yet
* another {@code RequestProcessor}, take this class as a template,
* delegating to {@code DelegatingActionUtils} just like it.
*
* @author Juergen Hoeller
* @since 1.0.2
@@ -120,14 +120,14 @@ public class DelegatingRequestProcessor extends RequestProcessor {
/**
* Fetch ContextLoaderPlugIn's {@link WebApplicationContext} from the
* <code>ServletContext</code>, falling back to the root
* <code>WebApplicationContext</code>.
* <p>This context is supposed to contain the Struts <code>Action</code>
* {@code ServletContext}, falling back to the root
* {@code WebApplicationContext}.
* <p>This context is supposed to contain the Struts {@code Action}
* beans to delegate to.
* @param actionServlet the associated <code>ActionServlet</code>
* @param moduleConfig the associated <code>ModuleConfig</code>
* @return the <code>WebApplicationContext</code>
* @throws IllegalStateException if no <code>WebApplicationContext</code> could be found
* @param actionServlet the associated {@code ActionServlet}
* @param moduleConfig the associated {@code ModuleConfig}
* @return the {@code WebApplicationContext}
* @throws IllegalStateException if no {@code WebApplicationContext} could be found
* @see DelegatingActionUtils#findRequiredWebApplicationContext
* @see ContextLoaderPlugIn#SERVLET_CONTEXT_PREFIX
*/
@@ -138,7 +138,7 @@ public class DelegatingRequestProcessor extends RequestProcessor {
}
/**
* Return the <code>WebApplicationContext</code> that this processor
* Return the {@code WebApplicationContext} that this processor
* delegates to.
*/
protected final WebApplicationContext getWebApplicationContext() {
@@ -163,13 +163,13 @@ public class DelegatingRequestProcessor extends RequestProcessor {
}
/**
* Return the delegate <code>Action</code> for the given mapping.
* Return the delegate {@code Action} for the given mapping.
* <p>The default implementation determines a bean name from the
* given <code>ActionMapping</code> and looks up the corresponding
* bean in the <code>WebApplicationContext</code>.
* @param mapping the Struts <code>ActionMapping</code>
* @return the delegate <code>Action</code>, or <code>null</code> if none found
* @throws BeansException if thrown by <code>WebApplicationContext</code> methods
* given {@code ActionMapping} and looks up the corresponding
* bean in the {@code WebApplicationContext}.
* @param mapping the Struts {@code ActionMapping}
* @return the delegate {@code Action}, or {@code null} if none found
* @throws BeansException if thrown by {@code WebApplicationContext} methods
* @see #determineActionBeanName
*/
protected Action getDelegateAction(ActionMapping mapping) throws BeansException {
@@ -181,14 +181,14 @@ public class DelegatingRequestProcessor extends RequestProcessor {
}
/**
* Determine the name of the <code>Action</code> bean, to be looked up in
* the <code>WebApplicationContext</code>.
* Determine the name of the {@code Action} bean, to be looked up in
* the {@code WebApplicationContext}.
* <p>The default implementation takes the
* {@link org.apache.struts.action.ActionMapping#getPath mapping path} and
* prepends the
* {@link org.apache.struts.config.ModuleConfig#getPrefix module prefix},
* if any.
* @param mapping the Struts <code>ActionMapping</code>
* @param mapping the Struts {@code ActionMapping}
* @return the name of the Action bean
* @see DelegatingActionUtils#determineActionBeanName
* @see org.apache.struts.action.ActionMapping#getPath

View File

@@ -117,7 +117,7 @@ public class DelegatingTilesRequestProcessor extends TilesRequestProcessor {
* given ActionMapping and looks up the corresponding bean in the
* WebApplicationContext.
* @param mapping the Struts ActionMapping
* @return the delegate Action, or <code>null</code> if none found
* @return the delegate Action, or {@code null} if none found
* @throws BeansException if thrown by WebApplicationContext methods
* @see #determineActionBeanName
*/

View File

@@ -49,21 +49,21 @@ import org.springframework.validation.ObjectError;
* rejected values (which Spring's binding keeps even for non-String fields).
*
* <p>Consequently, Struts views can be written in a completely traditional
* fashion (with standard <code>html:form</code>, <code>html:errors</code>, etc),
* fashion (with standard {@code html:form}, {@code html:errors}, etc),
* seamlessly accessing a Spring-bound POJO form object underneath.
*
* <p>Note this ActionForm is designed explicitly for use in <i>request scope</i>.
* It expects to receive an <code>expose</code> call from the Action, passing
* It expects to receive an {@code expose} call from the Action, passing
* in the Errors object to expose plus the current HttpServletRequest.
*
* <p>Example definition in <code>struts-config.xml</code>:
* <p>Example definition in {@code struts-config.xml}:
*
* <pre>
* &lt;form-beans&gt;
* &lt;form-bean name="actionForm" type="org.springframework.web.struts.SpringBindingActionForm"/&gt;
* &lt;/form-beans&gt;</pre>
*
* Example code in a custom Struts <code>Action</code>:
* Example code in a custom Struts {@code Action}:
*
* <pre>
* public ActionForward execute(ActionMapping actionMapping, ActionForm actionForm, HttpServletRequest request, HttpServletResponse response) throws Exception {