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

@@ -51,7 +51,7 @@ import org.springframework.util.comparator.CompoundComparator;
public class MediaType implements Comparable<MediaType> {
/**
* Public constant media type that includes all media ranges (i.e. <code>&#42;/&#42;</code>).
* Public constant media type that includes all media ranges (i.e. {@code &#42;/&#42;}).
*/
public static final MediaType ALL;
@@ -260,7 +260,7 @@ public class MediaType implements Comparable<MediaType> {
/**
* Create a new {@code MediaType} for the given primary type.
* <p>The {@linkplain #getSubtype() subtype} is set to <code>&#42;</code>, parameters empty.
* <p>The {@linkplain #getSubtype() subtype} is set to {@code &#42;}, parameters empty.
* @param type the primary type
* @throws IllegalArgumentException if any of the parameters contain illegal characters
*/
@@ -306,7 +306,7 @@ public class MediaType implements Comparable<MediaType> {
* Copy-constructor that copies the type and subtype of the given {@code MediaType},
* and allows for different parameter.
* @param other the other media type
* @param parameters the parameters, may be <code>null</code>
* @param parameters the parameters, may be {@code null}
* @throws IllegalArgumentException if any of the parameters contain illegal characters
*/
public MediaType(MediaType other, Map<String, String> parameters) {
@@ -317,7 +317,7 @@ public class MediaType implements Comparable<MediaType> {
* Create a new {@code MediaType} for the given type, subtype, and parameters.
* @param type the primary type
* @param subtype the subtype
* @param parameters the parameters, may be <code>null</code>
* @param parameters the parameters, may be {@code null}
* @throws IllegalArgumentException if any of the parameters contain illegal characters
*/
public MediaType(String type, String subtype, Map<String, String> parameters) {
@@ -399,7 +399,7 @@ public class MediaType implements Comparable<MediaType> {
}
/**
* Indicates whether the {@linkplain #getType() type} is the wildcard character <code>&#42;</code> or not.
* Indicates whether the {@linkplain #getType() type} is the wildcard character {@code &#42;} or not.
*/
public boolean isWildcardType() {
return WILDCARD_TYPE.equals(type);
@@ -413,9 +413,9 @@ public class MediaType implements Comparable<MediaType> {
}
/**
* Indicates whether the {@linkplain #getSubtype() subtype} is the wildcard character <code>&#42;</code>
* or the wildcard character followed by a sufiix (e.g. <code>&#42;+xml</code>), or not.
* @return whether the subtype is <code>&#42;</code>
* Indicates whether the {@linkplain #getSubtype() subtype} is the wildcard character {@code &#42;}
* or the wildcard character followed by a sufiix (e.g. {@code &#42;+xml}), or not.
* @return whether the subtype is {@code &#42;}
*/
public boolean isWildcardSubtype() {
return WILDCARD_TYPE.equals(subtype) || subtype.startsWith("*+");
@@ -423,7 +423,7 @@ public class MediaType implements Comparable<MediaType> {
/**
* Indicates whether this media type is concrete, i.e. whether neither the type or subtype is a wildcard
* character <code>&#42;</code>.
* character {@code &#42;}.
* @return whether this media type is concrete
*/
public boolean isConcrete() {
@@ -431,8 +431,8 @@ public class MediaType implements Comparable<MediaType> {
}
/**
* Return the character set, as indicated by a <code>charset</code> parameter, if any.
* @return the character set; or <code>null</code> if not available
* Return the character set, as indicated by a {@code charset} parameter, if any.
* @return the character set; or {@code null} if not available
*/
public Charset getCharSet() {
String charSet = getParameter(PARAM_CHARSET);
@@ -440,8 +440,8 @@ public class MediaType implements Comparable<MediaType> {
}
/**
* Return the quality value, as indicated by a <code>q</code> parameter, if any.
* Defaults to <code>1.0</code>.
* Return the quality value, as indicated by a {@code q} parameter, if any.
* Defaults to {@code 1.0}.
* @return the quality factory
*/
public double getQualityValue() {
@@ -452,7 +452,7 @@ public class MediaType implements Comparable<MediaType> {
/**
* Return a generic parameter value, given a parameter name.
* @param name the parameter name
* @return the parameter value; or <code>null</code> if not present
* @return the parameter value; or {@code null} if not present
*/
public String getParameter(String name) {
return this.parameters.get(name);
@@ -460,7 +460,7 @@ public class MediaType implements Comparable<MediaType> {
/**
* Return all generic parameter values.
* @return a read-only map, possibly empty, never <code>null</code>
* @return a read-only map, possibly empty, never {@code null}
*/
public Map<String, String> getParameters() {
return parameters;
@@ -471,7 +471,7 @@ public class MediaType implements Comparable<MediaType> {
* <p>For instance, {@code text/*} includes {@code text/plain} and {@code text/html}, and {@code application/*+xml}
* includes {@code application/soap+xml}, etc. This method is <b>not</b> symmetric.
* @param other the reference media type with which to compare
* @return <code>true</code> if this media type includes the given media type; <code>false</code> otherwise
* @return {@code true} if this media type includes the given media type; {@code false} otherwise
*/
public boolean includes(MediaType other) {
if (other == null) {
@@ -513,7 +513,7 @@ public class MediaType implements Comparable<MediaType> {
* <p>For instance, {@code text/*} is compatible with {@code text/plain}, {@code text/html}, and vice versa.
* In effect, this method is similar to {@link #includes(MediaType)}, except that it <b>is</b> symmetric.
* @param other the reference media type with which to compare
* @return <code>true</code> if this media type is compatible with the given media type; <code>false</code> otherwise
* @return {@code true} if this media type is compatible with the given media type; {@code false} otherwise
*/
public boolean isCompatibleWith(MediaType other) {
if (other == null) {

View File

@@ -22,8 +22,8 @@ import org.springframework.util.StringUtils;
/**
* {@link java.beans.PropertyEditor Editor} for {@link MediaType}
* descriptors, to automatically convert <code>String</code> specifications
* (e.g. <code>"text/html"</code>) to <code>MediaType</code> properties.
* descriptors, to automatically convert {@code String} specifications
* (e.g. {@code "text/html"}) to {@code MediaType} properties.
*
* @author Juergen Hoeller
* @since 3.0

View File

@@ -25,7 +25,7 @@ import org.springframework.http.HttpRequest;
/**
* Represents a client-side HTTP request. Created via an implementation of the {@link ClientHttpRequestFactory}.
*
* <p>A <code>HttpRequest</code> can be {@linkplain #execute() executed}, getting a {@link ClientHttpResponse}
* <p>A {@code HttpRequest} can be {@linkplain #execute() executed}, getting a {@link ClientHttpResponse}
* which can be read from.
*
* @author Arjen Poutsma

View File

@@ -25,8 +25,8 @@ import org.springframework.http.HttpStatus;
/**
* Represents a client-side HTTP response. Obtained via an calling of the {@link ClientHttpRequest#execute()}.
*
* <p>A <code>ClientHttpResponse</code> must be {@linkplain #close() closed}, typically in a
* <code>finally</code> block.
* <p>A {@code ClientHttpResponse} must be {@linkplain #close() closed}, typically in a
* {@code finally} block.
*
* @author Arjen Poutsma
* @since 3.0

View File

@@ -56,7 +56,7 @@ public class CommonsClientHttpRequestFactory implements ClientHttpRequestFactory
/**
* Create a new instance of the <code>CommonsHttpRequestFactory</code> with a default
* Create a new instance of the {@code CommonsHttpRequestFactory} with a default
* {@link HttpClient} that uses a default {@link MultiThreadedHttpConnectionManager}.
*/
public CommonsClientHttpRequestFactory() {
@@ -65,7 +65,7 @@ public class CommonsClientHttpRequestFactory implements ClientHttpRequestFactory
}
/**
* Create a new instance of the <code>CommonsHttpRequestFactory</code> with the given
* Create a new instance of the {@code CommonsHttpRequestFactory} with the given
* {@link HttpClient} instance.
* @param httpClient the HttpClient instance to use for this factory
*/
@@ -76,14 +76,14 @@ public class CommonsClientHttpRequestFactory implements ClientHttpRequestFactory
/**
* Set the <code>HttpClient</code> used by this factory.
* Set the {@code HttpClient} used by this factory.
*/
public void setHttpClient(HttpClient httpClient) {
this.httpClient = httpClient;
}
/**
* Return the <code>HttpClient</code> used by this factory.
* Return the {@code HttpClient} used by this factory.
*/
public HttpClient getHttpClient() {
return this.httpClient;

View File

@@ -1,9 +1,8 @@
/**
*
* Contains an abstraction over client-side HTTP. This package
* contains the <code>ClientHttpRequest</code> and
* <code>ClientHttpResponse</code>, as well as a basic implementation of these
* contains the {@code ClientHttpRequest} and
* {@code ClientHttpResponse}, as well as a basic implementation of these
* interfaces.
*
*/

View File

@@ -187,7 +187,7 @@ public abstract class AbstractHttpMessageConverter<T> implements HttpMessageConv
* {@link #setSupportedMediaTypes(List) supportedMediaTypes} property, if any.
* Can be overridden in subclasses.
* @param t the type to return the content type for
* @return the content type, or <code>null</code> if not known
* @return the content type, or {@code null} if not known
*/
protected MediaType getDefaultContentType(T t) throws IOException {
List<MediaType> mediaTypes = getSupportedMediaTypes();
@@ -209,7 +209,7 @@ public abstract class AbstractHttpMessageConverter<T> implements HttpMessageConv
/**
* Indicates whether the given class is supported by this converter.
* @param clazz the class to test for support
* @return <code>true</code> if supported; <code>false</code> otherwise
* @return {@code true} if supported; {@code false} otherwise
*/
protected abstract boolean supports(Class<?> clazz);

View File

@@ -27,7 +27,7 @@ import org.springframework.util.FileCopyUtils;
/**
* Implementation of {@link HttpMessageConverter} that can read and write byte arrays.
*
* <p>By default, this converter supports all media types (<code>&#42;&#47;&#42;</code>), and writes with a {@code
* <p>By default, this converter supports all media types ({@code &#42;&#47;&#42;}), and writes with a {@code
* Content-Type} of {@code application/octet-stream}. This can be overridden by setting the {@link
* #setSupportedMediaTypes(java.util.List) supportedMediaTypes} property.
*

View File

@@ -32,7 +32,7 @@ import org.springframework.util.FileCopyUtils;
/**
* Implementation of {@link HttpMessageConverter} that can read and write strings.
*
* <p>By default, this converter supports all media types (<code>&#42;&#47;&#42;</code>),
* <p>By default, this converter supports all media types ({@code &#42;&#47;&#42;}),
* and writes with a {@code Content-Type} of {@code text/plain}. This can be overridden
* by setting the {@link #setSupportedMediaTypes supportedMediaTypes} property.
*

View File

@@ -228,7 +228,7 @@ public class MappingJackson2HttpMessageConverter extends AbstractHttpMessageConv
/**
* Determine the JSON encoding to use for the given content type.
* @param contentType the media type as requested by the caller
* @return the JSON encoding to use (never <code>null</code>)
* @return the JSON encoding to use (never {@code null})
*/
protected JsonEncoding getJsonEncoding(MediaType contentType) {
if (contentType != null && contentType.getCharSet() != null) {

View File

@@ -224,7 +224,7 @@ public class MappingJacksonHttpMessageConverter extends AbstractHttpMessageConve
/**
* Determine the JSON encoding to use for the given content type.
* @param contentType the media type as requested by the caller
* @return the JSON encoding to use (never <code>null</code>)
* @return the JSON encoding to use (never {@code null})
*/
protected JsonEncoding getJsonEncoding(MediaType contentType) {
if (contentType != null && contentType.getCharSet() != null) {

View File

@@ -76,7 +76,7 @@ public class MarshallingHttpMessageConverter extends AbstractXmlHttpMessageConve
}
/**
* Construct a new <code>MarshallingMessageConverter</code> with the given
* Construct a new {@code MarshallingMessageConverter} with the given
* {@code Marshaller} and {@code Unmarshaller}.
* @param marshaller the Marshaller to use
* @param unmarshaller the Unmarshaller to use

View File

@@ -1,8 +1,7 @@
/**
*
* Contains a basic abstraction over client/server-side HTTP. This package contains
* the <code>HttpInputMessage</code> and <code>HttpOutputMessage</code> interfaces.
* the {@code HttpInputMessage} and {@code HttpOutputMessage} interfaces.
*
*/
package org.springframework.http;

View File

@@ -1,9 +1,8 @@
/**
*
* Contains an abstraction over server-side HTTP. This package
* contains the <code>ServerHttpRequest</code> and
* <code>ServerHttpResponse</code>, as well as a Servlet-based implementation of these
* contains the {@code ServerHttpRequest} and
* {@code ServerHttpResponse}, as well as a Servlet-based implementation of these
* interfaces.
*
*/

View File

@@ -81,7 +81,7 @@ public class HessianClientInterceptor extends UrlBasedRemoteAccessor implements
/**
* Specify the Hessian SerializerFactory to use.
* <p>This will typically be passed in as an inner bean definition
* of type <code>com.caucho.hessian.io.SerializerFactory</code>,
* of type {@code com.caucho.hessian.io.SerializerFactory},
* with custom bean property values applied.
*/
public void setSerializerFactory(SerializerFactory serializerFactory) {

View File

@@ -68,7 +68,7 @@ public class HessianExporter extends RemoteExporter implements InitializingBean
/**
* Specify the Hessian SerializerFactory to use.
* <p>This will typically be passed in as an inner bean definition
* of type <code>com.caucho.hessian.io.SerializerFactory</code>,
* of type {@code com.caucho.hessian.io.SerializerFactory},
* with custom bean property values applied.
*/
public void setSerializerFactory(SerializerFactory serializerFactory) {

View File

@@ -150,10 +150,10 @@ public abstract class AbstractHttpInvokerRequestExecutor
/**
* Serialize the given RemoteInvocation to the given OutputStream.
* <p>The default implementation gives <code>decorateOutputStream</code> a chance
* <p>The default implementation gives {@code decorateOutputStream} a chance
* to decorate the stream first (for example, for custom encryption or compression).
* Creates an <code>ObjectOutputStream</code> for the final stream and calls
* <code>doWriteRemoteInvocation</code> to actually write the object.
* Creates an {@code ObjectOutputStream} for the final stream and calls
* {@code doWriteRemoteInvocation} to actually write the object.
* <p>Can be overridden for custom serialization of the invocation.
* @param invocation the RemoteInvocation object
* @param os the OutputStream to write to
@@ -186,7 +186,7 @@ public abstract class AbstractHttpInvokerRequestExecutor
/**
* Perform the actual writing of the given invocation object to the
* given ObjectOutputStream.
* <p>The default implementation simply calls <code>writeObject</code>.
* <p>The default implementation simply calls {@code writeObject}.
* Can be overridden for serialization of a custom wrapper object rather
* than the plain invocation, for example an encryption-aware holder.
* @param invocation the RemoteInvocation object
@@ -201,7 +201,7 @@ public abstract class AbstractHttpInvokerRequestExecutor
/**
* Execute a request to send the given serialized remote invocation.
* <p>Implementations will usually call <code>readRemoteInvocationResult</code>
* <p>Implementations will usually call {@code readRemoteInvocationResult}
* to deserialize a returned RemoteInvocationResult object.
* @param config the HTTP invoker configuration that specifies the
* target service
@@ -219,10 +219,10 @@ public abstract class AbstractHttpInvokerRequestExecutor
/**
* Deserialize a RemoteInvocationResult object from the given InputStream.
* <p>Gives <code>decorateInputStream</code> a chance to decorate the stream
* <p>Gives {@code decorateInputStream} a chance to decorate the stream
* first (for example, for custom encryption or compression). Creates an
* <code>ObjectInputStream</code> via <code>createObjectInputStream</code> and
* calls <code>doReadRemoteInvocationResult</code> to actually read the object.
* {@code ObjectInputStream} via {@code createObjectInputStream} and
* calls {@code doReadRemoteInvocationResult} to actually read the object.
* <p>Can be overridden for custom serialization of the invocation.
* @param is the InputStream to read from
* @param codebaseUrl the codebase URL to load classes from if not found locally
@@ -262,7 +262,7 @@ public abstract class AbstractHttpInvokerRequestExecutor
* The default implementation creates a CodebaseAwareObjectInputStream.
* @param is the InputStream to read from
* @param codebaseUrl the codebase URL to load classes from if not found locally
* (can be <code>null</code>)
* (can be {@code null})
* @return the new ObjectInputStream instance to use
* @throws IOException if creation of the ObjectInputStream failed
* @see org.springframework.remoting.rmi.CodebaseAwareObjectInputStream
@@ -274,7 +274,7 @@ public abstract class AbstractHttpInvokerRequestExecutor
/**
* Perform the actual reading of an invocation object from the
* given ObjectInputStream.
* <p>The default implementation simply calls <code>readObject</code>.
* <p>The default implementation simply calls {@code readObject}.
* Can be overridden for deserialization of a custom wrapper object rather
* than the plain invocation, for example an encryption-aware holder.
* @param ois the ObjectInputStream to read from

View File

@@ -34,7 +34,7 @@ public interface HttpInvokerClientConfiguration {
/**
* Return the codebase URL to download classes from if not found locally.
* Can consist of multiple URLs, separated by spaces.
* @return the codebase URL, or <code>null</code> if none
* @return the codebase URL, or {@code null} if none
* @see java.rmi.server.RMIClassLoader
*/
String getCodebaseUrl();

View File

@@ -73,7 +73,7 @@ import org.springframework.util.ReflectionUtils;
* @see javax.xml.rpc.Service#getPort
* @see org.springframework.remoting.RemoteAccessException
* @see org.springframework.jndi.JndiObjectFactoryBean
* @deprecated in favor of JAX-WS support in <code>org.springframework.remoting.jaxws</code>
* @deprecated in favor of JAX-WS support in {@code org.springframework.remoting.jaxws}
*/
@Deprecated
public class JaxRpcPortClientInterceptor extends LocalJaxRpcServiceFactory
@@ -292,7 +292,7 @@ public class JaxRpcPortClientInterceptor extends LocalJaxRpcServiceFactory
* port stub should be used instead of the dynamic call mechanism.
* See the javadoc of the "serviceInterface" property for more details.
* <p>The interface must be suitable for a JAX-RPC port, that is, it must be
* an RMI service interface (that extends <code>java.rmi.Remote</code>).
* an RMI service interface (that extends {@code java.rmi.Remote}).
* <p><b>NOTE:</b> Check whether your JAX-RPC provider returns thread-safe
* port stubs. If not, use the dynamic call mechanism instead, which will
* always be thread-safe. In particular, do not use JAX-RPC port stubs
@@ -354,7 +354,7 @@ public class JaxRpcPortClientInterceptor extends LocalJaxRpcServiceFactory
* Create and initialize the JAX-RPC service for the specified port.
* <p>Prepares a JAX-RPC stub if possible (if an RMI interface is available);
* falls back to JAX-RPC dynamic calls else. Using dynamic calls can be enforced
* through overriding {@link #alwaysUseJaxRpcCall} to return <code>true</code>.
* through overriding {@link #alwaysUseJaxRpcCall} to return {@code true}.
* <p>{@link #postProcessJaxRpcService} and {@link #postProcessPortStub}
* hooks are available for customization in subclasses. When using dynamic calls,
* each can be post-processed via {@link #postProcessJaxRpcCall}.
@@ -432,7 +432,7 @@ public class JaxRpcPortClientInterceptor extends LocalJaxRpcServiceFactory
/**
* Return whether to always use JAX-RPC dynamic calls.
* Called by <code>afterPropertiesSet</code>.
* Called by {@code afterPropertiesSet}.
* <p>Default is "false"; if an RMI interface is specified as "portInterface"
* or "serviceInterface", it will be used to create a JAX-RPC port stub.
* <p>Can be overridden to enforce the use of the JAX-RPC Call API,
@@ -708,7 +708,7 @@ public class JaxRpcPortClientInterceptor extends LocalJaxRpcServiceFactory
* @param method the service interface method that we invoked
* @param ex the original RemoteException
* @return the exception to rethrow (may be the original RemoteException
* or an extracted/wrapped exception, but never <code>null</code>)
* or an extracted/wrapped exception, but never {@code null})
*/
protected Throwable handleRemoteException(Method method, RemoteException ex) {
boolean isConnectFailure = isConnectFailure(ex);
@@ -733,7 +733,7 @@ public class JaxRpcPortClientInterceptor extends LocalJaxRpcServiceFactory
/**
* Determine whether the given RMI exception indicates a connect failure.
* <p>The default implementation returns <code>true</code> unless the
* <p>The default implementation returns {@code true} unless the
* exception class name (or exception superclass name) contains the term
* "Fault" (e.g. "AxisFault"), assuming that the JAX-RPC provider only
* throws RemoteException in case of WSDL faults and connect failures.

View File

@@ -43,7 +43,7 @@ import org.springframework.util.ClassUtils;
* @see #setServiceInterface
* @see #setPortInterface
* @see LocalJaxRpcServiceFactoryBean
* @deprecated in favor of JAX-WS support in <code>org.springframework.remoting.jaxws</code>
* @deprecated in favor of JAX-WS support in {@code org.springframework.remoting.jaxws}
*/
@Deprecated
public class JaxRpcPortProxyFactoryBean extends JaxRpcPortClientInterceptor

View File

@@ -32,14 +32,14 @@ import javax.xml.rpc.Service;
* @see JaxRpcPortClientInterceptor#setServicePostProcessors
* @see JaxRpcPortProxyFactoryBean#setServicePostProcessors
* @see javax.xml.rpc.Service#getTypeMappingRegistry
* @deprecated in favor of JAX-WS support in <code>org.springframework.remoting.jaxws</code>
* @deprecated in favor of JAX-WS support in {@code org.springframework.remoting.jaxws}
*/
@Deprecated
public interface JaxRpcServicePostProcessor {
/**
* Post-process the given JAX-RPC {@link Service}.
* @param service the current JAX-RPC <code>Service</code>
* @param service the current JAX-RPC {@code Service}
* (can be cast to an implementation-specific class if necessary)
*/
void postProcessJaxRpcService(Service service);

View File

@@ -27,7 +27,7 @@ import org.springframework.remoting.soap.SoapFaultException;
*
* @author Juergen Hoeller
* @since 2.5
* @deprecated in favor of JAX-WS support in <code>org.springframework.remoting.jaxws</code>
* @deprecated in favor of JAX-WS support in {@code org.springframework.remoting.jaxws}
*/
@Deprecated
public class JaxRpcSoapFaultException extends SoapFaultException {

View File

@@ -43,7 +43,7 @@ import org.springframework.beans.BeanUtils;
* @see LocalJaxRpcServiceFactoryBean
* @see JaxRpcPortClientInterceptor
* @see JaxRpcPortProxyFactoryBean
* @deprecated in favor of JAX-WS support in <code>org.springframework.remoting.jaxws</code>
* @deprecated in favor of JAX-WS support in {@code org.springframework.remoting.jaxws}
*/
@Deprecated
public class LocalJaxRpcServiceFactory {
@@ -100,7 +100,7 @@ public class LocalJaxRpcServiceFactory {
}
/**
* Return the ServiceFactory class to use, or <code>null</code> if default.
* Return the ServiceFactory class to use, or {@code null} if default.
*/
public Class getServiceFactoryClass() {
return this.serviceFactoryClass;

View File

@@ -35,7 +35,7 @@ import org.springframework.beans.factory.InitializingBean;
* @see javax.xml.rpc.Service
* @see org.springframework.jndi.JndiObjectFactoryBean
* @see JaxRpcPortProxyFactoryBean
* @deprecated in favor of JAX-WS support in <code>org.springframework.remoting.jaxws</code>
* @deprecated in favor of JAX-WS support in {@code org.springframework.remoting.jaxws}
*/
@Deprecated
public class LocalJaxRpcServiceFactoryBean extends LocalJaxRpcServiceFactory

View File

@@ -56,7 +56,7 @@ import org.springframework.web.util.WebUtils;
* @since 16.12.2003
* @see #init
* @see #getWebApplicationContext
* @deprecated in favor of JAX-WS support in <code>org.springframework.remoting.jaxws</code>
* @deprecated in favor of JAX-WS support in {@code org.springframework.remoting.jaxws}
*/
@Deprecated
public abstract class ServletEndpointSupport implements ServiceLifecycle {

View File

@@ -403,7 +403,7 @@ public class JaxWsPortClientInterceptor extends LocalJaxWsServiceFactory
* @param service the Service object to obtain the port from
* @param portQName the name of the desired port, if specified
* @return the corresponding port object as returned from
* <code>Service.getPort(...)</code>
* {@code Service.getPort(...)}
*/
protected Object getPortStub(Service service, QName portQName) {
if (this.webServiceFeatures != null) {

View File

@@ -32,8 +32,8 @@ import javax.servlet.http.HttpServletResponse;
* <p>The easiest way to expose an HttpRequestHandler bean in Spring style
* is to define it in Spring's root web application context and define
* an {@link org.springframework.web.context.support.HttpRequestHandlerServlet}
* in <code>web.xml</code>, pointing at the target HttpRequestHandler bean
* through its <code>servlet-name</code> which needs to match the target bean name.
* in {@code web.xml}, pointing at the target HttpRequestHandler bean
* through its {@code servlet-name} which needs to match the target bean name.
*
* <p>Supported as a handler type within Spring's
* {@link org.springframework.web.servlet.DispatcherServlet}, being able
@@ -61,7 +61,7 @@ import javax.servlet.http.HttpServletResponse;
* DispatcherServlet</i>. However, this is usually not necessary, since
* HttpRequestHandlers typically only support POST requests to begin with.
* Alternatively, a handler may implement the "If-Modified-Since" HTTP
* header processing manually within its <code>handle</code> method.
* header processing manually within its {@code handle} method.
*
* @author Juergen Hoeller
* @since 2.0

View File

@@ -27,7 +27,7 @@ import org.springframework.web.util.HtmlUtils;
/**
* Errors wrapper that adds automatic HTML escaping to the wrapped instance,
* for convenient usage in HTML views. Can be retrieved easily via
* RequestContext's <code>getErrors</code> method.
* RequestContext's {@code getErrors} method.
*
* <p>Note that BindTag does <i>not</i> use this class to avoid unnecessary
* creation of ObjectError instances. It just escapes the messages and values

View File

@@ -33,12 +33,12 @@ import org.springframework.web.util.WebUtils;
*
* <p>Used by Spring Web MVC's BaseCommandController and MultiActionController.
* Note that BaseCommandController and its subclasses allow for easy customization
* of the binder instances that they use through overriding <code>initBinder</code>.
* of the binder instances that they use through overriding {@code initBinder}.
*
* <p>Can also be used for manual data binding in custom web controllers:
* for example, in a plain Controller implementation or in a MultiActionController
* handler method. Simply instantiate a ServletRequestDataBinder for each binding
* process, and invoke <code>bind</code> with the current ServletRequest as argument:
* process, and invoke {@code bind} with the current ServletRequest as argument:
*
* <pre class="code">
* MyBean myBean = new MyBean();
@@ -65,7 +65,7 @@ public class ServletRequestDataBinder extends WebDataBinder {
/**
* Create a new ServletRequestDataBinder instance, with default object name.
* @param target the target object to bind onto (or <code>null</code>
* @param target the target object to bind onto (or {@code null}
* if the binder is just used to convert a plain parameter value)
* @see #DEFAULT_OBJECT_NAME
*/
@@ -75,7 +75,7 @@ public class ServletRequestDataBinder extends WebDataBinder {
/**
* Create a new ServletRequestDataBinder instance.
* @param target the target object to bind onto (or <code>null</code>
* @param target the target object to bind onto (or {@code null}
* if the binder is just used to convert a plain parameter value)
* @param objectName the name of the target object
*/

View File

@@ -45,11 +45,11 @@ public abstract class ServletRequestUtils {
/**
* Get an Integer parameter, or <code>null</code> if not present.
* Get an Integer parameter, or {@code null} if not present.
* Throws an exception if it the parameter value isn't a number.
* @param request current HTTP request
* @param name the name of the parameter
* @return the Integer value, or <code>null</code> if not present
* @return the Integer value, or {@code null} if not present
* @throws ServletRequestBindingException a subclass of ServletException,
* so it doesn't need to be caught
*/
@@ -123,11 +123,11 @@ public abstract class ServletRequestUtils {
/**
* Get a Long parameter, or <code>null</code> if not present.
* Get a Long parameter, or {@code null} if not present.
* Throws an exception if it the parameter value isn't a number.
* @param request current HTTP request
* @param name the name of the parameter
* @return the Long value, or <code>null</code> if not present
* @return the Long value, or {@code null} if not present
* @throws ServletRequestBindingException a subclass of ServletException,
* so it doesn't need to be caught
*/
@@ -201,11 +201,11 @@ public abstract class ServletRequestUtils {
/**
* Get a Float parameter, or <code>null</code> if not present.
* Get a Float parameter, or {@code null} if not present.
* Throws an exception if it the parameter value isn't a number.
* @param request current HTTP request
* @param name the name of the parameter
* @return the Float value, or <code>null</code> if not present
* @return the Float value, or {@code null} if not present
* @throws ServletRequestBindingException a subclass of ServletException,
* so it doesn't need to be caught
*/
@@ -279,11 +279,11 @@ public abstract class ServletRequestUtils {
/**
* Get a Double parameter, or <code>null</code> if not present.
* Get a Double parameter, or {@code null} if not present.
* Throws an exception if it the parameter value isn't a number.
* @param request current HTTP request
* @param name the name of the parameter
* @return the Double value, or <code>null</code> if not present
* @return the Double value, or {@code null} if not present
* @throws ServletRequestBindingException a subclass of ServletException,
* so it doesn't need to be caught
*/
@@ -357,13 +357,13 @@ public abstract class ServletRequestUtils {
/**
* Get a Boolean parameter, or <code>null</code> if not present.
* Get a Boolean parameter, or {@code null} if not present.
* Throws an exception if it the parameter value isn't a boolean.
* <p>Accepts "true", "on", "yes" (any case) and "1" as values for true;
* treats every other non-empty value as false (i.e. parses leniently).
* @param request current HTTP request
* @param name the name of the parameter
* @return the Boolean value, or <code>null</code> if not present
* @return the Boolean value, or {@code null} if not present
* @throws ServletRequestBindingException a subclass of ServletException,
* so it doesn't need to be caught
*/
@@ -447,10 +447,10 @@ public abstract class ServletRequestUtils {
/**
* Get a String parameter, or <code>null</code> if not present.
* Get a String parameter, or {@code null} if not present.
* @param request current HTTP request
* @param name the name of the parameter
* @return the String value, or <code>null</code> if not present
* @return the String value, or {@code null} if not present
* @throws ServletRequestBindingException a subclass of ServletException,
* so it doesn't need to be caught
*/

View File

@@ -24,8 +24,8 @@ import org.springframework.util.StringUtils;
/**
* {@link ServletRequestBindingException} subclass that indicates an unsatisfied
* parameter condition, as typically expressed using an <code>@RequestMapping</code>
* annotation at the <code>@Controller</code> type level.
* parameter condition, as typically expressed using an {@code @RequestMapping}
* annotation at the {@code @Controller} type level.
*
* @author Juergen Hoeller
* @since 3.0

View File

@@ -80,7 +80,7 @@ public class WebDataBinder extends DataBinder {
/**
* Create a new WebDataBinder instance, with default object name.
* @param target the target object to bind onto (or <code>null</code>
* @param target the target object to bind onto (or {@code null}
* if the binder is just used to convert a plain parameter value)
* @see #DEFAULT_OBJECT_NAME
*/
@@ -90,7 +90,7 @@ public class WebDataBinder extends DataBinder {
/**
* Create a new WebDataBinder instance.
* @param target the target object to bind onto (or <code>null</code>
* @param target the target object to bind onto (or {@code null}
* if the binder is just used to convert a plain parameter value)
* @param objectName the name of the target object
*/
@@ -112,7 +112,7 @@ public class WebDataBinder extends DataBinder {
* <p>One way to address this is to look for a checkbox parameter value if
* you know that the checkbox has been visible in the form, resetting the
* checkbox if no value found. In Spring web MVC, this typically happens
* in a custom <code>onBind</code> implementation.
* in a custom {@code onBind} implementation.
* <p>This auto-reset mechanism addresses this deficiency, provided
* that a marker parameter is sent for each checkbox field, like
* "_subscribeToNewsletter" for a "subscribeToNewsletter" field.
@@ -245,9 +245,9 @@ public class WebDataBinder extends DataBinder {
/**
* Determine an empty value for the specified field.
* <p>Default implementation returns <code>Boolean.FALSE</code>
* <p>Default implementation returns {@code Boolean.FALSE}
* for boolean fields and an empty array of array types.
* Else, <code>null</code> is used as default.
* Else, {@code null} is used as default.
* @param field the name of the field
* @param fieldType the type of the field
* @return the empty value (for most fields: null)

View File

@@ -51,12 +51,12 @@ public @interface CookieValue {
/**
* Whether the header is required.
* <p>Default is <code>true</code>, leading to an exception being thrown
* <p>Default is {@code true}, leading to an exception being thrown
* in case the header is missing in the request. Switch this to
* <code>false</code> if you prefer a <code>null</value> in case of the
* {@code false} if you prefer a {@code null} in case of the
* missing header.
* <p>Alternatively, provide a {@link #defaultValue() defaultValue},
* which implicitly sets this flag to <code>false</code>.
* which implicitly sets this flag to {@code false}.
*/
boolean required() default true;

View File

@@ -45,7 +45,7 @@ import java.lang.annotation.Target;
* <li>Session object (Servlet API or Portlet API): either
* {@link javax.servlet.http.HttpSession} or {@link javax.portlet.PortletSession}.
* An argument of this type will enforce the presence of a corresponding session.
* As a consequence, such an argument will never be <code>null</code>.
* As a consequence, such an argument will never be {@code null}.
* <i>Note that session access may not be thread-safe, in particular in a
* Servlet environment: Consider switching the
* {@link org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter#setSynchronizeOnSession "synchronizeOnSession"}
@@ -68,14 +68,14 @@ import java.lang.annotation.Target;
*
* <p>The following return types are supported for handler methods:
* <ul>
* <li>A <code>ModelAndView</code> object (Servlet MVC or Portlet MVC).
* <li>A {@code ModelAndView} object (Servlet MVC or Portlet MVC).
* <li>A {@link org.springframework.ui.Model Model} object, with the view name
* implicitly determined through a {@link org.springframework.web.servlet.RequestToViewNameTranslator}.
* <li>A {@link java.util.Map} object for exposing a model,
* with the view name implicitly determined through a
* {@link org.springframework.web.servlet.RequestToViewNameTranslator}.
* <li>A {@link org.springframework.web.servlet.View} object.
* <li>A {@link java.lang.String} value which is interpreted as view name.
* <li>A {@link String} value which is interpreted as view name.
* <li>{@link ResponseBody @ResponseBody} annotated methods (Servlet-only)
* to set the response content. The return value will be converted to the
* response stream using
@@ -85,7 +85,7 @@ import java.lang.annotation.Target;
* (Servlet-only) to set response headers and content. The ResponseEntity body
* will be converted and written to the response stream using
* {@linkplain org.springframework.http.converter.HttpMessageConverter message converters}.
* <li><code>void</code> if the method handles the response itself (by
* <li>{@code void} if the method handles the response itself (by
* writing the response content directly, declaring an argument of type
* {@link javax.servlet.ServletResponse} / {@link javax.servlet.http.HttpServletResponse}
* / {@link javax.portlet.RenderResponse} for that purpose)

View File

@@ -31,7 +31,7 @@ import java.lang.annotation.Target;
* <p>Such init-binder methods support all arguments that {@link RequestMapping}
* supports, except for command/form objects and corresponding validation result
* objects. Init-binder methods must not have a return value; they are usually
* declared as <code>void</code>.
* declared as {@code void}.
*
* <p>Typical arguments are {@link org.springframework.web.bind.WebDataBinder}
* in combination with {@link org.springframework.web.context.request.WebRequest}

View File

@@ -49,11 +49,11 @@ public @interface MatrixVariable {
/**
* Whether the matrix variable is required.
* <p>Default is <code>true</code>, leading to an exception thrown in case
* of the variable missing in the request. Switch this to <code>false</code>
* if you prefer a <code>null</value> in case of the variable missing.
* <p>Default is {@code true}, leading to an exception thrown in case
* of the variable missing in the request. Switch this to {@code false}
* if you prefer a {@code null} in case of the variable missing.
* <p>Alternatively, provide a {@link #defaultValue() defaultValue},
* which implicitly sets this flag to <code>false</code>.
* which implicitly sets this flag to {@code false}.
*/
boolean required() default true;

View File

@@ -46,9 +46,9 @@ public @interface RequestBody {
/**
* Whether body content is required.
* <p>Default is <code>true</code>, leading to an exception thrown in case
* there is no body content. Switch this to <code>false</code> if you prefer
* <code>null</value> to be passed when the body content is <code>null</code>.
* <p>Default is {@code true}, leading to an exception thrown in case
* there is no body content. Switch this to {@code false} if you prefer
* {@code null} to be passed when the body content is {@code null}.
*/
boolean required() default true;

View File

@@ -46,11 +46,11 @@ public @interface RequestHeader {
/**
* Whether the header is required.
* <p>Default is <code>true</code>, leading to an exception thrown in case
* of the header missing in the request. Switch this to <code>false</code>
* if you prefer a <code>null</value> in case of the header missing.
* <p>Default is {@code true}, leading to an exception thrown in case
* of the header missing in the request. Switch this to {@code false}
* if you prefer a {@code null} in case of the header missing.
* <p>Alternatively, provide a {@link #defaultValue() defaultValue},
* which implicitely sets this flag to <code>false</code>.
* which implicitely sets this flag to {@code false}.
*/
boolean required() default true;

View File

@@ -54,7 +54,7 @@ import java.util.concurrent.Callable;
* <li>Session object (Servlet API or Portlet API): either
* {@link javax.servlet.http.HttpSession} or {@link javax.portlet.PortletSession}.
* An argument of this type will enforce the presence of a corresponding session.
* As a consequence, such an argument will never be <code>null</code>.
* As a consequence, such an argument will never be {@code null}.
* <i>Note that session access may not be thread-safe, in particular in a
* Servlet environment: Consider switching the
* {@link org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter#setSynchronizeOnSession "synchronizeOnSession"}
@@ -161,7 +161,7 @@ import java.util.concurrent.Callable;
*
* <p>The following return types are supported for handler methods:
* <ul>
* <li>A <code>ModelAndView</code> object (Servlet MVC or Portlet MVC),
* <li>A {@code ModelAndView} object (Servlet MVC or Portlet MVC),
* with the model implicitly enriched with command objects and the results
* of {@link ModelAttribute} annotated reference data accessor methods.
* <li>A {@link org.springframework.ui.Model Model} object, with the view name
@@ -178,7 +178,7 @@ import java.util.concurrent.Callable;
* {@link ModelAttribute} annotated reference data accessor methods.
* The handler method may also programmatically enrich the model by
* declaring a {@link org.springframework.ui.Model} argument (see above).
* <li>A {@link java.lang.String} value which is interpreted as view name,
* <li>A {@link String} value which is interpreted as view name,
* with the model implicitly determined through command objects and
* {@link ModelAttribute} annotated reference data accessor methods.
* The handler method may also programmatically enrich the model by
@@ -201,7 +201,7 @@ import java.util.concurrent.Callable;
* <li>A {@code org.springframework.web.context.request.async.DeferredResult}
* which the application uses to produce a return value in a separate
* thread of its own choosing, as an alternative to returning a Callable.
* <li><code>void</code> if the method handles the response itself (by
* <li>{@code void} if the method handles the response itself (by
* writing the response content directly, declaring an argument of type
* {@link javax.servlet.ServletResponse} / {@link javax.servlet.http.HttpServletResponse}
* / {@link javax.portlet.RenderResponse} for that purpose)
@@ -217,28 +217,28 @@ import java.util.concurrent.Callable;
* {@link ModelAttribute} annotated reference data accessor methods.
* </ul>
*
* <p><b>NOTE:</b> <code>@RequestMapping</code> will only be processed if an
* an appropriate <code>HandlerMapping</code>-<code>HandlerAdapter</code> pair
* <p><b>NOTE:</b> {@code @RequestMapping} will only be processed if an
* an appropriate {@code HandlerMapping}-{@code HandlerAdapter} pair
* is configured. This is the case by default in both the
* <code>DispatcherServlet</code> and the <code>DispatcherPortlet</code>.
* However, if you are defining custom <code>HandlerMappings</code> or
* <code>HandlerAdapters</code>, then you need to add
* <code>DefaultAnnotationHandlerMapping</code> and
* <code>AnnotationMethodHandlerAdapter</code> to your configuration.</code>.
* {@code DispatcherServlet} and the {@code DispatcherPortlet}.
* However, if you are defining custom {@code HandlerMappings} or
* {@code HandlerAdapters}, then you need to add
* {@code DefaultAnnotationHandlerMapping} and
* {@code AnnotationMethodHandlerAdapter} to your configuration.</code>.
*
* <p><b>NOTE:</b> Spring 3.1 introduced a new set of support classes for
* <code>@RequestMapping</code> methods in Servlet environments called
* <code>RequestMappingHandlerMapping</code> and
* <code>RequestMappingHandlerAdapter</code>. They are recommended for use and
* {@code @RequestMapping} methods in Servlet environments called
* {@code RequestMappingHandlerMapping} and
* {@code RequestMappingHandlerAdapter}. They are recommended for use and
* even required to take advantage of new features in Spring MVC 3.1 (search
* {@literal "@MVC 3.1-only"} in this source file) and going forward.
* The new support classes are enabled by default from the MVC namespace and
* with use of the MVC Java config (<code>@EnableWebMvc</code>) but must be
* with use of the MVC Java config ({@code @EnableWebMvc}) but must be
* configured explicitly if using neither.
*
* <p><b>NOTE:</b> When using controller interfaces (e.g. for AOP proxying),
* make sure to consistently put <i>all</i> your mapping annotations - such as
* <code>@RequestMapping</code> and <code>@SessionAttributes</code> - on
* {@code @RequestMapping} and {@code @SessionAttributes} - on
* the controller <i>interface</i> rather than on the implementation class.
*
* @author Juergen Hoeller

View File

@@ -59,11 +59,11 @@ public @interface RequestParam {
/**
* Whether the parameter is required.
* <p>Default is <code>true</code>, leading to an exception thrown in case
* of the parameter missing in the request. Switch this to <code>false</code>
* if you prefer a <code>null</value> in case of the parameter missing.
* <p>Default is {@code true}, leading to an exception thrown in case
* of the parameter missing in the request. Switch this to {@code false}
* if you prefer a {@code null} in case of the parameter missing.
* <p>Alternatively, provide a {@link #defaultValue() defaultValue},
* which implicitly sets this flag to <code>false</code>.
* which implicitly sets this flag to {@code false}.
*/
boolean required() default true;

View File

@@ -67,9 +67,9 @@ public @interface RequestPart {
/**
* Whether the part is required.
* <p>Default is <code>true</code>, leading to an exception thrown in case
* of the part missing in the request. Switch this to <code>false</code>
* if you prefer a <code>null</value> in case of the part missing.
* <p>Default is {@code true}, leading to an exception thrown in case
* of the part missing in the request. Switch this to {@code false}
* if you prefer a {@code null} in case of the part missing.
*/
boolean required() default true;

View File

@@ -39,13 +39,13 @@ import java.lang.annotation.Target;
* specific handler's conversation.
*
* <p>For permanent session attributes, e.g. a user authentication object,
* use the traditional <code>session.setAttribute</code> method instead.
* use the traditional {@code session.setAttribute} method instead.
* Alternatively, consider using the attribute management capabilities of the
* generic {@link org.springframework.web.context.request.WebRequest} interface.
*
* <p><b>NOTE:</b> When using controller interfaces (e.g. for AOP proxying),
* make sure to consistently put <i>all</i> your mapping annotations - such as
* <code>@RequestMapping</code> and <code>@SessionAttributes</code> - on
* {@code @RequestMapping} and {@code @SessionAttributes} - on
* the controller <i>interface</i> rather than on the implementation class.
*
* @author Juergen Hoeller

View File

@@ -26,7 +26,7 @@ public interface ValueConstants {
/**
* Constant defining a value for no default - as a replacement for
* <code>null</code> which we cannot use in annotation attributes.
* {@code null} which we cannot use in annotation attributes.
* <p>This is an artificial arrangement of 16 unicode characters,
* with its sole purpose being to never match user-declared values.
* @see RequestParam#defaultValue()

View File

@@ -36,8 +36,8 @@ import org.springframework.web.bind.annotation.SessionAttributes;
/**
* Support class for resolving web method annotations in a handler type.
* Processes <code>@RequestMapping</code>, <code>@InitBinder</code>,
* <code>@ModelAttribute</code> and <code>@SessionAttributes</code>.
* Processes {@code @RequestMapping}, {@code @InitBinder},
* {@code @ModelAttribute} and {@code @SessionAttributes}.
*
* <p>Used by {@link org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter}
* and {@link org.springframework.web.portlet.mvc.annotation.AnnotationMethodHandlerAdapter}.

View File

@@ -78,8 +78,8 @@ public class ConfigurableWebBindingInitializer implements WebBindingInitializer
/**
* Set whether to use direct field access instead of bean property access.
* <p>Default is <code>false</code>, using bean property access.
* Switch this to <code>true</code> in order to enforce direct field access.
* <p>Default is {@code false}, using bean property access.
* Switch this to {@code true} in order to enforce direct field access.
* @see org.springframework.validation.DataBinder#initDirectFieldAccess()
* @see org.springframework.validation.DataBinder#initBeanPropertyAccess()
*/
@@ -97,7 +97,7 @@ public class ConfigurableWebBindingInitializer implements WebBindingInitializer
/**
* Set the strategy to use for resolving errors into message codes.
* Applies the given strategy to all data binders used by this controller.
* <p>Default is <code>null</code>, i.e. using the default strategy of
* <p>Default is {@code null}, i.e. using the default strategy of
* the data binder.
* @see org.springframework.validation.DataBinder#setMessageCodesResolver
*/
@@ -114,8 +114,8 @@ public class ConfigurableWebBindingInitializer implements WebBindingInitializer
/**
* Set the strategy to use for processing binding errors, that is,
* required field errors and <code>PropertyAccessException</code>s.
* <p>Default is <code>null</code>, that is, using the default strategy
* required field errors and {@code PropertyAccessException}s.
* <p>Default is {@code null}, that is, using the default strategy
* of the data binder.
* @see org.springframework.validation.DataBinder#setBindingErrorProcessor
*/

View File

@@ -41,10 +41,10 @@ public interface SessionAttributeStore {
* Retrieve the specified attribute from the backend session.
* <p>This will typically be called with the expectation that the
* attribute is already present, with an exception to be thrown
* if this method returns <code>null</code>.
* if this method returns {@code null}.
* @param request the current request
* @param attributeName the name of the attribute
* @return the current attribute value, or <code>null</code> if none
* @return the current attribute value, or {@code null} if none
*/
Object retrieveAttribute(WebRequest request, String attributeName);

View File

@@ -18,7 +18,7 @@ package org.springframework.web.bind.support;
/**
* Simple implementation of the {@link SessionStatus} interface,
* keeping the <code>complete</code> flag as an instance variable.
* keeping the {@code complete} flag as an instance variable.
*
* @author Juergen Hoeller
* @since 2.5

View File

@@ -55,7 +55,7 @@ public interface WebArgumentResolver {
* Resolve an argument for the given handler method parameter within the given web request.
* @param methodParameter the handler method parameter to resolve
* @param webRequest the current web request, allowing access to the native request as well
* @return the argument value, or <code>UNRESOLVED</code> if not resolvable
* @return the argument value, or {@code UNRESOLVED} if not resolvable
* @throws Exception in case of resolution failure
*/
Object resolveArgument(MethodParameter methodParameter, NativeWebRequest webRequest) throws Exception;

View File

@@ -35,7 +35,7 @@ import org.springframework.web.multipart.MultipartRequest;
* that build on Spring's {@link org.springframework.web.context.request.WebRequest}
* abstraction: e.g. in a {@link org.springframework.web.context.request.WebRequestInterceptor}
* implementation. Simply instantiate a WebRequestDataBinder for each binding
* process, and invoke <code>bind</code> with the current WebRequest as argument:
* process, and invoke {@code bind} with the current WebRequest as argument:
*
* <pre class="code">
* MyBean myBean = new MyBean();
@@ -61,7 +61,7 @@ public class WebRequestDataBinder extends WebDataBinder {
/**
* Create a new WebRequestDataBinder instance, with default object name.
* @param target the target object to bind onto (or <code>null</code>
* @param target the target object to bind onto (or {@code null}
* if the binder is just used to convert a plain parameter value)
* @see #DEFAULT_OBJECT_NAME
*/
@@ -71,7 +71,7 @@ public class WebRequestDataBinder extends WebDataBinder {
/**
* Create a new WebRequestDataBinder instance.
* @param target the target object to bind onto (or <code>null</code>
* @param target the target object to bind onto (or {@code null}
* if the binder is just used to convert a plain parameter value)
* @param objectName the name of the target object
*/

View File

@@ -68,7 +68,7 @@ public class DefaultResponseErrorHandler implements ResponseErrorHandler {
* or {@link org.springframework.http.HttpStatus.Series#SERVER_ERROR SERVER_ERROR}.
* Can be overridden in subclasses.
* @param statusCode the HTTP status code
* @return <code>true</code> if the response has an error; <code>false</code> otherwise
* @return {@code true} if the response has an error; {@code false} otherwise
*/
protected boolean hasError(HttpStatus statusCode) {
return (statusCode.series() == HttpStatus.Series.CLIENT_ERROR ||

View File

@@ -32,7 +32,7 @@ import org.springframework.util.Assert;
/**
* Response extractor that uses the given {@linkplain HttpMessageConverter entity
* converters} to convert the response into a type <code>T</code>.
* converters} to convert the response into a type {@code T}.
*
* @author Arjen Poutsma
* @see RestTemplate

View File

@@ -33,14 +33,14 @@ public interface ResponseErrorHandler {
* Implementations will typically inspect the {@link ClientHttpResponse#getStatusCode() HttpStatus}
* of the response.
* @param response the response to inspect
* @return <code>true</code> if the response has an error; <code>false</code> otherwise
* @return {@code true} if the response has an error; {@code false} otherwise
* @throws IOException in case of I/O errors
*/
boolean hasError(ClientHttpResponse response) throws IOException;
/**
* Handles the error in the given response.
* This method is only called when {@link #hasError(ClientHttpResponse)} has returned <code>true</code>.
* This method is only called when {@link #hasError(ClientHttpResponse)} has returned {@code true}.
* @param response the response with the error
* @throws IOException in case of I/O errors
*/

View File

@@ -136,40 +136,40 @@ public interface RestOperations {
/**
* Create a new resource by POSTing the given object to the URI template, and returns the value of the
* <code>Location</code> header. This header typically indicates where the new resource is stored.
* {@code Location} header. This header typically indicates where the new resource is stored.
* <p>URI Template variables are expanded using the given URI variables, if any.
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be POSTed, may be <code>null</code>
* @param request the Object to be POSTed, may be {@code null}
* @param uriVariables the variables to expand the template
* @return the value for the <code>Location</code> header
* @return the value for the {@code Location} header
* @see HttpEntity
*/
URI postForLocation(String url, Object request, Object... uriVariables) throws RestClientException;
/**
* Create a new resource by POSTing the given object to the URI template, and returns the value of the
* <code>Location</code> header. This header typically indicates where the new resource is stored.
* {@code Location} header. This header typically indicates where the new resource is stored.
* <p>URI Template variables are expanded using the given map.
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be POSTed, may be <code>null</code>
* @param request the Object to be POSTed, may be {@code null}
* @param uriVariables the variables to expand the template
* @return the value for the <code>Location</code> header
* @return the value for the {@code Location} header
* @see HttpEntity
*/
URI postForLocation(String url, Object request, Map<String, ?> uriVariables) throws RestClientException;
/**
* Create a new resource by POSTing the given object to the URL, and returns the value of the
* <code>Location</code> header. This header typically indicates where the new resource is stored.
* {@code Location} header. This header typically indicates where the new resource is stored.
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be POSTed, may be <code>null</code>
* @return the value for the <code>Location</code> header
* @param request the Object to be POSTed, may be {@code null}
* @return the value for the {@code Location} header
* @see HttpEntity
*/
URI postForLocation(URI url, Object request) throws RestClientException;
@@ -181,7 +181,7 @@ public interface RestOperations {
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be POSTed, may be <code>null</code>
* @param request the Object to be POSTed, may be {@code null}
* @param responseType the type of the return value
* @param uriVariables the variables to expand the template
* @return the converted object
@@ -197,7 +197,7 @@ public interface RestOperations {
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be POSTed, may be <code>null</code>
* @param request the Object to be POSTed, may be {@code null}
* @param responseType the type of the return value
* @param uriVariables the variables to expand the template
* @return the converted object
@@ -212,7 +212,7 @@ public interface RestOperations {
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be POSTed, may be <code>null</code>
* @param request the Object to be POSTed, may be {@code null}
* @param responseType the type of the return value
* @return the converted object
* @see HttpEntity
@@ -226,7 +226,7 @@ public interface RestOperations {
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be POSTed, may be <code>null</code>
* @param request the Object to be POSTed, may be {@code null}
* @param uriVariables the variables to expand the template
* @return the converted object
* @see HttpEntity
@@ -242,7 +242,7 @@ public interface RestOperations {
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be POSTed, may be <code>null</code>
* @param request the Object to be POSTed, may be {@code null}
* @param uriVariables the variables to expand the template
* @return the converted object
* @see HttpEntity
@@ -257,7 +257,7 @@ public interface RestOperations {
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be POSTed, may be <code>null</code>
* @param request the Object to be POSTed, may be {@code null}
* @return the converted object
* @see HttpEntity
* @since 3.0.2
@@ -272,7 +272,7 @@ public interface RestOperations {
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be PUT, may be <code>null</code>
* @param request the Object to be PUT, may be {@code null}
* @param uriVariables the variables to expand the template
* @see HttpEntity
*/
@@ -284,7 +284,7 @@ public interface RestOperations {
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be PUT, may be <code>null</code>
* @param request the Object to be PUT, may be {@code null}
* @param uriVariables the variables to expand the template
* @see HttpEntity
*/
@@ -295,7 +295,7 @@ public interface RestOperations {
* <p>The {@code request} parameter can be a {@link HttpEntity} in order to
* add additional HTTP headers to the request.
* @param url the URL
* @param request the Object to be PUT, may be <code>null</code>
* @param request the Object to be PUT, may be {@code null}
* @see HttpEntity
*/
void put(URI url, Object request) throws RestClientException;

View File

@@ -466,8 +466,8 @@ public class RestTemplate extends InterceptingHttpAccessor implements RestOperat
* RequestCallback}; the response with the {@link ResponseExtractor}.
* @param url the fully-expanded URL to connect to
* @param method the HTTP method to execute (GET, POST, etc.)
* @param requestCallback object that prepares the request (can be <code>null</code>)
* @param responseExtractor object that extracts the return value from the response (can be <code>null</code>)
* @param requestCallback object that prepares the request (can be {@code null})
* @param responseExtractor object that extracts the return value from the response (can be {@code null})
* @return an arbitrary object, as returned by the {@link ResponseExtractor}
*/
protected <T> T doExecute(URI url, HttpMethod method, RequestCallback requestCallback,

View File

@@ -1,7 +1,6 @@
/**
*
* Classes supporting the <code>org.springframework.web.client</code> package.
* Classes supporting the {@code org.springframework.web.client} package.
* Contains a base class for RestTemplate usage.
*
*/

View File

@@ -105,7 +105,7 @@ public interface ConfigurableWebApplicationContext extends WebApplicationContext
/**
* Return the config locations for this web application context,
* or <code>null</code> if none specified.
* or {@code null} if none specified.
*/
String[] getConfigLocations();

View File

@@ -50,7 +50,7 @@ import org.springframework.util.StringUtils;
* Called by {@link ContextLoaderListener}.
*
* <p>Looks for a {@link #CONTEXT_CLASS_PARAM "contextClass"} parameter
* at the <code>web.xml</code> context-param level to specify the context
* at the {@code web.xml} context-param level to specify the context
* class type, falling back to the default of
* {@link org.springframework.web.context.support.XmlWebApplicationContext}
* if not found. With the default ContextLoader implementation, any context class
@@ -119,14 +119,14 @@ public class ContextLoader {
public static final String CONFIG_LOCATION_PARAM = "contextConfigLocation";
/**
* Optional servlet context parameter (i.e., "<code>locatorFactorySelector</code>")
* Optional servlet context parameter (i.e., "{@code locatorFactorySelector}")
* used only when obtaining a parent context using the default implementation
* of {@link #loadParentContext(ServletContext servletContext)}.
* Specifies the 'selector' used in the
* {@link ContextSingletonBeanFactoryLocator#getInstance(String selector)}
* method call, which is used to obtain the BeanFactoryLocator instance from
* which the parent context is obtained.
* <p>The default is <code>classpath*:beanRefContext.xml</code>,
* <p>The default is {@code classpath*:beanRefContext.xml},
* matching the default applied for the
* {@link ContextSingletonBeanFactoryLocator#getInstance()} method.
* Supplying the "parentContextKey" parameter is sufficient in this case.
@@ -134,14 +134,14 @@ public class ContextLoader {
public static final String LOCATOR_FACTORY_SELECTOR_PARAM = "locatorFactorySelector";
/**
* Optional servlet context parameter (i.e., "<code>parentContextKey</code>")
* Optional servlet context parameter (i.e., "{@code parentContextKey}")
* used only when obtaining a parent context using the default implementation
* of {@link #loadParentContext(ServletContext servletContext)}.
* Specifies the 'factoryKey' used in the
* {@link BeanFactoryLocator#useBeanFactory(String factoryKey)} method call,
* obtaining the parent application context from the BeanFactoryLocator instance.
* <p>Supplying this "parentContextKey" parameter is sufficient when relying
* on the default <code>classpath*:beanRefContext.xml</code> selector for
* on the default {@code classpath*:beanRefContext.xml} selector for
* candidate factory references.
*/
public static final String LOCATOR_FACTORY_KEY_PARAM = "parentContextKey";
@@ -510,7 +510,7 @@ public class ContextLoader {
* which will be shared by all other users of ContextsingletonBeanFactoryLocator
* which also use the same configuration parameters.
* @param servletContext current servlet context
* @return the parent application context, or <code>null</code> if none
* @return the parent application context, or {@code null} if none
* @see org.springframework.context.access.ContextSingletonBeanFactoryLocator
*/
protected ApplicationContext loadParentContext(ServletContext servletContext) {
@@ -569,7 +569,7 @@ public class ContextLoader {
* Obtain the Spring root web application context for the current thread
* (i.e. for the current thread's context ClassLoader, which needs to be
* the web application's ClassLoader).
* @return the current root web application context, or <code>null</code>
* @return the current root web application context, or {@code null}
* if none found
* @see org.springframework.web.context.support.SpringBeanAutowiringSupport
*/

View File

@@ -25,7 +25,7 @@ import javax.servlet.ServletContextListener;
*
* <p>This listener should be registered after
* {@link org.springframework.web.util.Log4jConfigListener}
* in <code>web.xml</code>, if the latter is used.
* in {@code web.xml}, if the latter is used.
*
* <p>As of Spring 3.1, {@code ContextLoaderListener} supports injecting the root web
* application context via the {@link #ContextLoaderListener(WebApplicationContext)}

View File

@@ -38,9 +38,9 @@ public interface ServletConfigAware extends Aware {
/**
* Set the {@link ServletConfig} that this object runs in.
* <p>Invoked after population of normal bean properties but before an init
* callback like InitializingBean's <code>afterPropertiesSet</code> or a
* callback like InitializingBean's {@code afterPropertiesSet} or a
* custom init-method. Invoked after ApplicationContextAware's
* <code>setApplicationContext</code>.
* {@code setApplicationContext}.
* @param servletConfig ServletConfig object to be used by this object
* @see org.springframework.beans.factory.InitializingBean#afterPropertiesSet
* @see org.springframework.context.ApplicationContextAware#setApplicationContext

View File

@@ -35,9 +35,9 @@ public interface ServletContextAware extends Aware {
/**
* Set the {@link ServletContext} that this object runs in.
* <p>Invoked after population of normal bean properties but before an init
* callback like InitializingBean's <code>afterPropertiesSet</code> or a
* callback like InitializingBean's {@code afterPropertiesSet} or a
* custom init-method. Invoked after ApplicationContextAware's
* <code>setApplicationContext</code>.
* {@code setApplicationContext}.
* @param servletContext ServletContext object to be used by this object
* @see org.springframework.beans.factory.InitializingBean#afterPropertiesSet
* @see org.springframework.context.ApplicationContextAware#setApplicationContext

View File

@@ -24,7 +24,7 @@ import org.springframework.context.ApplicationContext;
* Interface to provide configuration for a web application. This is read-only while
* the application is running, but may be reloaded if the implementation supports this.
*
* <p>This interface adds a <code>getServletContext()</code> method to the generic
* <p>This interface adds a {@code getServletContext()} method to the generic
* ApplicationContext interface, and defines a well-known application attribute name
* that the root context must be bound to in the bootstrap process.
*
@@ -34,7 +34,7 @@ import org.springframework.context.ApplicationContext;
*
* <p>In addition to standard application context lifecycle capabilities,
* WebApplicationContext implementations need to detect {@link ServletContextAware}
* beans and invoke the <code>setServletContext</code> method accordingly.
* beans and invoke the {@code setServletContext} method accordingly.
*
* @author Rod Johnson
* @author Juergen Hoeller

View File

@@ -41,7 +41,7 @@ import org.springframework.web.util.WebUtils;
* <i>not</i> support destruction callbacks for scoped attributes, neither for the
* request scope nor for the session scope. If you rely on such implicit destruction
* callbacks, consider defining a Spring {@link RequestContextListener} in your
* <code>web.xml</code>.
* {@code web.xml}.
*
* @author Juergen Hoeller
* @since 2.5.2

View File

@@ -64,7 +64,7 @@ public class Log4jNestedDiagnosticContextInterceptor implements AsyncWebRequestI
/**
* Determine the message to be pushed onto the Log4J nested diagnostic context.
* <p>Default is the request object's <code>getDescription</code> result.
* <p>Default is the request object's {@code getDescription} result.
* @param request current HTTP request
* @return the message to be pushed onto the Log4J NDC
* @see WebRequest#getDescription

View File

@@ -47,7 +47,7 @@ public interface NativeWebRequest extends WebRequest {
/**
* Return the underlying native request object, if available.
* @param requiredType the desired type of request object
* @return the matching request object, or <code>null</code> if none
* @return the matching request object, or {@code null} if none
* of that type is available
* @see javax.servlet.http.HttpServletRequest
* @see javax.portlet.ActionRequest
@@ -58,7 +58,7 @@ public interface NativeWebRequest extends WebRequest {
/**
* Return the underlying native request object, if available.
* @param requiredType the desired type of response object
* @return the matching response object, or <code>null</code> if none
* @return the matching response object, or {@code null} if none
* of that type is available
* @see javax.servlet.http.HttpServletRequest
* @see javax.portlet.ActionRequest

View File

@@ -70,7 +70,7 @@ public interface RequestAttributes {
* Return the value for the scoped attribute of the given name, if any.
* @param name the name of the attribute
* @param scope the scope identifier
* @return the current attribute value, or <code>null</code> if not found
* @return the current attribute value, or {@code null} if not found
*/
Object getAttribute(String name, int scope);
@@ -129,20 +129,20 @@ public interface RequestAttributes {
* <p>At a minimum: the HttpServletRequest/PortletRequest reference for key
* "request", and the HttpSession/PortletSession reference for key "session".
* @param key the contextual key
* @return the corresponding object, or <code>null</code> if none found
* @return the corresponding object, or {@code null} if none found
*/
Object resolveReference(String key);
/**
* Return an id for the current underlying session.
* @return the session id as String (never <code>null</code>
* @return the session id as String (never {@code null}
*/
String getSessionId();
/**
* Expose the best available mutex for the underlying session:
* that is, an object to synchronize on for the underlying session.
* @return the session mutex to use (never <code>null</code>
* @return the session mutex to use (never {@code null}
*/
Object getSessionMutex();

View File

@@ -26,7 +26,7 @@ import org.springframework.util.ClassUtils;
* Holder class to expose the web request in the form of a thread-bound
* {@link RequestAttributes} object. The request will be inherited
* by any child threads spawned by the current thread if the
* <code>inheritable<code> flag is set to <code>true</code>.
* {@code inheritable} flag is set to {@code true}.
*
* <p>Use {@link RequestContextListener} or
* {@link org.springframework.web.filter.RequestContextFilter} to expose
@@ -76,9 +76,9 @@ public abstract class RequestContextHolder {
/**
* Bind the given RequestAttributes to the current thread.
* @param attributes the RequestAttributes to expose,
* or <code>null</code> to reset the thread-bound context
* or {@code null} to reset the thread-bound context
* @param inheritable whether to expose the RequestAttributes as inheritable
* for child threads (using an {@link java.lang.InheritableThreadLocal})
* for child threads (using an {@link InheritableThreadLocal})
*/
public static void setRequestAttributes(RequestAttributes attributes, boolean inheritable) {
if (attributes == null) {
@@ -99,7 +99,7 @@ public abstract class RequestContextHolder {
/**
* Return the RequestAttributes currently bound to the thread.
* @return the RequestAttributes currently bound to the thread,
* or <code>null</code> if none bound
* or {@code null} if none bound
*/
public static RequestAttributes getRequestAttributes() {
RequestAttributes attributes = requestAttributesHolder.get();

View File

@@ -25,7 +25,7 @@ import org.springframework.context.i18n.LocaleContextHolder;
/**
* Servlet 2.4+ listener that exposes the request to the current thread,
* through both {@link org.springframework.context.i18n.LocaleContextHolder} and
* {@link RequestContextHolder}. To be registered as listener in <code>web.xml</code>.
* {@link RequestContextHolder}. To be registered as listener in {@code web.xml}.
*
* <p>Alternatively, Spring's {@link org.springframework.web.filter.RequestContextFilter}
* and Spring's {@link org.springframework.web.servlet.DispatcherServlet} also expose
@@ -39,7 +39,7 @@ import org.springframework.context.i18n.LocaleContextHolder;
* @since 2.0
* @see javax.servlet.ServletRequestListener
* @see org.springframework.context.i18n.LocaleContextHolder
* @see org.springframework.web.context.request.RequestContextHolder
* @see RequestContextHolder
* @see org.springframework.web.filter.RequestContextFilter
* @see org.springframework.web.servlet.DispatcherServlet
*/

View File

@@ -25,8 +25,8 @@ package org.springframework.web.context.request;
* {@link org.springframework.web.filter.RequestContextFilter} or
* {@link org.springframework.web.servlet.DispatcherServlet}.
*
* <p>This <code>Scope</code> will also work for Portlet environments,
* through an alternate <code>RequestAttributes</code> implementation
* <p>This {@code Scope} will also work for Portlet environments,
* through an alternate {@code RequestAttributes} implementation
* (as exposed out-of-the-box by Spring's
* {@link org.springframework.web.portlet.DispatcherPortlet}.
*
@@ -50,7 +50,7 @@ public class RequestScope extends AbstractRequestAttributesScope {
/**
* There is no conversation id concept for a request, so this method
* returns <code>null</code>.
* returns {@code null}.
*/
public String getConversationId() {
return null;

View File

@@ -212,7 +212,7 @@ public class ServletRequestAttributes extends AbstractRequestAttributes {
/**
* Update all accessed session attributes through <code>session.setAttribute</code>
* Update all accessed session attributes through {@code session.setAttribute}
* calls, explicitly indicating to the container that they might have been modified.
*/
@Override

View File

@@ -27,8 +27,8 @@ import org.springframework.beans.factory.ObjectFactory;
* {@link org.springframework.web.filter.RequestContextFilter} or
* {@link org.springframework.web.servlet.DispatcherServlet}.
*
* <p>This <code>Scope</code> will also work for Portlet environments,
* through an alternate <code>RequestAttributes</code> implementation
* <p>This {@code Scope} will also work for Portlet environments,
* through an alternate {@code RequestAttributes} implementation
* (as exposed out-of-the-box by Spring's
* {@link org.springframework.web.portlet.DispatcherPortlet}.
*
@@ -66,10 +66,10 @@ public class SessionScope extends AbstractRequestAttributesScope {
* If this flag is on, objects will be put into the "application scope" session;
* else they will end up in the "portlet scope" session (the typical default).
* <p>In a Servlet environment, this flag is effectively ignored.
* @param globalSession <code>true</code> in case of the global session as target;
* <code>false</code> in case of a component-specific session as target
* @param globalSession {@code true} in case of the global session as target;
* {@code false} in case of a component-specific session as target
* @see org.springframework.web.portlet.context.PortletRequestAttributes
* @see org.springframework.web.context.request.ServletRequestAttributes
* @see ServletRequestAttributes
*/
public SessionScope(boolean globalSession) {
this.scope = (globalSession ? RequestAttributes.SCOPE_GLOBAL_SESSION : RequestAttributes.SCOPE_SESSION);

View File

@@ -33,7 +33,7 @@ import java.util.Map;
public interface WebRequest extends RequestAttributes {
/**
* Return the request header of the given name, or <code>null</code> if none.
* Return the request header of the given name, or {@code null} if none.
* <p>Retrieves the first header value in case of a multi-value header.
* @since 3.0
* @see javax.servlet.http.HttpServletRequest#getHeader(String)
@@ -42,7 +42,7 @@ public interface WebRequest extends RequestAttributes {
/**
* Return the request header values for the given header name,
* or <code>null</code> if none.
* or {@code null} if none.
* <p>A single-value header will be exposed as an array with a single element.
* @since 3.0
* @see javax.servlet.http.HttpServletRequest#getHeaders(String)
@@ -57,7 +57,7 @@ public interface WebRequest extends RequestAttributes {
Iterator<String> getHeaderNames();
/**
* Return the request parameter of the given name, or <code>null</code> if none.
* Return the request parameter of the given name, or {@code null} if none.
* <p>Retrieves the first parameter value in case of a multi-value parameter.
* @see javax.servlet.http.HttpServletRequest#getParameter(String)
*/
@@ -65,7 +65,7 @@ public interface WebRequest extends RequestAttributes {
/**
* Return the request parameter values for the given parameter name,
* or <code>null</code> if none.
* or {@code null} if none.
* <p>A single-value parameter will be exposed as an array with a single element.
* @see javax.servlet.http.HttpServletRequest#getParameterValues(String)
*/

View File

@@ -76,7 +76,7 @@ public interface WebRequestInterceptor {
* execution (for example, flushing a Hibernate Session).
* @param request the current web request
* @param model the map of model objects that will be exposed to the view
* (may be <code>null</code>). Can be used to analyze the exposed model
* (may be {@code null}). Can be used to analyze the exposed model
* and/or to add further model attributes, if desired.
* @throws Exception in case of errors
*/
@@ -86,7 +86,7 @@ public interface WebRequestInterceptor {
* Callback after completion of request processing, that is, after rendering
* the view. Will be called on any outcome of handler execution, thus allows
* for proper resource cleanup.
* <p>Note: Will only be called if this interceptor's <code>preHandle</code>
* <p>Note: Will only be called if this interceptor's {@code preHandle}
* method has successfully completed!
* @param request the current web request
* @param ex exception thrown on handler execution, if any

View File

@@ -86,7 +86,7 @@ public abstract class AbstractRefreshableWebApplicationContext extends AbstractR
/** Servlet config that this context runs in, if any */
private ServletConfig servletConfig;
/** Namespace of this context, or <code>null</code> if root */
/** Namespace of this context, or {@code null} if root */
private String namespace;
/** the ThemeSource for this ApplicationContext */

View File

@@ -40,13 +40,13 @@ import org.springframework.web.context.ServletContextAware;
*
* <p>Implements the
* {@link org.springframework.web.context.ConfigurableWebApplicationContext},
* but is not intended for declarative setup in <code>web.xml</code>. Instead,
* but is not intended for declarative setup in {@code web.xml}. Instead,
* it is designed for programmatic setup, for example for building nested contexts or
* for use within Spring 3.1 {@link org.springframework.web.WebApplicationInitializer}s.
*
* <p><b>If you intend to implement a WebApplicationContext that reads bean definitions
* from configuration files, consider deriving from AbstractRefreshableWebApplicationContext,
* reading the bean definitions in an implementation of the <code>loadBeanDefinitions</code>
* reading the bean definitions in an implementation of the {@code loadBeanDefinitions}
* method.</b>
*
* <p>Interprets resource paths as servlet context resources, i.e. as paths beneath

View File

@@ -32,7 +32,7 @@ import org.springframework.web.context.WebApplicationContext;
/**
* Simple HttpServlet that delegates to an {@link HttpRequestHandler} bean defined
* in Spring's root web application context. The target bean name must match the
* HttpRequestHandlerServlet servlet-name as defined in <code>web.xml</code>.
* HttpRequestHandlerServlet servlet-name as defined in {@code web.xml}.
*
* <p>This can for example be used to expose a single Spring remote exporter,
* such as {@link org.springframework.remoting.httpinvoker.HttpInvokerServiceExporter}

View File

@@ -23,7 +23,7 @@ import org.springframework.web.context.ServletContextAware;
/**
* {@link FactoryBean} that retrieves a specific ServletContext init parameter
* (that is, a "context-param" defined in <code>web.xml</code>).
* (that is, a "context-param" defined in {@code web.xml}).
* Exposes that ServletContext init parameter when used as bean reference,
* effectively making it available as named Spring bean instance.
*

View File

@@ -26,12 +26,12 @@ import org.springframework.web.context.ServletContextAware;
/**
* Subclass of {@link PropertyPlaceholderConfigurer} that resolves placeholders as
* ServletContext init parameters (that is, <code>web.xml</code> context-param
* ServletContext init parameters (that is, {@code web.xml} context-param
* entries).
*
* <p>Can be combined with "locations" and/or "properties" values in addition
* to web.xml context-params. Alternatively, can be defined without local
* properties, to resolve all placeholders as <code>web.xml</code> context-params
* properties, to resolve all placeholders as {@code web.xml} context-params
* (or JVM system properties).
*
* <p>If a placeholder could not be resolved against the provided local
@@ -59,7 +59,7 @@ import org.springframework.web.context.ServletContextAware;
* @see javax.servlet.ServletContext#getInitParameter(String)
* @see javax.servlet.ServletContext#getAttribute(String)
* @deprecated in Spring 3.1 in favor of {@link org.springframework.context.support.PropertySourcesPlaceholderConfigurer}
* in conjunction with {@link org.springframework.web.context.support.StandardServletEnvironment}.
* in conjunction with {@link StandardServletEnvironment}.
*/
@Deprecated
public class ServletContextPropertyPlaceholderConfigurer extends PropertyPlaceholderConfigurer
@@ -93,7 +93,7 @@ public class ServletContextPropertyPlaceholderConfigurer extends PropertyPlaceho
* <p>If turned on, the configurer will look for a ServletContext attribute with
* the same name as the placeholder, and use its stringified value if found.
* Exposure of such ServletContext attributes can be used to dynamically override
* init parameters defined in <code>web.xml</code>, for example in a custom
* init parameters defined in {@code web.xml}, for example in a custom
* context listener.
* @see javax.servlet.ServletContext#getInitParameter(String)
* @see javax.servlet.ServletContext#getAttribute(String)

View File

@@ -38,7 +38,7 @@ import org.springframework.web.util.WebUtils;
* relative paths within the web application root directory.
*
* <p>Always supports stream access and URL access, but only allows
* <code>java.io.File</code> access when the web application archive
* {@code java.io.File} access when the web application archive
* is expanded.
*
* @author Juergen Hoeller
@@ -93,7 +93,7 @@ public class ServletContextResource extends AbstractFileResolvingResource implem
/**
* This implementation checks <code>ServletContext.getResource</code>.
* This implementation checks {@code ServletContext.getResource}.
* @see javax.servlet.ServletContext#getResource(String)
*/
@Override
@@ -108,8 +108,8 @@ public class ServletContextResource extends AbstractFileResolvingResource implem
}
/**
* This implementation delegates to <code>ServletContext.getResourceAsStream</code>,
* which returns <code>null</code> in case of a non-readable resource (e.g. a directory).
* This implementation delegates to {@code ServletContext.getResourceAsStream},
* which returns {@code null} in case of a non-readable resource (e.g. a directory).
* @see javax.servlet.ServletContext#getResourceAsStream(String)
*/
@Override
@@ -130,7 +130,7 @@ public class ServletContextResource extends AbstractFileResolvingResource implem
}
/**
* This implementation delegates to <code>ServletContext.getResourceAsStream</code>,
* This implementation delegates to {@code ServletContext.getResourceAsStream},
* but throws a FileNotFoundException if no resource found.
* @see javax.servlet.ServletContext#getResourceAsStream(String)
*/
@@ -143,7 +143,7 @@ public class ServletContextResource extends AbstractFileResolvingResource implem
}
/**
* This implementation delegates to <code>ServletContext.getResource</code>,
* This implementation delegates to {@code ServletContext.getResource},
* but throws a FileNotFoundException if no resource found.
* @see javax.servlet.ServletContext#getResource(String)
*/
@@ -159,7 +159,7 @@ public class ServletContextResource extends AbstractFileResolvingResource implem
/**
* This implementation resolves "file:" URLs or alternatively delegates to
* <code>ServletContext.getRealPath</code>, throwing a FileNotFoundException
* {@code ServletContext.getRealPath}, throwing a FileNotFoundException
* if not found or not resolvable.
* @see javax.servlet.ServletContext#getResource(String)
* @see javax.servlet.ServletContext#getRealPath(String)

View File

@@ -37,7 +37,7 @@ import org.springframework.util.StringUtils;
/**
* ServletContext-aware subclass of {@link PathMatchingResourcePatternResolver},
* able to find matching resources below the web application root directory
* via Servlet 2.3's <code>ServletContext.getResourcePaths</code>.
* via Servlet 2.3's {@code ServletContext.getResourcePaths}.
* Falls back to the superclass' file system checking for other resources.
*
* @author Juergen Hoeller
@@ -69,7 +69,7 @@ public class ServletContextResourcePatternResolver extends PathMatchingResourceP
/**
* Overridden version which checks for ServletContextResource
* and uses <code>ServletContext.getResourcePaths</code> to find
* and uses {@code ServletContext.getResourcePaths} to find
* matching resources below the web application root directory.
* In case of other resources, delegates to the superclass version.
* @see #doRetrieveMatchingServletContextResources

View File

@@ -35,7 +35,7 @@ import org.springframework.util.Assert;
*
* <p>The associated destruction mechanism relies on a
* {@link org.springframework.web.context.ContextCleanupListener} being registered in
* <code>web.xml</code>. Note that {@link org.springframework.web.context.ContextLoaderListener}
* {@code web.xml}. Note that {@link org.springframework.web.context.ContextLoaderListener}
* includes ContextCleanupListener's functionality.
*
* <p>This scope is registered as default scope with key

View File

@@ -29,7 +29,7 @@ import org.springframework.web.context.WebApplicationContext;
/**
* Convenient base class for self-autowiring classes that gets constructed
* within a Spring-based web application. Resolves <code>@Autowired</code>
* within a Spring-based web application. Resolves {@code @Autowired}
* annotations in the endpoint class against beans in the current Spring
* root web application context (as determined by the current thread's
* context ClassLoader, which needs to be the web application's ClassLoader).
@@ -39,10 +39,10 @@ import org.springframework.web.context.WebApplicationContext;
* Such a Spring-based JAX-WS endpoint implementation will follow the
* standard JAX-WS contract for endpoint classes but will be 'thin'
* in that it delegates the actual work to one or more Spring-managed
* service beans - typically obtained using <code>@Autowired</code>.
* service beans - typically obtained using {@code @Autowired}.
* The lifecycle of such an endpoint instance will be managed by the
* JAX-WS runtime, hence the need for this base class to provide
* <code>@Autowired</code> processing based on the current Spring context.
* {@code @Autowired} processing based on the current Spring context.
*
* <p><b>NOTE:</b> If there is an explicit way to access the ServletContext,
* prefer such a way over using this class. The {@link WebApplicationContextUtils}
@@ -70,7 +70,7 @@ public abstract class SpringBeanAutowiringSupport {
/**
* Process <code>@Autowired</code> injection for the given target object,
* Process {@code @Autowired} injection for the given target object,
* based on the current web application context.
* <p>Intended for use as a delegate.
* @param target the target object to process
@@ -95,7 +95,7 @@ public abstract class SpringBeanAutowiringSupport {
/**
* Process <code>@Autowired</code> injection for the given target object,
* Process {@code @Autowired} injection for the given target object,
* based on the current root web application context as stored in the ServletContext.
* <p>Intended for use as a delegate.
* @param target the target object to process

View File

@@ -51,7 +51,7 @@ import org.springframework.web.context.request.WebRequest;
/**
* Convenience methods for retrieving the root
* {@link org.springframework.web.context.WebApplicationContext} for a given
* <code>ServletContext</code>. This is e.g. useful for accessing a Spring
* {@code ServletContext}. This is e.g. useful for accessing a Spring
* context from within custom web views or Struts actions.
*
* <p>Note that there are more convenient ways of accessing the root context for
@@ -98,7 +98,7 @@ public abstract class WebApplicationContextUtils {
* <p>Will rethrow an exception that happened on root context startup,
* to differentiate between a failed context startup and no context at all.
* @param sc ServletContext to find the web application context for
* @return the root WebApplicationContext for this web app, or <code>null</code> if none
* @return the root WebApplicationContext for this web app, or {@code null} if none
* @see org.springframework.web.context.WebApplicationContext#ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE
*/
public static WebApplicationContext getWebApplicationContext(ServletContext sc) {
@@ -109,7 +109,7 @@ public abstract class WebApplicationContextUtils {
* Find a custom WebApplicationContext for this web application.
* @param sc ServletContext to find the web application context for
* @param attrName the name of the ServletContext attribute to look for
* @return the desired WebApplicationContext for this web app, or <code>null</code> if none
* @return the desired WebApplicationContext for this web app, or {@code null} if none
*/
public static WebApplicationContext getWebApplicationContext(ServletContext sc, String attrName) {
Assert.notNull(sc, "ServletContext must not be null");

View File

@@ -27,8 +27,8 @@ import org.springframework.web.util.WebUtils;
/**
* Convenient superclass for application objects running in a WebApplicationContext.
* Provides <code>getWebApplicationContext()</code>, <code>getServletContext()</code>,
* and <code>getTempDir()</code> methods.
* Provides {@code getWebApplicationContext()}, {@code getServletContext()},
* and {@code getTempDir()} methods.
*
* @author Juergen Hoeller
* @since 28.08.2003
@@ -85,7 +85,7 @@ public abstract class WebApplicationObjectSupport extends ApplicationObjectSuppo
* {@link #initApplicationContext(org.springframework.context.ApplicationContext)}
* as well as {@link #setServletContext(javax.servlet.ServletContext)}.
* @param servletContext the ServletContext that this application object runs in
* (never <code>null</code>)
* (never {@code null})
*/
protected void initServletContext(ServletContext servletContext) {
}
@@ -94,7 +94,7 @@ public abstract class WebApplicationObjectSupport extends ApplicationObjectSuppo
* Return the current application context as WebApplicationContext.
* <p><b>NOTE:</b> Only use this if you actually need to access
* WebApplicationContext-specific functionality. Preferably use
* <code>getApplicationContext()</code> or <code>getServletContext()</code>
* {@code getApplicationContext()} or {@code getServletContext()}
* else, to be able to run in non-WebApplicationContext environments as well.
* @throws IllegalStateException if not running in a WebApplicationContext
* @see #getApplicationContext()

View File

@@ -1,7 +1,6 @@
/**
*
* Classes supporting the <code>org.springframework.web.context</code> package,
* Classes supporting the {@code org.springframework.web.context} package,
* such as WebApplicationContext implementations and various utility classes.
*
*/

View File

@@ -35,20 +35,20 @@ import org.springframework.util.StringUtils;
import org.springframework.web.util.WebUtils;
/**
* Base class for <code>Filter</code>s that perform logging operations before and after a request is processed.
* Base class for {@code Filter}s that perform logging operations before and after a request is processed.
*
* <p>Subclasses should override the <code>beforeRequest(HttpServletRequest, String)</code> and
* <code>afterRequest(HttpServletRequest, String)</code> methods to perform the actual logging around the request.
* <p>Subclasses should override the {@code beforeRequest(HttpServletRequest, String)} and
* {@code afterRequest(HttpServletRequest, String)} methods to perform the actual logging around the request.
*
* <p>Subclasses are passed the message to write to the log in the <code>beforeRequest</code> and
* <code>afterRequest</code> methods. By default, only the URI of the request is logged. However, setting the
* <code>includeQueryString</code> property to <code>true</code> will cause the query string of the request to be
* included also. The payload (body) of the request can be logged via the <code>includePayload</code> flag. Note that
* <p>Subclasses are passed the message to write to the log in the {@code beforeRequest} and
* {@code afterRequest} methods. By default, only the URI of the request is logged. However, setting the
* {@code includeQueryString} property to {@code true} will cause the query string of the request to be
* included also. The payload (body) of the request can be logged via the {@code includePayload} flag. Note that
* this will only log that which is read, which might not be the entire payload.
*
* <p>Prefixes and suffixes for the before and after messages can be configured using the
* <code>beforeMessagePrefix</code>, <code>afterMessagePrefix</code>, <code>beforeMessageSuffix</code> and
* <code>afterMessageSuffix</code> properties,
* {@code beforeMessagePrefix}, {@code afterMessagePrefix}, {@code beforeMessageSuffix} and
* {@code afterMessageSuffix} properties,
*
* @author Rob Harrop
* @author Juergen Hoeller
@@ -87,8 +87,8 @@ public abstract class AbstractRequestLoggingFilter extends OncePerRequestFilter
/**
* Set whether or not the query string should be included in the log message. <p>Should be configured using an
* <code>&lt;init-param&gt;</code> for parameter name "includeQueryString" in the filter definition in
* <code>web.xml</code>.
* {@code &lt;init-param&gt;} for parameter name "includeQueryString" in the filter definition in
* {@code web.xml}.
*/
public void setIncludeQueryString(boolean includeQueryString) {
this.includeQueryString = includeQueryString;
@@ -103,8 +103,8 @@ public abstract class AbstractRequestLoggingFilter extends OncePerRequestFilter
/**
* Set whether or not the client address and session id should be included in the log message. <p>Should be configured
* using an <code>&lt;init-param&gt;</code> for parameter name "includeClientInfo" in the filter definition in
* <code>web.xml</code>.
* using an {@code &lt;init-param&gt;} for parameter name "includeClientInfo" in the filter definition in
* {@code web.xml}.
*/
public void setIncludeClientInfo(boolean includeClientInfo) {
this.includeClientInfo = includeClientInfo;
@@ -119,8 +119,8 @@ public abstract class AbstractRequestLoggingFilter extends OncePerRequestFilter
/**
* Set whether or not the request payload (body) should be included in the log message. <p>Should be configured using
* an <code>&lt;init-param&gt;</code> for parameter name "includePayload" in the filter definition in
* <code>web.xml</code>.
* an {@code &lt;init-param&gt;} for parameter name "includePayload" in the filter definition in
* {@code web.xml}.
*/
public void setIncludePayload(boolean includePayload) {
@@ -238,9 +238,9 @@ public abstract class AbstractRequestLoggingFilter extends OncePerRequestFilter
}
/**
* Create a log message for the given request, prefix and suffix. <p>If <code>includeQueryString</code> is
* <code>true</code> then the inner part of the log message will take the form <code>request_uri?query_string</code>
* otherwise the message will simply be of the form <code>request_uri</code>. <p>The final message is composed of the
* Create a log message for the given request, prefix and suffix. <p>If {@code includeQueryString} is
* {@code true} then the inner part of the log message will take the form {@code request_uri?query_string}
* otherwise the message will simply be of the form {@code request_uri}. <p>The final message is composed of the
* inner part as described and the supplied prefix and suffix.
*/
protected String createMessage(HttpServletRequest request, String prefix, String suffix) {

View File

@@ -50,8 +50,8 @@ import org.springframework.web.util.NestedServletException;
/**
* Simple base implementation of {@link javax.servlet.Filter} which treats
* its config parameters (<code>init-param</code> entries within the
* <code>filter</code> tag in <code>web.xml</code>) as bean properties.
* its config parameters ({@code init-param} entries within the
* {@code filter} tag in {@code web.xml}) as bean properties.
*
* <p>A handy superclass for any type of filter. Type conversion of config
* parameters is automatic, with the corresponding setter method getting
@@ -132,10 +132,10 @@ public abstract class GenericFilterBean implements
}
/**
* Calls the <code>initFilterBean()</code> method that might
* Calls the {@code initFilterBean()} method that might
* contain custom initialization of a subclass.
* <p>Only relevant in case of initialization as bean, where the
* standard <code>init(FilterConfig)</code> method won't be called.
* standard {@code init(FilterConfig)} method won't be called.
* @see #initFilterBean()
* @see #init(javax.servlet.FilterConfig)
*/
@@ -212,10 +212,10 @@ public abstract class GenericFilterBean implements
/**
* Make the FilterConfig of this filter available, if any.
* Analogous to GenericServlet's <code>getServletConfig()</code>.
* <p>Public to resemble the <code>getFilterConfig()</code> method
* Analogous to GenericServlet's {@code getServletConfig()}.
* <p>Public to resemble the {@code getFilterConfig()} method
* of the Servlet Filter version that shipped with WebLogic 6.1.
* @return the FilterConfig instance, or <code>null</code> if none available
* @return the FilterConfig instance, or {@code null} if none available
* @see javax.servlet.GenericServlet#getServletConfig()
*/
public final FilterConfig getFilterConfig() {
@@ -224,11 +224,11 @@ public abstract class GenericFilterBean implements
/**
* Make the name of this filter available to subclasses.
* Analogous to GenericServlet's <code>getServletName()</code>.
* Analogous to GenericServlet's {@code getServletName()}.
* <p>Takes the FilterConfig's filter name by default.
* If initialized as bean in a Spring application context,
* it falls back to the bean name as defined in the bean factory.
* @return the filter name, or <code>null</code> if none available
* @return the filter name, or {@code null} if none available
* @see javax.servlet.GenericServlet#getServletName()
* @see javax.servlet.FilterConfig#getFilterName()
* @see #setBeanName
@@ -239,11 +239,11 @@ public abstract class GenericFilterBean implements
/**
* Make the ServletContext of this filter available to subclasses.
* Analogous to GenericServlet's <code>getServletContext()</code>.
* Analogous to GenericServlet's {@code getServletContext()}.
* <p>Takes the FilterConfig's ServletContext by default.
* If initialized as bean in a Spring application context,
* it falls back to the ServletContext that the bean factory runs in.
* @return the ServletContext instance, or <code>null</code> if none available
* @return the ServletContext instance, or {@code null} if none available
* @see javax.servlet.GenericServlet#getServletContext()
* @see javax.servlet.FilterConfig#getServletContext()
* @see #setServletContext

View File

@@ -31,24 +31,24 @@ import org.springframework.util.StringUtils;
* {@link javax.servlet.Filter} that converts posted method parameters into HTTP methods,
* retrievable via {@link HttpServletRequest#getMethod()}. Since browsers currently only
* support GET and POST, a common technique - used by the Prototype library, for instance -
* is to use a normal POST with an additional hidden form field (<code>_method</code>)
* is to use a normal POST with an additional hidden form field ({@code _method})
* to pass the "real" HTTP method along. This filter reads that parameter and changes
* the {@link HttpServletRequestWrapper#getMethod()} return value accordingly.
*
* <p>The name of the request parameter defaults to <code>_method</code>, but can be
* <p>The name of the request parameter defaults to {@code _method}, but can be
* adapted via the {@link #setMethodParam(String) methodParam} property.
*
* <p><b>NOTE: This filter needs to run after multipart processing in case of a multipart
* POST request, due to its inherent need for checking a POST body parameter.</b>
* So typically, put a Spring {@link org.springframework.web.multipart.support.MultipartFilter}
* <i>before</i> this HiddenHttpMethodFilter in your <code>web.xml</code> filter chain.
* <i>before</i> this HiddenHttpMethodFilter in your {@code web.xml} filter chain.
*
* @author Arjen Poutsma
* @since 3.0
*/
public class HiddenHttpMethodFilter extends OncePerRequestFilter {
/** Default method parameter: <code>_method</code> */
/** Default method parameter: {@code _method} */
public static final String DEFAULT_METHOD_PARAM = "_method";
private String methodParam = DEFAULT_METHOD_PARAM;

View File

@@ -76,7 +76,7 @@ public abstract class OncePerRequestFilter extends GenericFilterBean {
/**
* This <code>doFilter</code> implementation stores a request attribute for
* This {@code doFilter} implementation stores a request attribute for
* "already filtered", proceeding without filtering again if the
* attribute is already there.
* @see #getAlreadyFilteredAttributeName
@@ -166,8 +166,8 @@ public abstract class OncePerRequestFilter extends GenericFilterBean {
/**
* Can be overridden in subclasses for custom filtering control,
* returning <code>true</code> to avoid filtering of the given request.
* <p>The default implementation always returns <code>false</code>.
* returning {@code true} to avoid filtering of the given request.
* <p>The default implementation always returns {@code false}.
* @param request current HTTP request
* @return whether the given request should <i>not</i> be filtered
* @throws ServletException in case of errors
@@ -208,7 +208,7 @@ public abstract class OncePerRequestFilter extends GenericFilterBean {
}
/**
* Same contract as for <code>doFilter</code>, but guaranteed to be
* Same contract as for {@code doFilter}, but guaranteed to be
* just invoked once per request within a single request thread.
* See {@link #shouldNotFilterAsyncDispatch()} for details.
* <p>Provides HttpServletRequest and HttpServletResponse arguments instead of the

View File

@@ -30,7 +30,7 @@ import org.springframework.web.context.request.ServletRequestAttributes;
/**
* Servlet 2.3 Filter that exposes the request to the current thread,
* through both {@link org.springframework.context.i18n.LocaleContextHolder} and
* {@link RequestContextHolder}. To be registered as filter in <code>web.xml</code>.
* {@link RequestContextHolder}. To be registered as filter in {@code web.xml}.
*
* <p>Alternatively, Spring's {@link org.springframework.web.context.request.RequestContextListener}
* and Spring's {@link org.springframework.web.servlet.DispatcherServlet} also expose

View File

@@ -37,9 +37,9 @@ import org.springframework.web.context.request.async.WebAsyncUtils;
import org.springframework.web.util.WebUtils;
/**
* {@link javax.servlet.Filter} that generates an <code>ETag</code> value based on the content on the response.
* This ETag is compared to the <code>If-None-Match</code> header of the request. If these headers are equal,
* the response content is not sent, but rather a <code>304 "Not Modified"</code> status instead.
* {@link javax.servlet.Filter} that generates an {@code ETag} value based on the content on the response.
* This ETag is compared to the {@code If-None-Match} header of the request. If these headers are equal,
* the response content is not sent, but rather a {@code 304 "Not Modified"} status instead.
*
* <p>Since the ETag is based on the response content, the response (or {@link org.springframework.web.servlet.View})
* is still rendered. As such, this filter only saves bandwidth, not server performance.

View File

@@ -24,9 +24,9 @@ import javax.faces.context.FacesContext;
* to be capable of decorating an original NavigationHandler.
*
* <p>Supports the standard JSF style of decoration (through a constructor argument)
* as well as an overloaded <code>handleNavigation</code> method with explicit
* as well as an overloaded {@code handleNavigation} method with explicit
* NavigationHandler argument (passing in the original NavigationHandler). Subclasses
* are forced to implement this overloaded <code>handleNavigation</code> method.
* are forced to implement this overloaded {@code handleNavigation} method.
* Standard JSF invocations will automatically delegate to the overloaded method,
* with the constructor-injected NavigationHandler as argument.
*
@@ -64,7 +64,7 @@ public abstract class DecoratingNavigationHandler extends NavigationHandler {
/**
* This implementation of the standard JSF <code>handleNavigation</code> method
* This implementation of the standard JSF {@code handleNavigation} method
* delegates to the overloaded variant, passing in constructor-injected
* NavigationHandler as argument.
* @see #handleNavigation(javax.faces.context.FacesContext, String, String, javax.faces.application.NavigationHandler)
@@ -75,23 +75,23 @@ public abstract class DecoratingNavigationHandler extends NavigationHandler {
}
/**
* Special <code>handleNavigation</code> variant with explicit NavigationHandler
* Special {@code handleNavigation} variant with explicit NavigationHandler
* argument. Either called directly, by code with an explicit original handler,
* or called from the standard <code>handleNavigation</code> method, as
* or called from the standard {@code handleNavigation} method, as
* plain JSF-defined NavigationHandler.
* <p>Implementations should invoke <code>callNextHandlerInChain</code> to
* <p>Implementations should invoke {@code callNextHandlerInChain} to
* delegate to the next handler in the chain. This will always call the most
* appropriate next handler (see <code>callNextHandlerInChain</code> javadoc).
* appropriate next handler (see {@code callNextHandlerInChain} javadoc).
* Alternatively, the decorated NavigationHandler or the passed-in original
* NavigationHandler can also be called directly; however, this is not as
* flexible in terms of reacting to potential positions in the chain.
* @param facesContext the current JSF context
* @param fromAction the action binding expression that was evaluated to retrieve the
* specified outcome, or <code>null</code> if the outcome was acquired by some other means
* specified outcome, or {@code null} if the outcome was acquired by some other means
* @param outcome the logical outcome returned by a previous invoked application action
* (which may be <code>null</code>)
* (which may be {@code null})
* @param originalNavigationHandler the original NavigationHandler,
* or <code>null</code> if none
* or {@code null} if none
* @see #callNextHandlerInChain
*/
public abstract void handleNavigation(
@@ -120,11 +120,11 @@ public abstract class DecoratingNavigationHandler extends NavigationHandler {
* as earlier elements), this method corresponds to a no-op.
* @param facesContext the current JSF context
* @param fromAction the action binding expression that was evaluated to retrieve the
* specified outcome, or <code>null</code> if the outcome was acquired by some other means
* specified outcome, or {@code null} if the outcome was acquired by some other means
* @param outcome the logical outcome returned by a previous invoked application action
* (which may be <code>null</code>)
* (which may be {@code null})
* @param originalNavigationHandler the original NavigationHandler,
* or <code>null</code> if none
* or {@code null} if none
*/
protected final void callNextHandlerInChain(
FacesContext facesContext, String fromAction, String outcome, NavigationHandler originalNavigationHandler) {

View File

@@ -26,7 +26,7 @@ import org.springframework.web.context.WebApplicationContext;
* JSF NavigationHandler implementation that delegates to a NavigationHandler
* bean obtained from the Spring root WebApplicationContext.
*
* <p>Configure this handler proxy in your <code>faces-config.xml</code> file
* <p>Configure this handler proxy in your {@code faces-config.xml} file
* as follows:
*
* <pre>
@@ -101,8 +101,8 @@ public class DelegatingNavigationHandlerProxy extends NavigationHandler {
* through delegating to the target bean in the Spring application context.
* <p>The target bean needs to extend the JSF NavigationHandler class.
* If it extends Spring's DecoratingNavigationHandler, the overloaded
* <code>handleNavigation</code> method with the original NavigationHandler
* as argument will be used. Else, the standard <code>handleNavigation</code>
* {@code handleNavigation} method with the original NavigationHandler
* as argument will be used. Else, the standard {@code handleNavigation}
* method will be called.
*/
@Override
@@ -143,11 +143,11 @@ public class DelegatingNavigationHandlerProxy extends NavigationHandler {
/**
* Retrieve the Spring BeanFactory to delegate bean name resolution to.
* <p>Default implementation delegates to <code>getWebApplicationContext</code>.
* <p>Default implementation delegates to {@code getWebApplicationContext}.
* Can be overridden to provide an arbitrary BeanFactory reference to resolve
* against; usually, this will be a full Spring ApplicationContext.
* @param facesContext the current JSF context
* @return the Spring BeanFactory (never <code>null</code>)
* @return the Spring BeanFactory (never {@code null})
* @see #getWebApplicationContext
*/
protected BeanFactory getBeanFactory(FacesContext facesContext) {
@@ -158,7 +158,7 @@ public class DelegatingNavigationHandlerProxy extends NavigationHandler {
* Retrieve the web application context to delegate bean name resolution to.
* <p>Default implementation delegates to FacesContextUtils.
* @param facesContext the current JSF context
* @return the Spring web application context (never <code>null</code>)
* @return the Spring web application context (never {@code null})
* @see FacesContextUtils#getRequiredWebApplicationContext
*/
protected WebApplicationContext getWebApplicationContext(FacesContext facesContext) {

View File

@@ -30,7 +30,7 @@ import org.springframework.web.context.WebApplicationContext;
* JSF PhaseListener implementation that delegates to one or more Spring-managed
* PhaseListener beans coming from the Spring root WebApplicationContext.
*
* <p>Configure this listener multicaster in your <code>faces-config.xml</code> file
* <p>Configure this listener multicaster in your {@code faces-config.xml} file
* as follows:
*
* <pre class="code">
@@ -42,13 +42,13 @@ import org.springframework.web.context.WebApplicationContext;
* ...
* &lt;/application&gt;</pre>
*
* The multicaster will delegate all <code>beforePhase</code> and <code>afterPhase</code>
* The multicaster will delegate all {@code beforePhase} and {@code afterPhase}
* events to all target PhaseListener beans. By default, those will simply be obtained
* by type: All beans in the Spring root WebApplicationContext that implement the
* PhaseListener interface will be fetched and invoked.
*
* <p>Note: This multicaster's <code>getPhaseId()</code> method will always return
* <code>ANY_PHASE</code>. <b>The phase id exposed by the target listener beans
* <p>Note: This multicaster's {@code getPhaseId()} method will always return
* {@code ANY_PHASE}. <b>The phase id exposed by the target listener beans
* will be ignored; all events will be propagated to all listeners.</b>
*
* <p>This multicaster may be subclassed to change the strategy used to obtain
@@ -92,11 +92,11 @@ public class DelegatingPhaseListenerMulticaster implements PhaseListener {
/**
* Retrieve the Spring BeanFactory to delegate bean name resolution to.
* <p>The default implementation delegates to <code>getWebApplicationContext</code>.
* <p>The default implementation delegates to {@code getWebApplicationContext}.
* Can be overridden to provide an arbitrary ListableBeanFactory reference to
* resolve against; usually, this will be a full Spring ApplicationContext.
* @param facesContext the current JSF context
* @return the Spring ListableBeanFactory (never <code>null</code>)
* @return the Spring ListableBeanFactory (never {@code null})
* @see #getWebApplicationContext
*/
protected ListableBeanFactory getBeanFactory(FacesContext facesContext) {
@@ -107,7 +107,7 @@ public class DelegatingPhaseListenerMulticaster implements PhaseListener {
* Retrieve the web application context to delegate bean name resolution to.
* <p>The default implementation delegates to FacesContextUtils.
* @param facesContext the current JSF context
* @return the Spring web application context (never <code>null</code>)
* @return the Spring web application context (never {@code null})
* @see FacesContextUtils#getRequiredWebApplicationContext
*/
protected WebApplicationContext getWebApplicationContext(FacesContext facesContext) {

View File

@@ -28,13 +28,13 @@ import org.springframework.util.Assert;
import org.springframework.web.context.WebApplicationContext;
/**
* JSF 1.1 <code>VariableResolver</code> that first delegates to the
* JSF 1.1 {@code VariableResolver} that first delegates to the
* original resolver of the underlying JSF implementation (for resolving
* managed-bean objects as defined in <code>faces-config.xml</code>
* managed-bean objects as defined in {@code faces-config.xml}
* as well as well-known implicit EL attributes), then to the Spring
* root <code>WebApplicationContext</code> (for resolving Spring beans).
* root {@code WebApplicationContext} (for resolving Spring beans).
*
* <p>Configure this resolver in your <code>faces-config.xml</code> file as follows:
* <p>Configure this resolver in your {@code faces-config.xml} file as follows:
*
* <pre>
* &lt;application>
@@ -148,11 +148,11 @@ public class DelegatingVariableResolver extends VariableResolver {
/**
* Retrieve the Spring BeanFactory to delegate bean name resolution to.
* <p>The default implementation delegates to <code>getWebApplicationContext</code>.
* <p>The default implementation delegates to {@code getWebApplicationContext}.
* Can be overridden to provide an arbitrary BeanFactory reference to resolve
* against; usually, this will be a full Spring ApplicationContext.
* @param facesContext the current JSF context
* @return the Spring BeanFactory (never <code>null</code>)
* @return the Spring BeanFactory (never {@code null})
* @see #getWebApplicationContext
*/
protected BeanFactory getBeanFactory(FacesContext facesContext) {
@@ -163,7 +163,7 @@ public class DelegatingVariableResolver extends VariableResolver {
* Retrieve the web application context to delegate bean name resolution to.
* <p>The default implementation delegates to FacesContextUtils.
* @param facesContext the current JSF context
* @return the Spring web application context (never <code>null</code>)
* @return the Spring web application context (never {@code null})
* @see FacesContextUtils#getRequiredWebApplicationContext
*/
protected WebApplicationContext getWebApplicationContext(FacesContext facesContext) {

View File

@@ -43,7 +43,7 @@ public abstract class FacesContextUtils {
* <p>Will rethrow an exception that happened on root context startup,
* to differentiate between a failed context startup and no context at all.
* @param fc the FacesContext to find the web application context for
* @return the root WebApplicationContext for this web app, or <code>null</code> if none
* @return the root WebApplicationContext for this web app, or {@code null} if none
* @see org.springframework.web.context.WebApplicationContext#ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE
*/
public static WebApplicationContext getWebApplicationContext(FacesContext fc) {
@@ -90,18 +90,18 @@ public abstract class FacesContextUtils {
* that is, an object to synchronize on for the given session.
* <p>Returns the session mutex attribute if available; usually,
* this means that the HttpSessionMutexListener needs to be defined
* in <code>web.xml</code>. Falls back to the Session reference itself
* in {@code web.xml}. Falls back to the Session reference itself
* if no mutex attribute found.
* <p>The session mutex is guaranteed to be the same object during
* the entire lifetime of the session, available under the key defined
* by the <code>SESSION_MUTEX_ATTRIBUTE</code> constant. It serves as a
* by the {@code SESSION_MUTEX_ATTRIBUTE} constant. It serves as a
* safe reference to synchronize on for locking on the current session.
* <p>In many cases, the Session reference itself is a safe mutex
* as well, since it will always be the same object reference for the
* same active logical session. However, this is not guaranteed across
* different servlet containers; the only 100% safe way is a session mutex.
* @param fc the FacesContext to find the session mutex for
* @return the mutex object (never <code>null</code>)
* @return the mutex object (never {@code null})
* @see org.springframework.web.util.WebUtils#SESSION_MUTEX_ATTRIBUTE
* @see org.springframework.web.util.HttpSessionMutexListener
*/

View File

@@ -24,8 +24,8 @@ import org.springframework.util.Assert;
import org.springframework.web.context.WebApplicationContext;
/**
* Special JSF 1.1 <code>VariableResolver</code> that exposes the Spring
* <code>WebApplicationContext</code> instance under a variable named
* Special JSF 1.1 {@code VariableResolver} that exposes the Spring
* {@code WebApplicationContext} instance under a variable named
* "webApplicationContext".
*
* <p>In contrast to {@link DelegatingVariableResolver}, this VariableResolver
@@ -34,7 +34,7 @@ import org.springframework.web.context.WebApplicationContext;
* JSF-managed beans can then use Spring's WebApplicationContext API to retrieve
* Spring-managed beans, access resources, etc.
*
* <p>Configure this resolver in your <code>faces-config.xml</code> file as follows:
* <p>Configure this resolver in your {@code faces-config.xml} file as follows:
*
* <pre>
* &lt;application>
@@ -105,7 +105,7 @@ public class WebApplicationContextVariableResolver extends VariableResolver {
/**
* Retrieve the WebApplicationContext reference to expose.
* <p>The default implementation delegates to FacesContextUtils,
* returning <code>null</code> if no WebApplicationContext found.
* returning {@code null} if no WebApplicationContext found.
* @param facesContext the current JSF context
* @return the Spring web application context
* @see FacesContextUtils#getWebApplicationContext

View File

@@ -25,11 +25,11 @@ import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.jsf.FacesContextUtils;
/**
* JSF 1.2 <code>ELResolver</code> that delegates to the Spring root
* <code>WebApplicationContext</code>, resolving name references to
* JSF 1.2 {@code ELResolver} that delegates to the Spring root
* {@code WebApplicationContext}, resolving name references to
* Spring-defined beans.
*
* <p>Configure this resolver in your <code>faces-config.xml</code> file as follows:
* <p>Configure this resolver in your {@code faces-config.xml} file as follows:
*
* <pre>
* &lt;application>
@@ -72,7 +72,7 @@ public class SpringBeanFacesELResolver extends SpringBeanELResolver {
* Can be overridden to provide an arbitrary BeanFactory reference to resolve
* against; usually, this will be a full Spring ApplicationContext.
* @param elContext the current JSF ELContext
* @return the Spring BeanFactory (never <code>null</code>)
* @return the Spring BeanFactory (never {@code null})
*/
@Override
protected BeanFactory getBeanFactory(ELContext elContext) {
@@ -83,7 +83,7 @@ public class SpringBeanFacesELResolver extends SpringBeanELResolver {
* Retrieve the web application context to delegate bean name resolution to.
* <p>The default implementation delegates to FacesContextUtils.
* @param elContext the current JSF ELContext
* @return the Spring web application context (never <code>null</code>)
* @return the Spring web application context (never {@code null})
* @see org.springframework.web.jsf.FacesContextUtils#getRequiredWebApplicationContext
*/
protected WebApplicationContext getWebApplicationContext(ELContext elContext) {

View File

@@ -32,8 +32,8 @@ import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.jsf.FacesContextUtils;
/**
* Special JSF 1.2 <code>ELResolver</code> that exposes the Spring
* <code>WebApplicationContext</code> instance under a variable named
* Special JSF 1.2 {@code ELResolver} that exposes the Spring
* {@code WebApplicationContext} instance under a variable named
* "webApplicationContext".
*
* <p>In contrast to {@link SpringBeanFacesELResolver}, this ELResolver variant
@@ -42,7 +42,7 @@ import org.springframework.web.jsf.FacesContextUtils;
* and is able to resolve "webApplicationContext.mySpringManagedBusinessObject"
* dereferences to Spring-defined beans in that application context.
*
* <p>Configure this resolver in your <code>faces-config.xml</code> file as follows:
* <p>Configure this resolver in your {@code faces-config.xml} file as follows:
*
* <pre>
* &lt;application>
@@ -168,7 +168,7 @@ public class WebApplicationContextFacesELResolver extends ELResolver {
/**
* Retrieve the WebApplicationContext reference to expose.
* <p>The default implementation delegates to FacesContextUtils,
* returning <code>null</code> if no WebApplicationContext found.
* returning {@code null} if no WebApplicationContext found.
* @param elContext the current JSF ELContext
* @return the Spring web application context
* @see org.springframework.web.jsf.FacesContextUtils#getWebApplicationContext

View File

@@ -1,8 +1,7 @@
/**
*
* Common infrastructure for handler method processing, as used by
* Spring MVC's <code>org.springframework.web.servlet.mvc.method</code> package.
* Spring MVC's {@code org.springframework.web.servlet.mvc.method} package.
*
*/
package org.springframework.web.method;

View File

@@ -214,7 +214,7 @@ public class ModelAndViewContainer {
}
/**
* Copy attributes in the supplied <code>Map</code> with existing objects of
* Copy attributes in the supplied {@code Map} with existing objects of
* the same name taking precedence (i.e. not getting replaced).
* A shortcut for {@code getModel().mergeAttributes(Map<String, ?>)}.
*/

Some files were not shown because too many files have changed in this diff Show More