From 4f40a6c3137d1159b378772dc7f27882d7988836 Mon Sep 17 00:00:00 2001 From: Juergen Hoeller Date: Fri, 28 Nov 2008 13:56:30 +0000 Subject: [PATCH] fixed javadoc errors --- .../java/org/springframework/beans/BeanWrapper.java | 3 --- .../config/DestructionAwareBeanPostProcessor.java | 5 ++--- .../expression/StandardBeanExpressionResolver.java | 5 +++-- .../context/weaving/LoadTimeWeaverAwareProcessor.java | 2 +- .../java/org/springframework/util/Log4jConfigurer.java | 1 - .../expression/PropertyWriterExecutor.java | 10 +++++----- .../org/springframework/expression/TypeLocator.java | 8 ++++---- .../multipart/commons/CommonsFileUploadSupport.java | 2 +- .../web/servlet/view/InternalResourceView.java | 2 -- .../web/servlet/view/InternalResourceViewResolver.java | 4 +--- .../web/servlet/view/velocity/VelocityToolboxView.java | 2 -- .../web/servlet/view/velocity/VelocityView.java | 1 - .../servlet/view/velocity/VelocityViewResolver.java | 1 - .../web/servlet/view/xslt/AbstractXsltView.java | 1 - .../web/context/support/RequestHandledEvent.java | 1 - .../context/support/WebApplicationContextUtils.java | 2 -- 16 files changed, 17 insertions(+), 33 deletions(-) diff --git a/org.springframework.beans/src/main/java/org/springframework/beans/BeanWrapper.java b/org.springframework.beans/src/main/java/org/springframework/beans/BeanWrapper.java index 3e18122ba7..2e52ec363e 100644 --- a/org.springframework.beans/src/main/java/org/springframework/beans/BeanWrapper.java +++ b/org.springframework.beans/src/main/java/org/springframework/beans/BeanWrapper.java @@ -31,9 +31,6 @@ import java.beans.PropertyDescriptor; * *

