Permalink
Browse files

Eliminate all Javadoc warnings

 - Support external Javadoc links using Gradle's javadoc.options.links

 - Fix all other Javadoc warnings, such as typos, references to
   non-existent (or no longer existent) types and members, etc,
   including changes related to the Quartz 2.0 upgrade (SPR-8275) and
   adding the HTTP PATCH method (SPR-7985).

 - Suppress all output for project-level `javadoc` tasks in order to
   hide false-negative warnings about cross-module @see and @link
   references (e.g. spring-core having a @see reference to spring-web).
   Use the `--info` (-i) flag to gradle at any time to see project-level
   javadoc warnings without running the entire `api` task. e.g.
   `gradle :spring-core:javadoc -i`

 - Favor root project level `api` task for detection of legitimate
   Javadoc warnings. There are now zero Javadoc warnings across the
   entirety of spring-framework. Goal: keep it that way.

 - Remove all @link and @see references to types and members that exist
   only in Servlet <= 2.5 and Hibernate <= 4.0, favoring 3.0+ and 4.0+
   respectively. This is necessary because only one version of each of
   these dependencies can be present on the global `api` javadoc task's
   classpath. To that end, the `api` task classpath has now been
   customized to ensure that the Servlet 3 API and Hibernate Core 4 jars
   have precedence.

 - SPR-8896 replaced our dependency on aspectjrt with a dependency on
   aspectjweaver, which is fine from a POM point of view, but causes
   a spurious warning to be emitted from the ant iajc task that it
   "cannot find aspectjrt on the classpath" - even though aspectjweaver
   is perfectly sufficient. In the name of keeping the console quiet, a
   new `rt` configuration has been added, and aspectjrt added as a
   dependency to it. In turn, configurations.rt.asPath is appended to
   the iajc classpath during both compileJava and compileTestJava for
   spring-aspects.

Issue: SPR-10078, SPR-8275, SPR-7985, SPR-8896
  • Loading branch information...
