Fix various javadoc warnings

This commit is contained in:
Phillip Webb 2013-11-26 13:24:19 -08:00
parent c7c395d0d0
commit a31ac882c5
52 changed files with 112 additions and 162 deletions

View File

@ -93,8 +93,9 @@ configure(allprojects) { project ->
"http://www.eclipse.org/aspectj/doc/released/aspectj5rt-api/",
"http://ehcache.org/apidocs/",
"http://quartz-scheduler.org/api/2.1.7/",
"http://jackson.codehaus.org/1.9.12/javadoc/",
"http://fasterxml.github.com/jackson-core/javadoc/2.2.2/",
"http://jackson.codehaus.org/1.9.4/javadoc/",
"http://fasterxml.github.com/jackson-core/javadoc/2.2.0/",
"http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs"
] as String[]
}

View File

@ -91,8 +91,6 @@ import org.springframework.util.ClassUtils;
* @see ConfigurableBeanFactory#addPropertyEditorRegistrar
* @see ConfigurableBeanFactory#registerCustomEditor
* @see org.springframework.validation.DataBinder#registerCustomEditor
* @see org.springframework.web.servlet.mvc.BaseCommandController#setPropertyEditorRegistrars
* @see org.springframework.web.servlet.mvc.BaseCommandController#initBinder
*/
public class CustomEditorConfigurer implements BeanFactoryPostProcessor, Ordered {

View File

@ -29,13 +29,11 @@ import org.springframework.util.StringUtils;
* them in the UI form.
*
* <p>In web MVC code, this editor will typically be registered with
* {@code binder.registerCustomEditor} calls in an implementation
* of BaseCommandController's {@code initBinder} method.
* {@code binder.registerCustomEditor} calls.
*
* @author Juergen Hoeller
* @since 10.06.2003
* @see org.springframework.validation.DataBinder#registerCustomEditor
* @see org.springframework.web.servlet.mvc.BaseCommandController#initBinder
*/
public class CustomBooleanEditor extends PropertyEditorSupport {

View File

@ -33,15 +33,13 @@ import org.springframework.util.StringUtils;
* and rendering them in the UI form.
*
* <p>In web MVC code, this editor will typically be registered with
* {@code binder.registerCustomEditor} calls in a custom
* {@code initBinder} method.
* {@code binder.registerCustomEditor}.
*
* @author Juergen Hoeller
* @since 28.04.2003
* @see java.util.Date
* @see java.text.DateFormat
* @see org.springframework.validation.DataBinder#registerCustomEditor
* @see org.springframework.web.servlet.mvc.BaseCommandController#initBinder
*/
public class CustomDateEditor extends PropertyEditorSupport {

View File

@ -34,15 +34,13 @@ import org.springframework.util.StringUtils;
* and rendering them in the UI form.
*
* <p>In web MVC code, this editor will typically be registered with
* {@code binder.registerCustomEditor} calls in a custom
* {@code initBinder} method.
* {@code binder.registerCustomEditor} calls.
*
* @author Juergen Hoeller
* @since 06.06.2003
* @see Number
* @see java.text.NumberFormat
* @see org.springframework.validation.DataBinder#registerCustomEditor
* @see org.springframework.web.servlet.mvc.BaseCommandController#initBinder
*/
public class CustomNumberEditor extends PropertyEditorSupport {

View File

@ -28,7 +28,6 @@ import org.springframework.util.StringUtils;
*
* @author Juergen Hoeller
* @see org.springframework.validation.DataBinder#registerCustomEditor
* @see org.springframework.web.servlet.mvc.BaseCommandController#initBinder
*/
public class StringTrimmerEditor extends PropertyEditorSupport {

View File

@ -146,7 +146,7 @@ public class MutableSortDefinition implements SortDefinition, Serializable {
/**
* Return whether to toggle the ascending flag if the same property gets set again
* (that is, {@link #setProperty} gets called with already set property name again).
* (that is, {@code setProperty} gets called with already set property name again).
*/
public boolean isToggleAscendingOnProperty() {
return this.toggleAscendingOnProperty;

View File

@ -194,7 +194,6 @@ public class FreeMarkerConfigurationFactory {
* @see org.springframework.context.ApplicationContext#getResource
* @see freemarker.template.Configuration#setDirectoryForTemplateLoading
* @see SpringTemplateLoader
* @see #setTemplateLoaders
*/
public void setTemplateLoaderPaths(String... templateLoaderPaths) {
this.templateLoaderPaths = templateLoaderPaths;

View File

@ -53,8 +53,8 @@ import org.springframework.util.StringUtils;
* to the Spring application context.
*
* <p>If "overrideLogging" is true (the default), the VelocityEngine will be
* configured to log via Commons Logging, that is, using the Spring-provided
* {@link CommonsLoggingLogSystem} as log system.
* configured to log via Commons Logging, that is, using
* {@link CommonsLogLogChute} as log system.
*
* <p>The simplest way to use this class is to specify a
* {@link #setResourceLoaderPath(String) "resourceLoaderPath"}; the
@ -66,7 +66,6 @@ import org.springframework.util.StringUtils;
* @see #setResourceLoaderPath
* @see #setOverrideLogging
* @see #createVelocityEngine
* @see CommonsLoggingLogSystem
* @see VelocityEngineFactoryBean
* @see org.springframework.web.servlet.view.velocity.VelocityConfigurer
* @see org.apache.velocity.app.VelocityEngine

View File

@ -34,7 +34,7 @@ import static org.springframework.context.weaving.AspectJWeavingEnabler.*;
* {@code @Configuration} class that registers a {@link LoadTimeWeaver} bean.
*
* <p>This configuration class is automatically imported when using the
* @{@link EnableLoadTimeWeaving} annotation. See {@code @EnableLoadTimeWeaving}
* {@link EnableLoadTimeWeaving} annotation. See {@code @EnableLoadTimeWeaving}
* javadoc for complete usage details.
*
* @author Chris Beams

View File

@ -39,7 +39,7 @@ import org.springframework.util.StringUtils;
* {@code @Configuration} class that registers a {@link AnnotationMBeanExporter} bean.
*
* <p>This configuration class is automatically imported when using the
* @{@link EnableMBeanExport} annotation. See its javadoc for complete usage details.
* {@link EnableMBeanExport} annotation. See its javadoc for complete usage details.
*
* @author Phillip Webb
* @author Chris Beams

View File

@ -26,7 +26,7 @@ import org.springframework.util.ClassUtils;
/**
* {@link LoadTimeWeaver} implementation for GlassFish's
* {@link org.glassfish.api.deployment.InstrumentableClassLoader InstrumentableClassLoader}.
* {@code org.glassfish.api.deployment.InstrumentableClassLoader InstrumentableClassLoader}.
*
* <p>As of Spring 4.0, this weaver supports GlassFish V3 and V4.
*

View File

@ -1,8 +1,5 @@
/**
*
* Support for class instrumentation on Tomcat.
*
*/
package org.springframework.instrument.classloading.tomcat;

View File

@ -262,15 +262,11 @@ public abstract class AbstractBindingResult extends AbstractErrors implements Bi
* Adding things to the map and then re-calling this method will not work.
* <p>The attributes in the model Map returned by this method are usually
* included in the ModelAndView for a form view that uses Spring's bind tag,
* which needs access to the Errors instance. Spring's SimpleFormController
* will do this for you when rendering its form or success view. When
* building the ModelAndView yourself, you need to include the attributes
* from the model Map returned by this method yourself.
* which needs access to the Errors instance.
* @see #getObjectName
* @see #MODEL_KEY_PREFIX
* @see org.springframework.web.servlet.ModelAndView
* @see org.springframework.web.servlet.tags.BindTag
* @see org.springframework.web.servlet.mvc.SimpleFormController
*/
@Override
public Map<String, Object> getModel() {

View File

@ -73,7 +73,6 @@ public interface BindingResult extends Errors {
* @see #MODEL_KEY_PREFIX
* @see org.springframework.web.servlet.ModelAndView
* @see org.springframework.web.servlet.tags.BindTag
* @see org.springframework.web.servlet.mvc.SimpleFormController
*/
Map<String, Object> getModel();

View File

@ -111,7 +111,7 @@ public class Label {
* Field used to associate user information to a label. Warning: this field
* is used by the ASM tree package. In order to use it with the ASM tree
* package you must override the
* {@link org.objectweb.asm.tree.MethodNode#getLabelNode} method.
* {@code org.objectweb.asm.tree.MethodNode#getLabelNode} method.
*/
public Object info;

View File

@ -103,7 +103,7 @@ public final class ResolvableType implements Serializable {
private TypeProvider typeProvider;
/**
* The {@link VariableResolver} to use or {@code null} if no resolver is available.
* The {@code VariableResolver} to use or {@code null} if no resolver is available.
*/
private final VariableResolver variableResolver;

View File

@ -261,8 +261,8 @@ public class AntPathMatcher implements PathMatcher {
/**
* Build or retrieve an {@link AntPathStringMatcher} for the given pattern.
* <p>The default implementation checks this AntPathMatcher's internal cache
* (see {@link #setCachePatterns}, creating a new AntPathStringMatcher instance
* through {@link AntPathStringMatcher#AntPathStringMatcher(String)} if none found.
* (see {@link #setCachePatterns}), creating a new AntPathStringMatcher instance
* if no cached copy is found.
* When encountering too many patterns to cache at runtime (the threshold is 65536),
* it turns the default cache off, assuming that arbitrary permutations of patterns
* are coming in, with little chance for encountering a reoccurring pattern.

View File

@ -17,7 +17,7 @@
package org.springframework.util;
/**
* Exception thrown from {@link MediaType#parseMimeType(String)} in case of
* Exception thrown from {@link MimeTypeUtils#parseMimeType(String)} in case of
* encountering an invalid content type specification String.
*
* @author Juergen Hoeller

View File

@ -33,17 +33,15 @@ import java.util.TreeSet;
* other Internet protocols including HTTP. This class however does not contain support
* the q-parameters used in HTTP content negotiation. Those can be found in the sub-class
* {@code org.springframework.http.MediaType} in the {@code spring-web} module.
* <p>
* Consists of a {@linkplain #getType() type} and a {@linkplain #getSubtype() subtype}.
*
* <p>Consists of a {@linkplain #getType() type} and a {@linkplain #getSubtype() subtype}.
* Also has functionality to parse media types from a string using
* {@link #parseMimeType(String)}, or multiple comma-separated media types using
* {@link #parseMimeTypes(String)}.
* {@link #valueOf(String)}. For more parsing options see {@link MimeTypeUtils}.
*
* @author Arjen Poutsma
* @author Juergen Hoeller
* @author Rossen Stoyanchev
* @since 4.0
*
* @see MimeTypeUtils
*/
public class MimeType implements Comparable<MimeType>, Serializable {
@ -324,10 +322,12 @@ public class MimeType implements Comparable<MimeType>, Serializable {
/**
* Indicate whether this {@code MediaType} is compatible with the given media type.
* <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.
* <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}, except that it <b>is</b> symmetric.
* @param other the reference media type with which to compare
* @return {@code true} if this media type is compatible with the given media type; {@code false} otherwise
* @return {@code true} if this media type is compatible with the given media type;
* {@code false} otherwise
*/
public boolean isCompatibleWith(MimeType other) {
if (other == null) {
@ -369,7 +369,7 @@ public class MimeType implements Comparable<MimeType>, Serializable {
/**
* Compares this {@code MediaType} to another alphabetically.
* @param other media type to compare to
* @see #sortBySpecificity(List)
* @see MimeTypeUtils#sortBySpecificity(List)
*/
@Override
public int compareTo(MimeType other) {
@ -459,7 +459,7 @@ public class MimeType implements Comparable<MimeType>, Serializable {
* Parse the given String value into a {@code MimeType} object,
* with this method name following the 'valueOf' naming convention
* (as supported by {@link org.springframework.core.convert.ConversionService}.
* @see #parseMimeType(String)
* @see MimeTypeUtils#parseMimeType(String)
*/
public static MimeType valueOf(String value) {
return MimeTypeUtils.parseMimeType(value);

View File

@ -28,15 +28,13 @@ import java.util.Map;
import org.springframework.util.MimeType.SpecificityComparator;
/**
*
* @author Arjen Poutsma
* @author Rossen Stoyanchev
* @since 4.0
*/
public class MimeTypeUtils {
public abstract class MimeTypeUtils {
/**
* Public constant mime type that includes all media ranges (i.e. "&#42;/&#42;").
@ -44,7 +42,7 @@ public class MimeTypeUtils {
public static final MimeType ALL;
/**
* A String equivalent of {@link MediaType#ALL}.
* A String equivalent of {@link MimeTypeUtils#ALL}.
*/
public static final String ALL_VALUE = "*/*";
@ -54,7 +52,7 @@ public class MimeTypeUtils {
public final static MimeType APPLICATION_ATOM_XML;
/**
* A String equivalent of {@link MimeType#APPLICATION_ATOM_XML}.
* A String equivalent of {@link MimeTypeUtils#APPLICATION_ATOM_XML}.
*/
public final static String APPLICATION_ATOM_XML_VALUE = "application/atom+xml";
@ -64,7 +62,7 @@ public class MimeTypeUtils {
public final static MimeType APPLICATION_FORM_URLENCODED;
/**
* A String equivalent of {@link MimeType#APPLICATION_FORM_URLENCODED}.
* A String equivalent of {@link MimeTypeUtils#APPLICATION_FORM_URLENCODED}.
*/
public final static String APPLICATION_FORM_URLENCODED_VALUE = "application/x-www-form-urlencoded";
@ -74,7 +72,7 @@ public class MimeTypeUtils {
public final static MimeType APPLICATION_JSON;
/**
* A String equivalent of {@link MimeType#APPLICATION_JSON}.
* A String equivalent of {@link MimeTypeUtils#APPLICATION_JSON}.
*/
public final static String APPLICATION_JSON_VALUE = "application/json";
@ -84,7 +82,7 @@ public class MimeTypeUtils {
public final static MimeType APPLICATION_OCTET_STREAM;
/**
* A String equivalent of {@link MimeType#APPLICATION_OCTET_STREAM}.
* A String equivalent of {@link MimeTypeUtils#APPLICATION_OCTET_STREAM}.
*/
public final static String APPLICATION_OCTET_STREAM_VALUE = "application/octet-stream";
@ -94,7 +92,7 @@ public class MimeTypeUtils {
public final static MimeType APPLICATION_XHTML_XML;
/**
* A String equivalent of {@link MimeType#APPLICATION_XHTML_XML}.
* A String equivalent of {@link MimeTypeUtils#APPLICATION_XHTML_XML}.
*/
public final static String APPLICATION_XHTML_XML_VALUE = "application/xhtml+xml";
@ -104,7 +102,7 @@ public class MimeTypeUtils {
public final static MimeType APPLICATION_XML;
/**
* A String equivalent of {@link MimeType#APPLICATION_XML}.
* A String equivalent of {@link MimeTypeUtils#APPLICATION_XML}.
*/
public final static String APPLICATION_XML_VALUE = "application/xml";
@ -114,7 +112,7 @@ public class MimeTypeUtils {
public final static MimeType IMAGE_GIF;
/**
* A String equivalent of {@link MimeType#IMAGE_GIF}.
* A String equivalent of {@link MimeTypeUtils#IMAGE_GIF}.
*/
public final static String IMAGE_GIF_VALUE = "image/gif";
@ -124,7 +122,7 @@ public class MimeTypeUtils {
public final static MimeType IMAGE_JPEG;
/**
* A String equivalent of {@link MimeType#IMAGE_JPEG}.
* A String equivalent of {@link MimeTypeUtils#IMAGE_JPEG}.
*/
public final static String IMAGE_JPEG_VALUE = "image/jpeg";
@ -134,7 +132,7 @@ public class MimeTypeUtils {
public final static MimeType IMAGE_PNG;
/**
* A String equivalent of {@link MimeType#IMAGE_PNG}.
* A String equivalent of {@link MimeTypeUtils#IMAGE_PNG}.
*/
public final static String IMAGE_PNG_VALUE = "image/png";
@ -144,7 +142,7 @@ public class MimeTypeUtils {
public final static MimeType MULTIPART_FORM_DATA;
/**
* A String equivalent of {@link MimeType#MULTIPART_FORM_DATA}.
* A String equivalent of {@link MimeTypeUtils#MULTIPART_FORM_DATA}.
*/
public final static String MULTIPART_FORM_DATA_VALUE = "multipart/form-data";
@ -154,7 +152,7 @@ public class MimeTypeUtils {
public final static MimeType TEXT_HTML;
/**
* A String equivalent of {@link MimeType#TEXT_HTML}.
* A String equivalent of {@link MimeTypeUtils#TEXT_HTML}.
*/
public final static String TEXT_HTML_VALUE = "text/html";
@ -164,7 +162,7 @@ public class MimeTypeUtils {
public final static MimeType TEXT_PLAIN;
/**
* A String equivalent of {@link MimeType#TEXT_PLAIN}.
* A String equivalent of {@link MimeTypeUtils#TEXT_PLAIN}.
*/
public final static String TEXT_PLAIN_VALUE = "text/plain";
@ -174,7 +172,7 @@ public class MimeTypeUtils {
public final static MimeType TEXT_XML;
/**
* A String equivalent of {@link MimeType#TEXT_XML}.
* A String equivalent of {@link MimeTypeUtils#TEXT_XML}.
*/
public final static String TEXT_XML_VALUE = "text/xml";
@ -294,16 +292,16 @@ public class MimeTypeUtils {
* <p>
* Given two mime types:
* <ol>
* <li>if either mime type has a {@linkplain #isWildcardType() wildcard type}, then
* the mime type without the wildcard is ordered before the other.</li>
* <li>if the two mime types have different {@linkplain #getType() types}, then
* they are considered equal and remain their current order.</li>
* <li>if either mime type has a {@linkplain #isWildcardSubtype() wildcard subtype}
* <li>if either mime type has a {@linkplain MimeType#isWildcardType() wildcard type},
* then the mime type without the wildcard is ordered before the other.</li>
* <li>if the two mime types have different {@linkplain MimeType#getType() types},
* then they are considered equal and remain their current order.</li>
* <li>if either mime type has a {@linkplain MimeType#isWildcardSubtype() wildcard subtype}
* , then the mime type without the wildcard is sorted before the other.</li>
* <li>if the two mime types have different {@linkplain #getSubtype() subtypes},
* <li>if the two mime types have different {@linkplain MimeType#getSubtype() subtypes},
* then they are considered equal and remain their current order.</li>
* <li>if the two mime types have a different amount of
* {@linkplain #getParameter(String) parameters}, then the mime type with the most
* {@linkplain MimeType#getParameter(String) parameters}, then the mime type with the most
* parameters is ordered before the other.</li>
* </ol>
* <p>

View File

@ -26,7 +26,7 @@ import org.springframework.util.Assert;
/**
* Abstract class that adapts a {@link Future} parameterized over S into a {@code
* Future} parameterized over T. All methods are delegated to the adaptee, where {@link
* #get()} and {@link #get(long, TimeUnit)} call {@@link #adapt(Object)} on the adaptee's
* #get()} and {@link #get(long, TimeUnit)} call {@link #adapt(Object)} on the adaptee's
* result.
*
* @param <T> the type of this {@code Future}

View File

@ -22,7 +22,7 @@ import java.util.concurrent.Future;
* Extends the {@link Future} interface with the capability to accept completion
* callbacks. If the future has already completed when the callback is added, the
* callback will be triggered immediately.
* <p>Inspired by {@link com.google.common.util.concurrent.ListenableFuture}.
* <p>Inspired by {@code com.google.common.util.concurrent.ListenableFuture}.
* @author Arjen Poutsma
* @since 4.0
@ -33,7 +33,6 @@ public interface ListenableFuture<T> extends Future<T> {
* Registers the given callback to this {@code ListenableFuture}. The callback will
* be triggered when this {@code Future} is complete or, if it is already complete,
* immediately.
*
* @param callback the callback to register
*/
void addCallback(ListenableFutureCallback<? super T> callback);

View File

@ -22,7 +22,7 @@ import java.util.concurrent.ExecutionException;
* Abstract class that adapts a {@link ListenableFuture} parameterized over S into a
* {@code ListenableFuture} parameterized over T. All methods are delegated to the
* adaptee, where {@link #get()}, {@link #get(long, java.util.concurrent.TimeUnit)}, and
* {@link ListenableFutureCallback#onSuccess(Object)} call {@@link #adapt(Object)} on the
* {@link ListenableFutureCallback#onSuccess(Object)} call {@link #adapt(Object)} on the
* adaptee's result.
*
* @param <T> the type of this {@code Future}

View File

@ -23,7 +23,9 @@ import org.springframework.util.Assert;
/**
* Registry for {@link ListenableFutureCallback} instances.
* <p>Inspired by {@link com.google.common.util.concurrent.ExecutionList}.
*
* <p>Inspired by {@code com.google.common.util.concurrent.ExecutionList}.
*
* @author Arjen Poutsma
* @since 4.0
*/

View File

@ -1,8 +0,0 @@
/**
*
* Support for class instrumentation on Apache Tomcat.
*
*/
package org.springframework.instrument.classloading.tomcat;

View File

@ -46,8 +46,8 @@ import org.springframework.util.ReflectionUtils;
*
* <p>If you want to use dynamic destination creation, you must specify
* the type of JMS destination to create, using the "pubSubDomain" property.
* For other operations, this is not necessary, in contrast to when working
* with {@link JmsTemplate102}. Point-to-Point (Queues) is the default domain.
* For other operations, this is not necessary. Point-to-Point (Queues) is the default
* domain.
*
* <p>Default settings for JMS Sessions are "not transacted" and "auto-acknowledge".
* As defined by the J2EE specification, the transaction and acknowledgement

View File

@ -63,11 +63,10 @@ public abstract class JmsGatewaySupport implements InitializingBean {
* Create a JmsTemplate for the given ConnectionFactory.
* Only invoked if populating the gateway with a ConnectionFactory reference.
* <p>Can be overridden in subclasses to provide a JmsTemplate instance with
* a different configuration or the JMS 1.0.2 version, JmsTemplate102.
* a different configuration.
* @param connectionFactory the JMS ConnectionFactory to create a JmsTemplate for
* @return the new JmsTemplate instance
* @see #setConnectionFactory
* @see org.springframework.jms.core.JmsTemplate102
*/
protected JmsTemplate createJmsTemplate(ConnectionFactory connectionFactory) {
return new JmsTemplate(connectionFactory);

View File

@ -54,7 +54,7 @@ public abstract class AbstractMessageSendingTemplate<D> implements MessageSendin
/**
* Set the {@link MessageConverter} that is to be used to convert
* between Messages and objects for this template.
* <p>The default is {@link SimplePayloadMessageConverter}.
* <p>The default is {@link SimpleMessageConverter}.
*/
public void setMessageConverter(MessageConverter messageConverter) {
Assert.notNull(messageConverter, "'messageConverter' must not be null");

View File

@ -19,6 +19,7 @@ package org.springframework.messaging.handler.annotation.support;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.config.BeanExpressionContext;
import org.springframework.beans.factory.config.BeanExpressionResolver;
import org.springframework.beans.factory.config.ConfigurableBeanFactory;
@ -37,20 +38,20 @@ import org.springframework.util.ClassUtils;
* Abstract base class for resolving method arguments from a named value. Message headers,
* and path variables are examples of named values. Each may have a name, a required flag,
* and a default value.
* <p>
* Subclasses define how to do the following:
*
* <p>Subclasses define how to do the following:
* <ul>
* <li>Obtain named value information for a method parameter
* <li>Resolve names into argument values
* <li>Handle missing argument values when argument values are required
* <li>Optionally handle a resolved value
* </ul>
* <p>
* A default value string can contain ${...} placeholders and Spring Expression Language
* #{...} expressions. For this to work a {@link ConfigurableBeanFactory} must be supplied
* to the class constructor.
* <p>
* A {@link ConversionService} may be used to apply type conversion to the resolved
*
* <p>A default value string can contain ${...} placeholders and Spring Expression
* Language {@code #{...}} expressions. For this to work a {@link ConfigurableBeanFactory}
* must be supplied to the class constructor.
*
* <p>A {@link ConversionService} may be used to apply type conversion to the resolved
* argument value if it doesn't match the method parameter type.
*
* @author Rossen Stoyanchev
@ -70,12 +71,11 @@ public abstract class AbstractNamedValueMethodArgumentResolver implements Handle
/**
* Constructor with a {@link ConversionService} and a {@link BeanFactory}.
*
* @param cs conversion service for converting values to match the
* target method parameter type
* @param beanFactory a bean factory to use for resolving ${...} placeholder and
* #{...} SpEL expressions in default values, or {@code null} if default values
* are not expected to contain expressions
* @param beanFactory a bean factory to use for resolving {@code ${...}} placeholder
* and {@code #{...}} SpEL expressions in default values, or {@code null} if default
* values are not expected to contain expressions
*/
protected AbstractNamedValueMethodArgumentResolver(ConversionService cs, ConfigurableBeanFactory beanFactory) {
this.conversionService = (cs != null) ? cs : new DefaultConversionService();
@ -154,7 +154,6 @@ public abstract class AbstractNamedValueMethodArgumentResolver implements Handle
* @param parameter the method parameter to resolve to an argument value
* @param message the current request
* @param name the name of the value being resolved
*
* @return the resolved argument. May be {@code null}
* @throws Exception in case of errors
*/
@ -180,7 +179,6 @@ public abstract class AbstractNamedValueMethodArgumentResolver implements Handle
* Invoked when a named value is required, but
* {@link #resolveArgumentInternal(MethodParameter, Message, String)} returned {@code null} and
* there is no default value. Subclasses typically throw an exception in this case.
*
* @param name the name for the value
* @param parameter the method parameter
* @param message the message being processed
@ -208,7 +206,6 @@ public abstract class AbstractNamedValueMethodArgumentResolver implements Handle
/**
* Invoked after a value is resolved.
*
* @param arg the resolved argument value
* @param name the argument name
* @param parameter the argument parameter type

View File

@ -29,7 +29,7 @@ import java.util.HashSet;
import java.util.Set;
/**
* A default implementation of {@link @UserDestinationResolver}.
* A default implementation of {@link UserDestinationResolver}.
* <p>
* Resolves messages sent to destination patterns "/user/{user-name}/**" as well as
* subscriptions to destinations "/user/queue/**" where the "/user/" prefix used to

View File

@ -25,7 +25,7 @@ import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.CopyOnWriteArraySet;
/**
* A default thread-safe implementation of {@link @UserSessionRegistry}.
* A default thread-safe implementation of {@link UserSessionRegistry}.
*
* @author Rossen Stoyanchev
* @since 4.0

View File

@ -36,6 +36,7 @@ import java.util.Calendar;
import java.util.Date;
import java.util.Map;
import java.util.UUID;
import javax.activation.DataHandler;
import javax.activation.DataSource;
import javax.xml.XMLConstants;
@ -63,6 +64,7 @@ import javax.xml.transform.Result;
import javax.xml.transform.Source;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.sax.SAXSource;
import javax.xml.transform.stax.StAXSource;
import javax.xml.transform.stream.StreamSource;
import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;
@ -74,7 +76,6 @@ import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import org.xml.sax.XMLReader;
import org.xml.sax.helpers.XMLReaderFactory;
import org.springframework.beans.factory.BeanClassLoaderAware;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.core.JdkVersion;

View File

@ -182,7 +182,7 @@ public class MockServletContext implements ServletContext {
* Create a new MockServletContext using the supplied resource base path and
* resource loader.
* <p>Registers a {@link MockRequestDispatcher} for the Servlet named
* {@value #COMMON_DEFAULT_SERVLET_NAME}.
* {@literal 'default'}.
* @param resourceBasePath the root directory of the WAR (should not end with a slash)
* @param resourceLoader the ResourceLoader to use (or null for the default)
* @see #registerNamedDispatcher
@ -383,7 +383,7 @@ public class MockServletContext implements ServletContext {
/**
* Get the name of the <em>default</em> {@code Servlet}.
* <p>Defaults to {@value #COMMON_DEFAULT_SERVLET_NAME}.
* <p>Defaults to {@literal 'default'}.
* @see #setDefaultServletName
*/
public String getDefaultServletName() {

View File

@ -19,6 +19,7 @@ package org.springframework.test.context.junit4.statements;
import java.util.ArrayList;
import java.util.List;
import org.junit.runners.model.MultipleFailureException;
import org.junit.runners.model.Statement;
import org.springframework.test.context.TestContextManager;

View File

@ -20,6 +20,7 @@ import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;
import org.junit.runners.model.MultipleFailureException;
import org.junit.runners.model.Statement;
import org.springframework.test.context.TestContextManager;

View File

@ -72,7 +72,7 @@ public class DirtiesContextTestExecutionListener extends AbstractTestExecutionLi
* mode} is set to {@link ClassMode#AFTER_EACH_TEST_METHOD
* AFTER_EACH_TEST_METHOD}, the {@linkplain ApplicationContext application
* context} of the test context will be
* {@linkplain TestContext#markApplicationContextDirty() marked as dirty} and the
* {@linkplain TestContext#markApplicationContextDirty marked as dirty} and the
* {@link DependencyInjectionTestExecutionListener#REINJECT_DEPENDENCIES_ATTRIBUTE}
* in the test context will be set to {@code true}.
*/
@ -107,7 +107,7 @@ public class DirtiesContextTestExecutionListener extends AbstractTestExecutionLi
* If the test class of the supplied {@linkplain TestContext test context} is
* annotated with {@link DirtiesContext &#064;DirtiesContext}, the
* {@linkplain ApplicationContext application context} of the test context will
* be {@linkplain TestContext#markApplicationContextDirty() marked as dirty},
* be {@linkplain TestContext#markApplicationContextDirty marked as dirty},
* and the
* {@link DependencyInjectionTestExecutionListener#REINJECT_DEPENDENCIES_ATTRIBUTE
* REINJECT_DEPENDENCIES_ATTRIBUTE} in the test context will be set to

View File

@ -31,7 +31,6 @@ import org.springframework.beans.factory.InitializingBean;
* @author Juergen Hoeller
* @since 1.2.2
* @see org.springframework.jdbc.core.support.JdbcDaoSupport
* @see org.springframework.orm.jdo.support.JdoDaoSupport
*/
public abstract class DaoSupport implements InitializingBean {

View File

@ -70,8 +70,7 @@ import org.springframework.transaction.PlatformTransactionManager;
* <p>The "preInterceptors" and "postInterceptors" properties can be set to add
* additional interceptors to the mix, like
* {@link org.springframework.aop.interceptor.PerformanceMonitorInterceptor} or
* {@link org.springframework.orm.hibernate3.HibernateInterceptor} /
* {@link org.springframework.orm.jdo.JdoInterceptor}.
* {@link org.springframework.orm.hibernate3.HibernateInterceptor}.
*
* <p><b>HINT:</b> This class is often used with parent / child bean definitions.
* Typically, you will define the transaction manager and default transaction

View File

@ -29,21 +29,19 @@ public interface StreamingHttpOutputMessage extends HttpOutputMessage {
/**
* Sets the streaming body for this message.
*
* @param body the streaming body
*/
void setBody(Body body);
/**
* Defines the contract for bodies that can be written directly to a
* {@link OuputStream}. It is useful with HTTP client libraries that provide indirect
* {@link OutputStream}. It is useful with HTTP client libraries that provide indirect
* access to an {@link OutputStream} via a callback mechanism.
*/
public interface Body {
/**
* Writes this body to the given {@link OuputStream}.
*
* Writes this body to the given {@link OutputStream}.
* @param outputStream the output stream to write to
* @throws IOException in case of errors
*/

View File

@ -63,7 +63,7 @@ import org.springframework.util.StringUtils;
* LinkedMultiValueMap&lt;String, Object&gt;(); parts.add("field 1", "value 1"); parts.add("file", new
* ClassPathResource("myFile.jpg")); template.postForLocation("http://example.com/myFileUpload", parts); </pre>
*
* <p>Some methods in this class were inspired by {@link org.apache.commons.httpclient.methods.multipart.MultipartRequestEntity}.
* <p>Some methods in this class were inspired by {@code org.apache.commons.httpclient.methods.multipart.MultipartRequestEntity}.
*
* @author Arjen Poutsma
* @see MultiValueMap

View File

@ -64,7 +64,7 @@ public class HttpComponentsHttpInvokerRequestExecutor extends AbstractHttpInvoke
/**
* Create a new instance of the HttpComponentsHttpInvokerRequestExecutor with a default
* {@link HttpClient} that uses a default {@link org.apache.http.impl.conn.PoolingClientConnectionManager}.
* {@link HttpClient} that uses a default {@code org.apache.http.impl.conn.PoolingClientConnectionManager}.
*/
public HttpComponentsHttpInvokerRequestExecutor() {
org.apache.http.conn.scheme.SchemeRegistry schemeRegistry = new org.apache.http.conn.scheme.SchemeRegistry();

View File

@ -100,10 +100,10 @@ public class HttpInvokerClientInterceptor extends RemoteInvocationBasedAccessor
* Set the HttpInvokerRequestExecutor implementation to use for executing
* remote invocations.
* <p>Default is {@link SimpleHttpInvokerRequestExecutor}. Alternatively,
* consider using {@link CommonsHttpInvokerRequestExecutor} for more
* consider using {@link HttpComponentsHttpInvokerRequestExecutor} for more
* sophisticated needs.
* @see SimpleHttpInvokerRequestExecutor
* @see CommonsHttpInvokerRequestExecutor
* @see HttpComponentsHttpInvokerRequestExecutor
*/
public void setHttpInvokerRequestExecutor(HttpInvokerRequestExecutor httpInvokerRequestExecutor) {
this.httpInvokerRequestExecutor = httpInvokerRequestExecutor;

View File

@ -31,10 +31,6 @@ import org.springframework.web.util.WebUtils;
* which include specifying allowed/required fields, and registering custom
* property editors.
*
* <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}.
*
* <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
@ -59,7 +55,6 @@ import org.springframework.web.util.WebUtils;
* @see #setAllowedFields
* @see #setRequiredFields
* @see #setFieldMarkerPrefix
* @see org.springframework.web.servlet.mvc.BaseCommandController#initBinder
*/
public class ServletRequestDataBinder extends WebDataBinder {
@ -99,7 +94,6 @@ public class ServletRequestDataBinder extends WebDataBinder {
* @param request request with parameters to bind (can be multipart)
* @see org.springframework.web.multipart.MultipartHttpServletRequest
* @see org.springframework.web.multipart.MultipartFile
* @see #bindMultipartFiles
* @see #bind(org.springframework.beans.PropertyValues)
*/
public void bind(ServletRequest request) {

View File

@ -161,7 +161,7 @@ import java.util.concurrent.Callable;
*
* <p>The following return types are supported for handler methods:
* <ul>
* <li>A {@link ModelAndView} 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 @ModelAttribute} annotated reference data accessor methods.
* <li>A {@link org.springframework.ui.Model Model} object, with the view name

View File

@ -63,7 +63,6 @@ import org.springframework.web.context.request.WebRequest;
* @see org.springframework.web.servlet.FrameworkServlet
* @see org.springframework.web.servlet.DispatcherServlet
* @see org.springframework.web.jsf.FacesContextUtils
* @see org.springframework.web.jsf.SpringBeanVariableResolver
* @see org.springframework.web.jsf.el.SpringBeanFacesELResolver
*/
public abstract class WebApplicationContextUtils {

View File

@ -32,10 +32,6 @@ import org.springframework.web.portlet.util.PortletUtils;
* which include specifying allowed/required fields, and registering custom
* property editors.
*
* <p>Used by Spring Portlet MVC's BaseCommandController.
* Note that BaseCommandController and its subclasses allow for easy customization
* 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 Portlet Controller implementation. Simply instantiate
* a PortletRequestDataBinder for each binding process, and invoke {@code bind}
@ -61,7 +57,6 @@ import org.springframework.web.portlet.util.PortletUtils;
* @see #setAllowedFields
* @see #setRequiredFields
* @see #setFieldMarkerPrefix
* @see org.springframework.web.portlet.mvc.BaseCommandController#initBinder
*/
public class PortletRequestDataBinder extends WebDataBinder {
@ -101,7 +96,6 @@ public class PortletRequestDataBinder extends WebDataBinder {
* @param request request with parameters to bind (can be multipart)
* @see org.springframework.web.portlet.multipart.MultipartActionRequest
* @see org.springframework.web.multipart.MultipartFile
* @see #bindMultipartFiles
* @see #bind(org.springframework.beans.PropertyValues)
*/
public void bind(PortletRequest request) {

View File

@ -205,7 +205,7 @@ public class MvcUriComponentsBuilder extends UriComponentsBuilder {
*
* </pre>
*
* The above supports {@codce @PathVariable} and {@code @RequestParam} method parameters.
* The above supports {@code @PathVariable} and {@code @RequestParam} method parameters.
* Any other arguments can be provided as {@literal null} and will be ignored.
* <p>
* Additional (custom) argument types can be supported through an implementation

View File

@ -66,8 +66,7 @@ public class StompSubProtocolHandler implements SubProtocolHandler {
/**
* Provide a registry with which to register active user session ids.
*
* @see {@link org.springframework.messaging.simp.handler.UserDestinationMessageHandler}
* @see org.springframework.messaging.simp.handler.UserDestinationMessageHandler
*/
public void setUserSessionRegistry(UserSessionRegistry registry) {
this.userSessionRegistry = registry;

View File

@ -45,7 +45,7 @@ public class WebSocketConfigurationSupport {
/**
* The default TaskScheduler to use if none is configured via
* {@link SockJsServiceRegistration#setTaskScheduler()}, i.e.
* {@link SockJsServiceRegistration#setTaskScheduler}, i.e.
* <pre class="code">
* &#064;Configuration
* &#064;EnableWebSocket

View File

@ -49,10 +49,6 @@ import org.springframework.web.socket.support.LoggingWebSocketHandlerDecorator;
* {@link HttpServletResponse} to {@link ServerHttpRequest} and {@link ServerHttpResponse}
* respectively.
*
* <p>The {@link #applyDefaultDecorators(WebSocketHandler)} method decorates the given
* WebSocketHandler with a logging and exception handling decorators. This method can
* be overridden to change that.
*
* @author Rossen Stoyanchev
* @since 4.0
*/

View File

@ -23,7 +23,7 @@ import org.springframework.web.socket.sockjs.transport.session.SockJsServiceConf
/**
* @author Rossen Stoyanchev
* @sicne 4.0
* @since 4.0
*/
public abstract class TransportHandlerSupport {