This interface supports nested properties enabling the setting * of properties on subproperties to an unlimited depth. - * A BeanWrapper instance can be used repeatedly, with its - * {@link #setWrappedInstance(Object) target object} (the wrapped JavaBean - * instance) changing as required. * *

A BeanWrapper's default for the "extractOldValueForEditor" setting * is "false", to avoid side effects caused by getter method invocations. diff --git a/org.springframework.beans/src/main/java/org/springframework/beans/factory/config/DestructionAwareBeanPostProcessor.java b/org.springframework.beans/src/main/java/org/springframework/beans/factory/config/DestructionAwareBeanPostProcessor.java index a59eedf817..c7acb6bdff 100644 --- a/org.springframework.beans/src/main/java/org/springframework/beans/factory/config/DestructionAwareBeanPostProcessor.java +++ b/org.springframework.beans/src/main/java/org/springframework/beans/factory/config/DestructionAwareBeanPostProcessor.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2005 the original author or authors. + * Copyright 2002-2008 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -19,14 +19,13 @@ package org.springframework.beans.factory.config; import org.springframework.beans.BeansException; /** - * Subinterface of BeanPostProcessor that adds a before-destruction callback. + * Subinterface of {@link BeanPostProcessor} that adds a before-destruction callback. * *

The typical usage will be to invoke custom destruction callbacks on * specific bean types, matching corresponding initialization callbacks. * * @author Juergen Hoeller * @since 1.0.1 - * @see org.springframework.web.struts.ActionServletAwareProcessor */ public interface DestructionAwareBeanPostProcessor extends BeanPostProcessor { diff --git a/org.springframework.context/src/main/java/org/springframework/context/expression/StandardBeanExpressionResolver.java b/org.springframework.context/src/main/java/org/springframework/context/expression/StandardBeanExpressionResolver.java index 2cb2d53674..9550c9fe3c 100644 --- a/org.springframework.context/src/main/java/org/springframework/context/expression/StandardBeanExpressionResolver.java +++ b/org.springframework.context/src/main/java/org/springframework/context/expression/StandardBeanExpressionResolver.java @@ -25,8 +25,9 @@ import org.springframework.expression.spel.standard.StandardEvaluationContext; import org.springframework.util.Assert; /** - * Standard implementation of the {@link BeanExpressionResolver} interface, - * parsing and evaluating Spring EL using Spring's expression module. + * Standard implementation of the + * {@link org.springframework.beans.factory.config.BeanExpressionResolver} + * interface, parsing and evaluating Spring EL using Spring's expression module. * * @author Juergen Hoeller * @since 3.0 diff --git a/org.springframework.context/src/main/java/org/springframework/context/weaving/LoadTimeWeaverAwareProcessor.java b/org.springframework.context/src/main/java/org/springframework/context/weaving/LoadTimeWeaverAwareProcessor.java index 3ba61e45ee..081339c6cb 100644 --- a/org.springframework.context/src/main/java/org/springframework/context/weaving/LoadTimeWeaverAwareProcessor.java +++ b/org.springframework.context/src/main/java/org/springframework/context/weaving/LoadTimeWeaverAwareProcessor.java @@ -75,7 +75,7 @@ public class LoadTimeWeaverAwareProcessor implements BeanPostProcessor, BeanFact *

The LoadTimeWeaver will be auto-retrieved from * the given {@link BeanFactory}, expecting a bean named * {@link ConfigurableApplicationContext#LOAD_TIME_WEAVER_BEAN_NAME "loadTimeWeaver"}. - * @param loadTimeWeaver the specific LoadTimeWeaver that is to be used + * @param beanFactory the BeanFactory to retrieve the LoadTimeWeaver from */ public LoadTimeWeaverAwareProcessor(BeanFactory beanFactory) { this.beanFactory = beanFactory; diff --git a/org.springframework.core/src/main/java/org/springframework/util/Log4jConfigurer.java b/org.springframework.core/src/main/java/org/springframework/util/Log4jConfigurer.java index 3cf6043ac0..202f6ae159 100644 --- a/org.springframework.core/src/main/java/org/springframework/util/Log4jConfigurer.java +++ b/org.springframework.core/src/main/java/org/springframework/util/Log4jConfigurer.java @@ -42,7 +42,6 @@ import org.apache.log4j.xml.DOMConfigurator; * @since 13.03.2003 * @see org.springframework.web.util.Log4jWebConfigurer * @see org.springframework.web.util.Log4jConfigListener - * @see org.springframework.web.util.Log4jConfigServlet */ public abstract class Log4jConfigurer { diff --git a/org.springframework.expression/src/main/java/org/springframework/expression/PropertyWriterExecutor.java b/org.springframework.expression/src/main/java/org/springframework/expression/PropertyWriterExecutor.java index ad61d8ee4f..164c7e6b4e 100644 --- a/org.springframework.expression/src/main/java/org/springframework/expression/PropertyWriterExecutor.java +++ b/org.springframework.expression/src/main/java/org/springframework/expression/PropertyWriterExecutor.java @@ -13,14 +13,15 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + package org.springframework.expression; /** * If a property accessor is built upon the CacheablePropertyAccessor class then once the property * has been resolved the accessor will return an instance of this PropertyWriterExecutor interface - * that can be cached and repeatedly called to set the value of the property. - *

- * They can become stale, and in that case should throw an AccessException - this will cause the + * that can be cached and repeatedly called to set the value of the property. + * + *

They can become stale, and in that case should throw an AccessException - this will cause the * infrastructure to go back to the resolvers to ask for a new one. * * @author Andy Clement @@ -29,12 +30,11 @@ public interface PropertyWriterExecutor { /** * Set the value of a property to the supplied new value. - * * @param context the evaluation context in which the command is being executed * @param targetObject the target object on which property write is being attempted * @param newValue the new value for the property * @throws AccessException if there is a problem setting the property or this executor has become stale */ - void execute(EvaluationContext evaluationContext, Object targetObject, Object newValue) throws AccessException; + void execute(EvaluationContext context, Object targetObject, Object newValue) throws AccessException; } diff --git a/org.springframework.expression/src/main/java/org/springframework/expression/TypeLocator.java b/org.springframework.expression/src/main/java/org/springframework/expression/TypeLocator.java index b35fa022cf..0306adfdd1 100644 --- a/org.springframework.expression/src/main/java/org/springframework/expression/TypeLocator.java +++ b/org.springframework.expression/src/main/java/org/springframework/expression/TypeLocator.java @@ -13,6 +13,7 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + package org.springframework.expression; import org.springframework.expression.spel.standard.StandardTypeLocator; @@ -21,17 +22,16 @@ import org.springframework.expression.spel.standard.StandardTypeLocator; * Implementors of this interface are expected to be able to locate types. They may use custom classloaders or the * and deal with common package prefixes (java.lang, etc) however they wish. See * {@link StandardTypeLocator} for an example implementation. - * + * * @author Andy Clement */ public interface TypeLocator { /** * Find a type by name. The name may or may not be fully qualified (eg. String or java.lang.String) - * - * @param type the type to be located + * @param typename the type to be located * @return the class object representing that type - * @throw ExpressionException if there is a problem finding it + * @throws EvaluationException if there is a problem finding it */ Class findType(String typename) throws EvaluationException; diff --git a/org.springframework.web.servlet/src/main/java/org/springframework/web/multipart/commons/CommonsFileUploadSupport.java b/org.springframework.web.servlet/src/main/java/org/springframework/web/multipart/commons/CommonsFileUploadSupport.java index 0ee6e64111..6ae7ca8524 100644 --- a/org.springframework.web.servlet/src/main/java/org/springframework/web/multipart/commons/CommonsFileUploadSupport.java +++ b/org.springframework.web.servlet/src/main/java/org/springframework/web/multipart/commons/CommonsFileUploadSupport.java @@ -297,7 +297,7 @@ public abstract class CommonsFileUploadSupport { /** * Create a new MultipartParsingResult. * @param mpFiles Map of field name to MultipartFile instance - * @param multipartParameters Map of field name to form field String value + * @param mpParams Map of field name to form field String value */ public MultipartParsingResult(Map mpFiles, Map mpParams) { this.multipartFiles = mpFiles; diff --git a/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/InternalResourceView.java b/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/InternalResourceView.java index 47f8869920..1b5cd1d576 100644 --- a/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/InternalResourceView.java +++ b/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/InternalResourceView.java @@ -250,7 +250,6 @@ public class InternalResourceView extends AbstractUrlBasedView { * @throws Exception if there's a fatal error while we're adding attributes * @see #renderMergedOutputModel * @see JstlView#exposeHelpers - * @see org.springframework.web.servlet.view.tiles.TilesJstlView#exposeHelpers */ protected void exposeHelpers(HttpServletRequest request) throws Exception { } @@ -266,7 +265,6 @@ public class InternalResourceView extends AbstractUrlBasedView { * @return the request dispatcher path to use * @throws Exception if preparations failed * @see #getUrl() - * @see org.springframework.web.servlet.view.tiles.TilesView#prepareForRendering */ protected String prepareForRendering(HttpServletRequest request, HttpServletResponse response) throws Exception { diff --git a/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/InternalResourceViewResolver.java b/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/InternalResourceViewResolver.java index 15548badbe..656624e8c3 100644 --- a/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/InternalResourceViewResolver.java +++ b/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/InternalResourceViewResolver.java @@ -21,8 +21,7 @@ import org.springframework.util.ClassUtils; /** * Convenient subclass of {@link UrlBasedViewResolver} that supports * {@link InternalResourceView} (i.e. Servlets and JSPs) and subclasses - * such as {@link JstlView} and - * {@link org.springframework.web.servlet.view.tiles.TilesView}. + * such as {@link JstlView}. * *

The view class for all views generated by this resolver can be specified * via {@link #setViewClass}. See {@link UrlBasedViewResolver}'s javadoc for details. @@ -45,7 +44,6 @@ import org.springframework.util.ClassUtils; * @see #setRequestContextAttribute * @see InternalResourceView * @see JstlView - * @see org.springframework.web.servlet.view.tiles.TilesView */ public class InternalResourceViewResolver extends UrlBasedViewResolver { diff --git a/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/velocity/VelocityToolboxView.java b/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/velocity/VelocityToolboxView.java index cb18282dfd..28e7e5407f 100644 --- a/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/velocity/VelocityToolboxView.java +++ b/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/velocity/VelocityToolboxView.java @@ -63,7 +63,6 @@ import org.springframework.util.ReflectionUtils; * @see #initTool * @see org.apache.velocity.tools.view.context.ViewContext * @see org.apache.velocity.tools.view.context.ChainedContext - * @see org.apache.velocity.tools.view.tools.LinkTool */ public class VelocityToolboxView extends VelocityView { @@ -121,7 +120,6 @@ public class VelocityToolboxView extends VelocityView { * Overridden to check for the ViewContext interface which is part of the * view package of Velocity Tools. This requires a special Velocity context, * like ChainedContext as set up by {@link #createVelocityContext} in this class. - * @see org.apache.velocity.tools.view.tools.LinkTool#init(Object) */ @Override protected void initTool(Object tool, Context velocityContext) throws Exception { diff --git a/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/velocity/VelocityView.java b/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/velocity/VelocityView.java index 572605f0d6..9cc650df99 100644 --- a/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/velocity/VelocityView.java +++ b/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/velocity/VelocityView.java @@ -122,7 +122,6 @@ public class VelocityView extends AbstractTemplateView { * @see VelocityToolboxView * @see #createVelocityContext * @see #initTool - * @see #setVelocityFormatterAttribute * @see #setDateToolAttribute * @see #setNumberToolAttribute */ diff --git a/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/velocity/VelocityViewResolver.java b/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/velocity/VelocityViewResolver.java index b143b04fb1..b32b0f7432 100644 --- a/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/velocity/VelocityViewResolver.java +++ b/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/velocity/VelocityViewResolver.java @@ -37,7 +37,6 @@ import org.springframework.web.servlet.view.AbstractUrlBasedView; * @see #setSuffix * @see #setRequestContextAttribute * @see #setExposeSpringMacroHelpers - * @see #setVelocityFormatterAttribute * @see #setDateToolAttribute * @see #setNumberToolAttribute * @see VelocityView diff --git a/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/xslt/AbstractXsltView.java b/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/xslt/AbstractXsltView.java index 90342b2b28..f1937dea7f 100644 --- a/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/xslt/AbstractXsltView.java +++ b/org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/view/xslt/AbstractXsltView.java @@ -411,7 +411,6 @@ public abstract class AbstractXsltView extends AbstractView { * @param model the model Map * @param request current HTTP request * @return a Map of parameters to apply to the transformation process - * @see #getParameters() * @see javax.xml.transform.Transformer#setParameter */ protected Map getParameters(Map model, HttpServletRequest request) { diff --git a/org.springframework.web/src/main/java/org/springframework/web/context/support/RequestHandledEvent.java b/org.springframework.web/src/main/java/org/springframework/web/context/support/RequestHandledEvent.java index ebb3e13851..cf1d045536 100644 --- a/org.springframework.web/src/main/java/org/springframework/web/context/support/RequestHandledEvent.java +++ b/org.springframework.web/src/main/java/org/springframework/web/context/support/RequestHandledEvent.java @@ -30,7 +30,6 @@ import org.springframework.context.ApplicationEvent; * @author Juergen Hoeller * @since January 17, 2001 * @see ServletRequestHandledEvent - * @see PerformanceMonitorListener * @see org.springframework.web.servlet.FrameworkServlet * @see org.springframework.context.ApplicationContext#publishEvent */ diff --git a/org.springframework.web/src/main/java/org/springframework/web/context/support/WebApplicationContextUtils.java b/org.springframework.web/src/main/java/org/springframework/web/context/support/WebApplicationContextUtils.java index 913a5d16c3..e9290e6dae 100644 --- a/org.springframework.web/src/main/java/org/springframework/web/context/support/WebApplicationContextUtils.java +++ b/org.springframework.web/src/main/java/org/springframework/web/context/support/WebApplicationContextUtils.java @@ -48,8 +48,6 @@ import org.springframework.web.context.request.SessionScope; * @see org.springframework.web.context.ContextLoader * @see org.springframework.web.servlet.FrameworkServlet * @see org.springframework.web.servlet.DispatcherServlet - * @see org.springframework.web.struts.ActionSupport - * @see org.springframework.web.struts.DelegatingActionProxy * @see org.springframework.web.jsf.FacesContextUtils * @see org.springframework.web.jsf.DelegatingVariableResolver */