1 parent 8f90b48 commit f26534700a6646a6a6cf8debcffe8f108a7c9d9e @cbeams cbeams committed Dec 11, 2012
Showing with 217 additions and 221 deletions.
  1. +46 −10 build.gradle
  2. +2 −2 spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/AspectJProxyFactory.java
  3. +2 −2 spring-aop/src/main/java/org/springframework/aop/interceptor/AsyncExecutionAspectSupport.java
  4. +4 −2 spring-aspects/aspects.gradle
  5. +1 −1 ...s/src/main/java/org/springframework/context/annotation/aspectj/SpringConfiguredConfiguration.java
  6. +3 −3 spring-aspects/src/main/java/org/springframework/mock/staticmock/MockStaticEntityMethods.java
  7. +2 −2 ...g-beans/src/main/java/org/springframework/beans/factory/config/PropertyPlaceholderConfigurer.java
  8. +5 −5 spring-context-support/src/main/java/org/springframework/scheduling/quartz/SchedulerAccessor.java
  9. +3 −3 spring-context/src/main/java/org/springframework/cache/annotation/CacheEvict.java
  10. +4 −4 spring-context/src/main/java/org/springframework/format/datetime/joda/DateTimeFormatterFactory.java
  11. +3 −2 spring-context/src/main/java/org/springframework/jmx/support/WebSphereMBeanServerFactoryBean.java
  12. +1 −1 spring-context/src/main/java/org/springframework/scheduling/config/ScheduledTaskRegistrar.java
  13. +1 −1 spring-core/src/main/java/org/springframework/core/CollectionFactory.java
  14. +6 −8 spring-core/src/main/java/org/springframework/core/convert/converter/ConvertingComparator.java
  15. +0 −1 spring-core/src/main/java/org/springframework/core/io/VfsResource.java
  16. +2 −2 spring-core/src/main/java/org/springframework/util/ConcurrentReferenceHashMap.java
  17. +2 −2 spring-core/src/main/java/org/springframework/util/xml/StaxUtils.java
  18. +0 −1 ...expression/src/main/java/org/springframework/expression/common/TemplateAwareExpressionParser.java
  19. +1 −4 spring-jdbc/src/main/java/org/springframework/jdbc/core/SqlRowSetResultSetExtractor.java
  20. +29 −22 spring-jdbc/src/main/java/org/springframework/jdbc/support/lob/OracleLobHandler.java
  21. +1 −3 ...-jdbc/src/main/java/org/springframework/jdbc/support/nativejdbc/WebSphereNativeJdbcExtractor.java
  22. +1 −12 ...rnate4/src/main/java/org/springframework/orm/hibernate4/support/OpenSessionInViewInterceptor.java
  23. +4 −3 spring-orm/src/main/java/org/springframework/orm/hibernate3/FilterDefinitionFactoryBean.java
  24. +1 −2 spring-orm/src/main/java/org/springframework/orm/hibernate3/HibernateAccessor.java
  25. +0 −2 spring-orm/src/main/java/org/springframework/orm/hibernate3/HibernateOperations.java
  26. +1 −1 spring-orm/src/main/java/org/springframework/orm/hibernate3/LocalSessionFactoryBean.java
  27. +0 −2 spring-orm/src/main/java/org/springframework/orm/jdo/JdoOperations.java
  28. +0 −1 spring-test-mvc/src/main/java/org/springframework/test/util/XmlExpectationsHelper.java
  29. +2 −2 ...test-mvc/src/main/java/org/springframework/test/web/client/response/MockRestResponseCreators.java
  30. +1 −1 spring-test-mvc/src/main/java/org/springframework/test/web/servlet/ResultMatcher.java
  31. +2 −2 ...g-test-mvc/src/main/java/org/springframework/test/web/servlet/request/MockMvcRequestBuilders.java
  32. +0 −2 spring-test-mvc/src/main/java/org/springframework/test/web/servlet/result/ContentResultMatchers.java
  33. +1 −1 ...ng-test-mvc/src/main/java/org/springframework/test/web/servlet/result/JsonPathResultMatchers.java
  34. +2 −3 spring-test-mvc/src/main/java/org/springframework/test/web/servlet/setup/DefaultMockMvcBuilder.java
  35. +1 −1 spring-test/src/main/java/org/springframework/mock/env/MockEnvironment.java
  36. +2 −2 spring-test/src/main/java/org/springframework/mock/web/MockServletContext.java
  37. +1 −1 spring-test/src/main/java/org/springframework/test/AssertThrows.java
  38. +1 −1 ...n/java/org/springframework/test/context/junit4/AbstractTransactionalJUnit4SpringContextTests.java
  39. +1 −1 spring-test/src/main/java/org/springframework/test/context/support/AbstractGenericContextLoader.java
  40. +1 −1 ...ng-test/src/main/java/org/springframework/test/context/support/AnnotationConfigContextLoader.java
  41. +1 −1 ...n/java/org/springframework/test/context/testng/AbstractTransactionalTestNGSpringContextTests.java
  42. +6 −6 spring-test/src/main/java/org/springframework/test/context/web/AbstractGenericWebContextLoader.java
  43. +1 −2 spring-test/src/main/java/org/springframework/test/context/web/GenericXmlWebContextLoader.java
  44. +1 −2 spring-tx/src/main/java/org/springframework/jca/work/glassfish/GlassFishWorkManagerTaskExecutor.java
  45. +0 −3 spring-tx/src/main/java/org/springframework/transaction/jta/OC4JJtaTransactionManager.java
  46. +2 −2 spring-web/src/main/java/org/springframework/http/client/support/ProxyFactoryBean.java
  47. +0 −1 spring-web/src/main/java/org/springframework/http/converter/GenericHttpMessageConverter.java
  48. +4 −4 ...ng-web/src/main/java/org/springframework/http/converter/json/Jackson2ObjectMapperFactoryBean.java
  49. +14 −14 spring-web/src/main/java/org/springframework/http/converter/json/JacksonObjectMapperFactoryBean.java
  50. +1 −7 spring-web/src/main/java/org/springframework/remoting/jaxrpc/JaxRpcServicePostProcessor.java
  51. +2 −2 spring-web/src/main/java/org/springframework/web/accept/ContentNegotiationManager.java
  52. +3 −3 spring-web/src/main/java/org/springframework/web/accept/ContentNegotiationManagerFactoryBean.java
  53. +1 −1 spring-web/src/main/java/org/springframework/web/accept/ContentNegotiationStrategy.java
  54. +2 −2 spring-web/src/main/java/org/springframework/web/bind/annotation/RequestMapping.java
  55. +1 −1 spring-web/src/main/java/org/springframework/web/context/request/async/DeferredResult.java
  56. +3 −5 spring-web/src/main/java/org/springframework/web/context/request/async/WebAsyncManager.java
  57. +2 −2 spring-web/src/main/java/org/springframework/web/context/support/StandardServletEnvironment.java
  58. +2 −1 spring-web/src/main/java/org/springframework/web/context/support/WebApplicationContextUtils.java
  59. +5 −4 ...portlet/src/main/java/org/springframework/web/portlet/context/PortletApplicationContextUtils.java
  60. +8 −9 spring-webmvc-portlet/src/main/java/org/springframework/web/portlet/mvc/package-info.java
  61. +0 −1 spring-webmvc-tiles3/src/main/java/org/springframework/web/servlet/view/tiles3/TilesConfigurer.java
  62. +2 −2 ...ng-webmvc-tiles3/src/main/java/org/springframework/web/servlet/view/tiles3/TilesViewResolver.java
  63. +1 −1 spring-webmvc/src/main/java/org/springframework/web/servlet/AsyncHandlerInterceptor.java
  64. +0 −2 spring-webmvc/src/main/java/org/springframework/web/servlet/FrameworkServlet.java
  65. +4 −4 ...src/main/java/org/springframework/web/servlet/config/annotation/ContentNegotiationConfigurer.java
  66. +2 −1 spring-webmvc/src/main/java/org/springframework/web/servlet/handler/MappedInterceptor.java
  67. +1 −1 ...-webmvc/src/main/java/org/springframework/web/servlet/mvc/condition/ProducesRequestCondition.java
  68. +2 −3 spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/package-info.java
  69. +3 −3 spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/package-info.java
  70. +1 −1 ...vc/src/main/java/org/springframework/web/servlet/mvc/support/DefaultHandlerExceptionResolver.java
  71. +2 −3 ...c/src/main/java/org/springframework/web/servlet/support/AbstractDispatcherServletInitializer.java
  72. +0 −5 spring-webmvc/src/main/java/org/springframework/web/servlet/view/ContentNegotiatingViewResolver.java
View
@@ -43,6 +43,28 @@ configure(allprojects) {
testCompile("org.hamcrest:hamcrest-all:1.3")
testCompile("org.easymock:easymock:${easymockVersion}")
}
+
+ ext.javadocLinks = [
+ "http://docs.oracle.com/javase/6/docs/api",
+ "http://docs.oracle.com/javaee/6/api",
+ "http://portals.apache.org/pluto/portlet-2.0-apidocs/",
+ "http://commons.apache.org/lang/api-2.5",
+ "http://commons.apache.org/codec/apidocs",
+ "http://docs.jboss.org/jbossas/javadoc/4.0.5/connector",
+ "http://docs.jboss.org/jbossas/javadoc/7.1.2.Final",
+ "http://aopalliance.sourceforge.net/doc",
+ "http://glassfish.java.net/nonav/docs/v3/api",
+ "http://docs.oracle.com/cd/E13222_01/wls/docs90/javadocs", // commonj
+ "http://quartz-scheduler.org/api/2.1.5",
+ "http://www.eclipse.org/aspectj/doc/released/aspectj5rt-api/",
+ "http://hc.apache.org/httpclient-3.x/apidocs",
+ "http://fasterxml.github.com/jackson-core/javadoc/2.0.0",
+ "http://jackson.codehaus.org/1.4.2/javadoc",
+ "http://pic.dhe.ibm.com/infocenter/wasinfo/v7r0/topic/com.ibm.websphere.javadoc.doc/web/apidocs",
+ "http://ibatis.apache.org/docs/java/dev",
+ "http://tiles.apache.org/framework/apidocs",
+ "http://commons.apache.org/dbcp/api-1.2.2",
+ ] as String[]
}
configure(subprojects) { subproject ->
@@ -64,10 +86,17 @@ configure(subprojects) { subproject ->
}
javadoc {
+ description = "Generates project-level javadoc for use in -javadoc jar"
+
options.memberLevel = org.gradle.external.javadoc.JavadocMemberLevel.PROTECTED
options.author = true
options.header = project.name
- //options.overview = "${projectDir}/src/main/java/overview.html"
+ options.links(project.ext.javadocLinks)
+
+ // suppress warnings due to cross-module @see and @link references;
+ // note that global 'api' task does display all warnings.
+ logging.captureStandardError LogLevel.INFO
+ logging.captureStandardOutput LogLevel.INFO // suppress "## warnings" message
}
task sourcesJar(type: Jar, dependsOn:classes) {
@@ -641,6 +670,7 @@ project("spring-aspects") {
provided("javax.persistence:persistence-api:1.0")
testCompile("javax.mail:mail:1.4")
ajc("org.aspectj:aspectjtools:${aspectjVersion}")
+ rt("org.aspectj:aspectjrt:${aspectjVersion}")
compile("org.aspectj:aspectjweaver:${aspectjVersion}")
testCompile(project(":spring-core")) // for CodeStyleAspect
compile(project(":spring-beans")) // for "p" namespace visibility
@@ -677,8 +707,6 @@ configure(rootProject) {
configurations.archives.artifacts.clear()
dependencies { // for integration tests
- compile gradleApi()
- groovy localGroovy()
testCompile(project(":spring-core"))
testCompile(project(":spring-beans"))
testCompile(project(":spring-aop"))
@@ -703,22 +731,30 @@ configure(rootProject) {
group = "Documentation"
description = "Generates aggregated Javadoc API documentation."
title = "${rootProject.description} ${version} API"
+
options.memberLevel = org.gradle.external.javadoc.JavadocMemberLevel.PROTECTED
options.author = true
options.header = rootProject.description
options.overview = "src/api/overview.html"
options.splitIndex = true
- options.links(
- "http://docs.jboss.org/jbossas/javadoc/4.0.5/connector"
- )
+ options.links(project.ext.javadocLinks)
+
source subprojects.collect { project ->
project.sourceSets.main.allJava
}
- destinationDir = new File(buildDir, "api")
- classpath = files(subprojects.collect { project ->
- project.sourceSets.main.compileClasspath
- })
+
+ classpath = files(
+ // ensure servlet 3.x and Hibernate 4.x have precedence on the Javadoc
+ // classpath over their respective 2.5 and 3.x variants
+ project(":spring-webmvc").sourceSets.main.compileClasspath.files.find { it =~ "servlet-api" },
+ rootProject.sourceSets.test.compileClasspath.files.find { it =~ "hibernate-core" },
+ // ensure the javadoc process can resolve types compiled from .aj sources
+ project(":spring-aspects").sourceSets.main.output
+ )
+ classpath += files(subprojects.collect { it.sourceSets.main.compileClasspath })
+
maxMemory = "1024m"
+ destinationDir = new File(buildDir, "api")
}
task docsZip(type: Zip) {
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2009 the original author or authors.
+ * Copyright 2002-2012 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.
@@ -114,7 +114,7 @@ public void addAspect(Class aspectClass) {
/**
* Add all {@link Advisor Advisors} from the supplied {@link MetadataAwareAspectInstanceFactory}
* to the current chain. Exposes any special purpose {@link Advisor Advisors} if needed.
- * @see #makeAdvisorChainAspectJCapableIfNecessary()
+ * @see AspectJProxyUtils#makeAdvisorChainAspectJCapableIfNecessary(List)
*/
private void addAdvisorsFromAspectInstanceFactory(MetadataAwareAspectInstanceFactory instanceFactory) {
List<Advisor> advisors = this.aspectFactory.getAdvisors(instanceFactory);
@@ -33,7 +33,7 @@
/**
* Base class for asynchronous method execution aspects, such as
* {@link org.springframework.scheduling.annotation.AnnotationAsyncExecutionInterceptor}
- * or {@link org.springframework.scheduling.aspectj.AnnotationAsyncExecutionAspect}.
+ * or {@code org.springframework.scheduling.aspectj.AnnotationAsyncExecutionAspect}.
*
* <p>Provides support for <i>executor qualification</i> on a method-by-method basis.
* {@code AsyncExecutionAspectSupport} objects must be constructed with a default {@code
@@ -87,7 +87,7 @@ public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
/**
* Determine the specific executor to use when executing the given method.
- * @returns the executor to use (never {@code null})
+ * @return the executor to use (never {@code null})
*/
protected AsyncTaskExecutor determineAsyncExecutor(Method method) {
if (!this.executors.containsKey(method)) {
@@ -2,6 +2,7 @@
// compile sources with ajc instead of javac
configurations {
+ rt
ajc
aspects
ajInpath
@@ -26,7 +27,7 @@ task compileJava(overwrite: true) {
aspectPath: configurations.aspects.asPath,
inpath: configurations.ajInpath.asPath,
sourceRootCopyFilter: "**/*.java",
- classpath: sourceSets.main.runtimeClasspath.asPath) {
+ classpath: (sourceSets.main.runtimeClasspath + configurations.rt).asPath) {
sourceroots {
sourceSets.main.java.srcDirs.each {
pathelement(location:it.absolutePath)
@@ -55,7 +56,8 @@ task compileTestJava(overwrite: true) {
destDir: outputDir.absolutePath,
aspectPath: jar.archivePath,
inpath: configurations.ajInpath.asPath,
- classpath: sourceSets.test.runtimeClasspath.asPath + jar.archivePath) {
+ classpath: sourceSets.test.runtimeClasspath.asPath + jar.archivePath +
+ System.getProperty("path.separator") + configurations.rt.asPath) {
sourceroots {
sourceSets.test.java.srcDirs.each {
pathelement(location:it.absolutePath)
@@ -23,7 +23,7 @@
import org.springframework.context.annotation.Role;
/**
- * {@code @Configuration} class that registers an {@link AnnotationBeanConfigurerAspect}
+ * {@code @Configuration} class that registers an {@code AnnotationBeanConfigurerAspect}
* capable of performing dependency injection services for non-Spring managed objects
* annotated with @{@link org.springframework.beans.factory.annotation.Configurable
* Configurable}.
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2010 the original author or authors.
+ * Copyright 2002-2012 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.
@@ -22,10 +22,10 @@
/**
* Annotation to indicate a test class for whose @Test methods
- * static methods on Entity classes should be mocked.
+ * static methods on Entity classes should be mocked. See
+ * {@code AbstractMethodMockingControl}.
*
* @author Rod Johnson
- * @see AbstractMethodMockingControl
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@@ -37,8 +37,8 @@
*
* <p>{@link PropertyPlaceholderConfigurer} is still appropriate for use when:
* <ul>
- * <li>the {@link org.springframework.context spring-context} module is not available (i.e., one is using
- * Spring's {@code BeanFactory} API as opposed to {@code ApplicationContext}).
+ * <li>the {@code spring-context} module is not available (i.e., one is using Spring's
+ * {@code BeanFactory} API as opposed to {@code ApplicationContext}).
* <li>existing configuration makes use of the {@link #setSystemPropertiesMode(int) "systemPropertiesMode"} and/or
* {@link #setSystemPropertiesModeName(String) "systemPropertiesModeName"} properties. Users are encouraged to move
* away from using these settings, and rather configure property source search order through the container's
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2012 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.
@@ -112,21 +112,21 @@ public void setOverwriteExistingJobs(boolean overwriteExistingJobs) {
/**
* Set the location of a Quartz job definition XML file that follows the
- * "job_scheduling_data_1_5" XSD. Can be specified to automatically
+ * "job_scheduling_data_1_5" XSD or better. Can be specified to automatically
* register jobs that are defined in such a file, possibly in addition
* to jobs defined directly on this SchedulerFactoryBean.
- * @see org.quartz.xml.JobSchedulingDataProcessor
+ * @see org.quartz.xml.XmlSchedulingDataProcessor
*/
public void setJobSchedulingDataLocation(String jobSchedulingDataLocation) {
this.jobSchedulingDataLocations = new String[] {jobSchedulingDataLocation};
}
/**
* Set the locations of Quartz job definition XML files that follow the
- * "job_scheduling_data_1_5" XSD. Can be specified to automatically
+ * "job_scheduling_data_1_5" XSD or better. Can be specified to automatically
* register jobs that are defined in such files, possibly in addition
* to jobs defined directly on this SchedulerFactoryBean.
- * @see org.quartz.xml.JobSchedulingDataProcessor
+ * @see org.quartz.xml.XmlSchedulingDataProcessor
*/
public void setJobSchedulingDataLocations(String[] jobSchedulingDataLocations) {
this.jobSchedulingDataLocations = jobSchedulingDataLocations;
@@ -1,5 +1,5 @@
/*
- * Copyright 2002-2011 the original author or authors.
+ * Copyright 2002-2012 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.
@@ -58,8 +58,8 @@
/**
* Whether or not all the entries inside the cache(s) are removed or not. By
* default, only the value under the associated key is removed.
- * <p>Note that specifying setting this parameter to true and specifying a
- * {@link CacheKey key} is not allowed.
+ * <p>Note that setting this parameter to {@code true} and specifying a {@link #key()}
+ * is not allowed.
*/
boolean allEntries() default false;
@@ -27,7 +27,7 @@
/**
* Factory that creates a Joda {@link DateTimeFormatter}. Formatters will be
- * created using the defined {@link #setPattern(String) pattern}, {@link #setIso(ISO) ISO},
+ * created using the defined {@link #setPattern(String) pattern}, {@link #setIso ISO},
* or {@link #setStyle(String) style} (considered in that order).
*
* @author Phillip Webb
@@ -36,7 +36,7 @@
* @see #createDateTimeFormatter()
* @see #createDateTimeFormatter(DateTimeFormatter)
* @see #setPattern(String)
- * @see #setIso(org.springframework.format.annotation.DateTimeFormat.ISO)
+ * @see #setIso
* @see #setStyle(String)
* @see DateTimeFormatterFactoryBean
*/
@@ -68,7 +68,7 @@ public DateTimeFormatterFactory(String pattern) {
/**
* Create a new {@code DateTimeFormatter} using this factory. If no specific
- * {@link #setStyle(String) style}, {@link #setIso(ISO) ISO}, or
+ * {@link #setStyle(String) style}, {@link #setIso ISO}, or
* {@link #setPattern(String) pattern} have been defined the
* {@link DateTimeFormat#mediumDateTime() medium date time format} will be used.
* @return a new date time formatter
@@ -80,7 +80,7 @@ public DateTimeFormatter createDateTimeFormatter() {
/**
* Create a new {@code DateTimeFormatter} using this factory. If no specific
- * {@link #setStyle(String) style}, {@link #setIso(ISO) ISO}, or
+ * {@link #setStyle(String) style}, {@link #setIso ISO}, or
* {@link #setPattern(String) pattern} have been defined the supplied
* {@code fallbackFormatter} will be used.
* @param fallbackFormatter the fall-back formatter to use when no specific factory
@@ -34,11 +34,12 @@
* This FactoryBean is a direct alternative to {@link MBeanServerFactoryBean},
* which uses standard JMX 1.2 API to access the platform's MBeanServer.
*
+ * <p>See Javadoc for WebSphere's <a href="http://bit.ly/UzccDt">{@code
+ * AdminServiceFactory}</a> and <a href="http://bit.ly/TRlX2r">{@code MBeanFactory}</a>.
+ *
* @author Juergen Hoeller
* @author Rob Harrop
* @since 2.0.3
- * @see com.ibm.websphere.management.AdminServiceFactory#getMBeanFactory()
- * @see com.ibm.websphere.management.MBeanFactory#getMBeanServer()
* @see javax.management.MBeanServer
* @see MBeanServerFactoryBean
*/
@@ -276,7 +276,7 @@ public boolean hasTasks() {
/**
* Schedule all registered tasks against the underlying {@linkplain
- * #setTaskScheduler(TaskScheduler) task scheduler.
+ * #setTaskScheduler(TaskScheduler) task scheduler}.
*/
public void afterPropertiesSet() {
long now = System.currentTimeMillis();
@@ -294,7 +294,7 @@ public static Map createApproximateMap(Object map, int initialCapacity) {
/**
* Create the most approximate map for the given map.
* <p>Creates a TreeMap or linked Map for a SortedMap or Map, respectively.
- * @param collectionType the desired type of the target Map
+ * @param mapType the desired type of the target Map
* @param initialCapacity the initial capacity
* @return the new Map instance
* @see java.util.TreeMap
@@ -18,7 +18,6 @@
import java.util.Comparator;
import java.util.Map;
-import java.util.Map.Entry;
import org.springframework.core.convert.ConversionService;
import org.springframework.util.Assert;
@@ -44,7 +43,6 @@
/**
* Create a new {@link ConvertingComparator} instance.
*
- * @param comparator the underlying comparator used to compare the converted values
* @param converter the converter
*/
@SuppressWarnings("unchecked")
@@ -86,8 +84,8 @@ public int compare(S o1, S o2) {
}
/**
- * Create a new {@link ConvertingComparator} that compares {@link Map.Entry map
- * entries} based on their {@link Map.Entry#getKey() keys}.
+ * Create a new {@link ConvertingComparator} that compares {@link java.util.Map.Entry
+ * map * entries} based on their {@link java.util.Map.Entry#getKey() keys}.
*
* @param comparator the underlying comparator used to compare keys
* @return a new {@link ConvertingComparator} instance
@@ -96,15 +94,15 @@ public int compare(S o1, S o2) {
Comparator<K> comparator) {
return new ConvertingComparator<Map.Entry<K,V>, K>(comparator, new Converter<Map.Entry<K, V>, K>() {
- public K convert(Entry<K, V> source) {
+ public K convert(Map.Entry<K, V> source) {
return source.getKey();
}
});
}
/**
- * Create a new {@link ConvertingComparator} that compares {@link Map.Entry map
- * entries} based on their {@link Map.Entry#getValue() values}.
+ * Create a new {@link ConvertingComparator} that compares {@link java.util.Map.Entry
+ * map entries} based on their {@link java.util.Map.Entry#getValue() values}.
*
* @param comparator the underlying comparator used to compare values
* @return a new {@link ConvertingComparator} instance
@@ -113,7 +111,7 @@ public K convert(Entry<K, V> source) {
Comparator<V> comparator) {
return new ConvertingComparator<Map.Entry<K,V>, V>(comparator, new Converter<Map.Entry<K, V>, V>() {
- public V convert(Entry<K, V> source) {
+ public V convert(Map.Entry<K, V> source) {
return source.getValue();
}
});
@@ -33,7 +33,6 @@
* @author Juergen Hoeller
* @author Costin Leau
* @since 3.0
- * @see org.jboss.virtual.VirtualFile
* @see org.jboss.vfs.VirtualFile
*/
public class VfsResource extends AbstractResource {
@@ -404,8 +404,8 @@ protected static int calculateShift(int minimumValue, int maximumValue) {
/**
* Array of references indexed using the low order bits from the hash. This
- * property should only be set via {@link #setReferences(Reference[])} to ensure
- * that the resizeThreshold is maintained.
+ * property should only be set via {@link #setReferences} to ensure that the
+ * {@code resizeThreshold} is maintained.
*/
private volatile Reference<K, V>[] references;
Oops, something went wrong.

0 comments on commit f265347

Please sign in to comment.