language stringclasses 1
value | owner stringlengths 2 15 | repo stringlengths 2 21 | sha stringlengths 45 45 | message stringlengths 7 36.3k | path stringlengths 1 199 | patch stringlengths 15 102k | is_multipart bool 2
classes |
|---|---|---|---|---|---|---|---|
Other | spring-projects | spring-framework | db3bbb5f8cb945b8f29fbd83aff9bbd2dbc70e1c.json | Update javadoc external links
Fix broken external javadoc links for URLs that have been recently
moved. | build.gradle | @@ -74,20 +74,20 @@ configure(allprojects) { project ->
"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://commons.apache.org/proper/commons-lang/javadocs/api-release/",
+ "http://commons.apache.org/proper/commons-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://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://tiles.apache.org/framework/apidocs",
- "http://commons.apache.org/dbcp/api-1.2.2",
+ "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://tiles.apache.org/framework/apidocs/",
+ "http://commons.apache.org/proper/commons-dbcp/apidocs/",
] as String[]
}
| false |
Other | spring-projects | spring-framework | 39d043d773fe05e973fc10cb87c54c5f27112873.json | Update javadoc external links
Fix broken external javadoc links for URLs that have been recently
moved. | build.gradle | @@ -74,22 +74,22 @@ configure(allprojects) { project ->
"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://commons.apache.org/proper/commons-lang/javadocs/api-release/",
+ "http://commons.apache.org/proper/commons-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",
+ "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/proper/commons-dbcp/apidocs/",
] as String[]
}
| false |
Other | spring-projects | spring-framework | 26b1f44ce72705cf355ff7401620371dfa13de7c.json | Update reference doc for async web request config
Issue: SPR-9400 | src/reference/docbook/mvc.xml | @@ -2490,7 +2490,7 @@ deferredResult.setResult(data);
</para>
<section xml:id="mvc-ann-async-exceptions">
- <title>Async Request Processing and Exception Handling</title>
+ <title>Exception Handling for Async Requests</title>
<para>What happens if a <interfacename>Callable</interfacename> returned
from a controller method raises an Exception while being executed?
@@ -2560,38 +2560,78 @@ deferredResult.setResult(data);
</section>
<section xml:id="mvc-ann-async-configuration">
- <title>Async Request Configuration</title>
-
- <para>The MVC Java config and the MVC namespace provide options for
- configuring async request processing.
- <interfacename>WebMvcConfigurer</interfacename> has the method
- <code>configureAsyncSupport</code> while <mvc:annotation-driven>
- has an <async-support> sub-element.</para>
-
- <para>Those allow you to configure the default timeout value to use for
- async requests, which if not set depends on the underlying Servlet
- container (e.g. 10 seconds on Tomcat). You can also configure an
- <interfacename>AsyncTaskExecutor</interfacename> to use for executing
- <interfacename>Callable</interfacename> instances returned from
- controller methods. It is highly recommended to configure this property
- since by default Spring MVC uses
- <classname>SimpleAsyncTaskExecutor</classname>. The MVC Java config
- and the MVC namespace also allow you to register
- <interfacename>CallableProcessingInterceptor</interfacename> and
- <interfacename>DeferredResultProcessingInterceptor</interfacename>
- instances.</para>
+ <title>Configuration for Async Request Processing</title>
- <para>If you need to override the default timeout value for a
- specific <classname>DeferredResult</classname>, you can do so by using
- the appropriate class constructor. Similarly, for a
- <interfacename>Callable</interfacename>, you can wrap it in a
- <classname>WebAsyncTask</classname> and use the appropriate class
- constructor to customize the timeout value. The class constructor of
- <classname>WebAsyncTask</classname> also allows providing
- an <interfacename>AsyncTaskExecutor</interfacename>.</para>
+ <section xml:id="mvc-ann-async-configuration-servlet3">
+ <title>Servlet 3 Async Config</title>
- </section>
+ <para>To use Servlet 3 async request processing, you need to update
+ <filename>web.xml</filename> to version 3.0:</para>
+
+ <programlisting language="xml"><web-app xmlns="http://java.sun.com/xml/ns/javaee"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
+ version="3.0">
+
+ ...
+
+ <web-app>
+ </programlisting>
+
+ <para>The <classname>DispatcherServlet</classname> and any
+ <interfacename>Filter</interfacename> configuration need to have
+ the <code><async-supported>true</async-supported></code> sub-element.
+ Additionally, any <interfacename>Filter</interfacename> that also needs
+ to get involved in async dispatches should also be configured
+ to support the ASYNC dispatcher type. Note that it is safe
+ to enable the ASYNC dispatcher type for all filters provided with
+ the Spring Framework since they will not get involved in async
+ dispatches unless needed.</para>
+
+ <para>If using Servlet 3, Java based configuration, e.g. via
+ <interfacename>WebApplicationInitializer</interfacename>, you'll
+ also need to set the "asyncSupported" flag as well as the
+ ASYNC dispatcher type just like with <filename>web.xml</filename>.
+ To simplify all this configuration, consider
+ extending <classname>AbstractDispatcherServletInitializer</classname>
+ or <classname>AbstractAnnotationConfigDispatcherServletInitializer</classname>,
+ which automatically set those options and make it very easy to register
+ <interfacename>Filter</interfacename> instances.</para>
+ </section>
+
+ <section xml:id="mvc-ann-async-configuration-spring-mvc">
+ <title>Spring MVC Async Config</title>
+
+ <para>The MVC Java config and the MVC namespace both provide options for
+ configuring async request processing.
+ <interfacename>WebMvcConfigurer</interfacename> has the method
+ <code>configureAsyncSupport</code> while <mvc:annotation-driven>
+ has an <async-support> sub-element.</para>
+
+ <para>Those allow you to configure the default timeout value to use for
+ async requests, which if not set depends on the underlying Servlet
+ container (e.g. 10 seconds on Tomcat). You can also configure an
+ <interfacename>AsyncTaskExecutor</interfacename> to use for executing
+ <interfacename>Callable</interfacename> instances returned from
+ controller methods. It is highly recommended to configure this property
+ since by default Spring MVC uses
+ <classname>SimpleAsyncTaskExecutor</classname>. The MVC Java config
+ and the MVC namespace also allow you to register
+ <interfacename>CallableProcessingInterceptor</interfacename> and
+ <interfacename>DeferredResultProcessingInterceptor</interfacename>
+ instances.</para>
+
+ <para>If you need to override the default timeout value for a
+ specific <classname>DeferredResult</classname>, you can do so by using
+ the appropriate class constructor. Similarly, for a
+ <interfacename>Callable</interfacename>, you can wrap it in a
+ <classname>WebAsyncTask</classname> and use the appropriate class
+ constructor to customize the timeout value. The class constructor of
+ <classname>WebAsyncTask</classname> also allows providing
+ an <interfacename>AsyncTaskExecutor</interfacename>.</para>
+ </section>
+ </section>
</section>
<section xml:id="mvc-ann-tests">
@@ -5037,7 +5077,7 @@ public class WebConfig extends WebMvcConfigurerAdapter {
<filename>.rss</filename>, and <filename>.atom</filename> if the
corresponding dependencies such as Jackson, JAXB2, or Rome
are present on the classpath. Additional extensions may be not need
- to be registered explicitly if they can be discovered via
+ to be registered explicitly if they can be discovered via
<classname>ServletContext.getMimeType(String)</classname> or the
<emphasis>Java Activation Framework</emphasis>
(see <classname>javax.activation.MimetypesFileTypeMap</classname>).</para> | false |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | build.gradle | @@ -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) { | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/AspectJProxyFactory.java | @@ -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); | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-aop/src/main/java/org/springframework/aop/interceptor/AsyncExecutionAspectSupport.java | @@ -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)) { | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-aspects/aspects.gradle | @@ -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) | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-aspects/src/main/java/org/springframework/context/annotation/aspectj/SpringConfiguredConfiguration.java | @@ -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}. | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-aspects/src/main/java/org/springframework/mock/staticmock/MockStaticEntityMethods.java | @@ -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) | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-beans/src/main/java/org/springframework/beans/factory/config/PropertyPlaceholderConfigurer.java | @@ -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 | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-context-support/src/main/java/org/springframework/scheduling/quartz/SchedulerAccessor.java | @@ -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; | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-context/src/main/java/org/springframework/cache/annotation/CacheEvict.java | @@ -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;
| true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-context/src/main/java/org/springframework/format/datetime/joda/DateTimeFormatterFactory.java | @@ -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 | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-context/src/main/java/org/springframework/jmx/support/WebSphereMBeanServerFactoryBean.java | @@ -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
*/ | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-context/src/main/java/org/springframework/scheduling/config/ScheduledTaskRegistrar.java | @@ -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(); | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-core/src/main/java/org/springframework/core/CollectionFactory.java | @@ -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 | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-core/src/main/java/org/springframework/core/convert/converter/ConvertingComparator.java | @@ -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 static <K, V> ConvertingComparator<Map.Entry<K, V>, K> mapEntryKeys(
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 static <K, V> ConvertingComparator<Map.Entry<K, V>, V> mapEntryValues(
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();
}
}); | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-core/src/main/java/org/springframework/core/io/VfsResource.java | @@ -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 { | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-core/src/main/java/org/springframework/util/ConcurrentReferenceHashMap.java | @@ -404,8 +404,8 @@ protected final class Segment extends ReentrantLock {
/**
* 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;
| true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-core/src/main/java/org/springframework/util/xml/StaxUtils.java | @@ -36,8 +36,8 @@
/**
* Convenience methods for working with the StAX API.
*
- * <p>In particular, methods for using StAX ({@link javax.xml.stream}) in combination with the TrAX API
- * ({@link javax.xml.transform}), and converting StAX readers/writers into SAX readers/handlers and vice-versa.
+ * <p>In particular, methods for using StAX ({@code javax.xml.stream}) in combination with the TrAX API
+ * ({@code javax.xml.transform}), and converting StAX readers/writers into SAX readers/handlers and vice-versa.
*
* @author Arjen Poutsma
* @author Juergen Hoeller | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-expression/src/main/java/org/springframework/expression/common/TemplateAwareExpressionParser.java | @@ -146,7 +146,6 @@ private Expression createLiteralExpression(ParserContext context, String text) {
* @param expressionString the expression string which may contain the suffix
* @param pos the start position at which to check for the suffix
* @param suffix the suffix string
- * @return
*/
private boolean isSuffixHere(String expressionString,int pos,String suffix) {
int suffixPosition = 0; | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-jdbc/src/main/java/org/springframework/jdbc/core/SqlRowSetResultSetExtractor.java | @@ -22,8 +22,6 @@
import javax.sql.rowset.RowSetFactory;
import javax.sql.rowset.RowSetProvider;
-import com.sun.rowset.CachedRowSetImpl;
-
import org.springframework.core.JdkVersion;
import org.springframework.jdbc.support.rowset.ResultSetWrappingSqlRowSet;
import org.springframework.jdbc.support.rowset.SqlRowSet;
@@ -91,7 +89,6 @@ protected SqlRowSet createSqlRowSet(ResultSet rs) throws SQLException {
* @return a new CachedRowSet instance
* @throws SQLException if thrown by JDBC methods
* @see #createSqlRowSet
- * @see com.sun.rowset.CachedRowSetImpl
*/
protected CachedRowSet newCachedRowSet() throws SQLException {
return cachedRowSetFactory.createCachedRowSet();
@@ -135,7 +132,7 @@ public CachedRowSet createCachedRowSet() throws SQLException {
private static class SunCachedRowSetFactory implements CachedRowSetFactory {
public CachedRowSet createCachedRowSet() throws SQLException {
- return new CachedRowSetImpl();
+ return new com.sun.rowset.CachedRowSetImpl();
}
}
| true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-jdbc/src/main/java/org/springframework/jdbc/support/lob/OracleLobHandler.java | @@ -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.
@@ -58,7 +58,7 @@
* <code>oracle.jdbc.OracleConnection</code>. If you pass in Connections from a
* connection pool (the usual case in a J2EE environment), you need to set an
* appropriate {@link org.springframework.jdbc.support.nativejdbc.NativeJdbcExtractor}
- * to allow for automatical retrieval of the underlying native JDBC Connection.
+ * to allow for automatic retrieval of the underlying native JDBC Connection.
* LobHandler and NativeJdbcExtractor are separate concerns, therefore they
* are represented by separate strategy interfaces.
*
@@ -73,8 +73,6 @@
* @author Thomas Risberg
* @since 04.12.2003
* @see #setNativeJdbcExtractor
- * @see oracle.sql.BLOB
- * @see oracle.sql.CLOB
*/
public class OracleLobHandler extends AbstractLobHandler {
@@ -117,13 +115,14 @@ public class OracleLobHandler extends AbstractLobHandler {
* method, namely <code>getNativeConnectionFromStatement</code> with a
* PreparedStatement argument (falling back to a
* <code>PreparedStatement.getConnection()</code> call if no extractor is set).
- * <p>A common choice is SimpleNativeJdbcExtractor, whose Connection unwrapping
+ * <p>A common choice is {@code SimpleNativeJdbcExtractor}, whose Connection unwrapping
* (which is what OracleLobHandler needs) will work with many connection pools.
- * See SimpleNativeJdbcExtractor's javadoc for details.
+ * See {@code SimpleNativeJdbcExtractor} and
+ * <a href="http://download.oracle.com/otn_hosted_doc/jdeveloper/905/jdbc-javadoc/oracle/jdbc/OracleConnection.html">
+ * oracle.jdbc.OracleConnection</a> javadoc for details.
* @see org.springframework.jdbc.support.nativejdbc.NativeJdbcExtractor#getNativeConnectionFromStatement
* @see org.springframework.jdbc.support.nativejdbc.SimpleNativeJdbcExtractor
* @see org.springframework.jdbc.support.nativejdbc.OracleJdbc4NativeJdbcExtractor
- * @see oracle.jdbc.OracleConnection
*/
public void setNativeJdbcExtractor(NativeJdbcExtractor nativeJdbcExtractor) {
this.nativeJdbcExtractor = nativeJdbcExtractor;
@@ -132,10 +131,12 @@ public void setNativeJdbcExtractor(NativeJdbcExtractor nativeJdbcExtractor) {
/**
* Set whether to cache the temporary LOB in the buffer cache.
* This value will be passed into BLOB/CLOB.createTemporary.
- *
* <p>Default is <code>true</code>.
- * @see oracle.sql.BLOB#createTemporary
- * @see oracle.sql.CLOB#createTemporary
+ * <p><strong>See Also:</strong>
+ * <ul>
+ * <li><a href="http://download.oracle.com/otn_hosted_doc/jdeveloper/905/jdbc-javadoc/oracle/sql/BLOB.html#createTemporary()">oracle.sql.BLOB.createTemporary</a></li>
+ * <li><a href="http://download.oracle.com/otn_hosted_doc/jdeveloper/905/jdbc-javadoc/oracle/sql/CLOB.html#createTemporary()">oracle.sql.CLOB.createTemporary</a></li>
+ * </ul>
*/
public void setCache(boolean cache) {
this.cache = cache;
@@ -149,12 +150,15 @@ public void setCache(boolean cache) {
* temporary LOBs that occupy space in the TEMPORARY tablespace or when you want to free up any
* memory allocated by the driver for the LOB reading.
* <p>Default is <code>false</code>.
- * @see oracle.sql.BLOB#freeTemporary
- * @see oracle.sql.CLOB#freeTemporary
- * @see oracle.sql.BLOB#open
- * @see oracle.sql.CLOB#open
- * @see oracle.sql.BLOB#close
- * @see oracle.sql.CLOB#close
+ * <p><strong>See Also:</strong>
+ * <ul>
+ * <li><a href="http://download.oracle.com/otn_hosted_doc/jdeveloper/905/jdbc-javadoc/oracle/sql/BLOB.html#freeTemporary()">oracle.sql.BLOB.freeTemporary</a></li>
+ * <li><a href="http://download.oracle.com/otn_hosted_doc/jdeveloper/905/jdbc-javadoc/oracle/sql/CLOB.html#freeTemporary()">oracle.sql.CLOB.freeTemporary</a></li>
+ * <li><a href="http://download.oracle.com/otn_hosted_doc/jdeveloper/905/jdbc-javadoc/oracle/sql/BLOB.html#open()">oracle.sql.BLOB.open</a></li>
+ * <li><a href="http://download.oracle.com/otn_hosted_doc/jdeveloper/905/jdbc-javadoc/oracle/sql/CLOB.html#open()">oracle.sql.CLOB.open</a></li>
+ * <li><a href="http://download.oracle.com/otn_hosted_doc/jdeveloper/905/jdbc-javadoc/oracle/sql/BLOB.html#open()">oracle.sql.BLOB.close</a></li>
+ * <li><a href="http://download.oracle.com/otn_hosted_doc/jdeveloper/905/jdbc-javadoc/oracle/sql/CLOB.html#open()">oracle.sql.CLOB.close</a></li>
+ * </ul>
*/
public void setReleaseResourcesAfterRead(boolean releaseResources) {
this.releaseResourcesAfterRead = releaseResources;
@@ -165,14 +169,17 @@ public void setReleaseResourcesAfterRead(boolean releaseResources) {
* Retrieve the <code>oracle.sql.BLOB</code> and <code>oracle.sql.CLOB</code>
* classes via reflection, and initialize the values for the
* DURATION_SESSION, MODE_READWRITE and MODE_READONLY constants defined there.
+ * <p><strong>See Also:</strong>
+ * <ul>
+ * <li><a href="http://download.oracle.com/otn_hosted_doc/jdeveloper/905/jdbc-javadoc/oracle/sql/BLOB.html#DURATION_SESSION">oracle.sql.BLOB.DURATION_SESSION</a></li>
+ * <li><a href="http://download.oracle.com/otn_hosted_doc/jdeveloper/905/jdbc-javadoc/oracle/sql/BLOB.html#MODE_READWRITE">oracle.sql.BLOB.MODE_READWRITE</a></li>
+ * <li><a href="http://download.oracle.com/otn_hosted_doc/jdeveloper/905/jdbc-javadoc/oracle/sql/BLOB.html#MODE_READONLY">oracle.sql.BLOB.MODE_READONLY</a></li>
+ * <li><a href="http://download.oracle.com/otn_hosted_doc/jdeveloper/905/jdbc-javadoc/oracle/sql/CLOB.html#DURATION_SESSION">oracle.sql.CLOB.DURATION_SESSION</a></li>
+ * <li><a href="http://download.oracle.com/otn_hosted_doc/jdeveloper/905/jdbc-javadoc/oracle/sql/CLOB.html#MODE_READWRITE">oracle.sql.CLOB.MODE_READWRITE</a></li>
+ * <li><a href="http://download.oracle.com/otn_hosted_doc/jdeveloper/905/jdbc-javadoc/oracle/sql/CLOB.html#MODE_READONLY">oracle.sql.CLOB.MODE_READONLY</a></li>
+ * </ul>
* @param con the Oracle Connection, for using the exact same class loader
* that the Oracle driver was loaded with
- * @see oracle.sql.BLOB#DURATION_SESSION
- * @see oracle.sql.BLOB#MODE_READWRITE
- * @see oracle.sql.BLOB#MODE_READONLY
- * @see oracle.sql.CLOB#DURATION_SESSION
- * @see oracle.sql.CLOB#MODE_READWRITE
- * @see oracle.sql.CLOB#MODE_READONLY
*/
protected synchronized void initOracleDriverClasses(Connection con) {
if (this.blobClass == null) { | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-jdbc/src/main/java/org/springframework/jdbc/support/nativejdbc/WebSphereNativeJdbcExtractor.java | @@ -1,5 +1,5 @@
/*
- * Copyright 2002-2008 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.
@@ -37,8 +37,6 @@
*
* @author Juergen Hoeller
* @since 1.1
- * @see com.ibm.ws.rsadapter.jdbc.WSJdbcConnection
- * @see com.ibm.ws.rsadapter.jdbc.WSJdbcUtil#getNativeConnection
*/
public class WebSphereNativeJdbcExtractor extends NativeJdbcExtractorAdapter {
| true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-orm-hibernate4/src/main/java/org/springframework/orm/hibernate4/support/OpenSessionInViewInterceptor.java | @@ -50,17 +50,8 @@
* transactions via {@link org.springframework.orm.hibernate4.HibernateTransactionManager}
* as well as for non-transactional execution (if configured appropriately).
*
- * <p><b>NOTE</b>: This interceptor will by default <i>not</i> flush the Hibernate
- * <code>Session</code>, with the flush mode being set to <code>FlushMode.NEVER</code>.
- * It assumes that it will be used in combination with service layer transactions
- * that handle the flushing: the active transaction manager will temporarily change
- * the flush mode to <code>FlushMode.AUTO</code> during a read-write transaction,
- * with the flush mode reset to <code>FlushMode.NEVER</code> at the end of each
- * transaction. If you intend to use this interceptor without transactions, consider
- * changing the default flush mode (through the {@link #setFlushMode "flushMode"} property).
- *
* <p>In contrast to {@link OpenSessionInViewFilter}, this interceptor is configured
- * in a Spring application context and can thus take advantage of bean wiring..
+ * in a Spring application context and can thus take advantage of bean wiring.
*
* <p><b>WARNING:</b> Applying this interceptor to existing logic can cause issues
* that have not appeared before, through the use of a single Hibernate
@@ -71,8 +62,6 @@
*
* @author Juergen Hoeller
* @since 3.1
- * @see #setSingleSession
- * @see #setFlushMode
* @see OpenSessionInViewFilter
* @see org.springframework.orm.hibernate4.HibernateTransactionManager
* @see org.springframework.transaction.support.TransactionSynchronizationManager | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-orm/src/main/java/org/springframework/orm/hibernate3/FilterDefinitionFactoryBean.java | @@ -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.
@@ -73,7 +73,7 @@ public class FilterDefinitionFactoryBean implements FactoryBean<FilterDefinition
static {
// Hibernate 3.6 TypeResolver class available?
try {
- Class trClass = FilterDefinitionFactoryBean.class.getClassLoader().loadClass(
+ Class<?> trClass = FilterDefinitionFactoryBean.class.getClassLoader().loadClass(
"org.hibernate.type.TypeResolver");
heuristicTypeMethod = trClass.getMethod("heuristicType", String.class);
typeResolver = trClass.newInstance();
@@ -109,7 +109,8 @@ public void setFilterName(String filterName) {
/**
* Set the parameter types for the filter,
* with parameter names as keys and type names as values.
- * @see org.hibernate.type.TypeFactory#heuristicType(String)
+ * See {@code org.hibernate.type.TypeFactory#heuristicType(String)} (Hibernate 3.x)
+ * or {@code org.hibernate.type.TypeResolver#heuristicType(String)} (Hibernate 4.x)
*/
public void setParameterTypes(Map<String, String> parameterTypes) {
if (parameterTypes != null) { | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-orm/src/main/java/org/springframework/orm/hibernate3/HibernateAccessor.java | @@ -1,5 +1,5 @@
/*
- * Copyright 2002-2008 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.
@@ -432,7 +432,6 @@ protected DataAccessException convertJdbcAccessException(JDBCException ex, SQLEx
* @param ex the SQLException
* @return the corresponding DataAccessException instance
* @see #setJdbcExceptionTranslator
- * @see org.hibernate.Session#connection()
*/
protected DataAccessException convertJdbcAccessException(SQLException ex) {
SQLExceptionTranslator translator = getJdbcExceptionTranslator(); | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-orm/src/main/java/org/springframework/orm/hibernate3/HibernateOperations.java | @@ -81,8 +81,6 @@ public interface HibernateOperations {
* @return a result object returned by the action, or <code>null</code>
* @throws org.springframework.dao.DataAccessException in case of Hibernate errors
* @see HibernateTransactionManager
- * @see org.springframework.dao
- * @see org.springframework.transaction
* @see org.hibernate.Session
*/
<T> T execute(HibernateCallback<T> action) throws DataAccessException; | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-orm/src/main/java/org/springframework/orm/hibernate3/LocalSessionFactoryBean.java | @@ -520,9 +520,9 @@ public void setCollectionCacheStrategies(Properties collectionCacheStrategies) {
* you can also pass in a list or set of listeners objects as value.
* <p>See the Hibernate documentation for further details on listener types
* and associated listener interfaces.
+ * <p>See {@code org.hibernate.cfg.Configuration#setListener(String, Object)}
* @param eventListeners Map with listener type Strings as keys and
* listener objects as values
- * @see org.hibernate.cfg.Configuration#setListener(String, Object)
*/
public void setEventListeners(Map<String, Object> eventListeners) {
this.eventListeners = eventListeners; | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-orm/src/main/java/org/springframework/orm/jdo/JdoOperations.java | @@ -67,8 +67,6 @@ public interface JdoOperations {
* @return a result object returned by the action, or <code>null</code>
* @throws org.springframework.dao.DataAccessException in case of JDO errors
* @see JdoTransactionManager
- * @see org.springframework.dao
- * @see org.springframework.transaction
* @see javax.jdo.PersistenceManager
*/
<T> T execute(JdoCallback<T> action) throws DataAccessException; | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-test-mvc/src/main/java/org/springframework/test/util/XmlExpectationsHelper.java | @@ -45,7 +45,6 @@ public class XmlExpectationsHelper {
/**
* Parse the content as {@link Node} and apply a {@link Matcher}.
- * @see org.hamcrest.Matchers#hasXPath
*/
public void assertNode(String content, Matcher<? super Node> matcher) throws Exception {
Document document = parseXmlString(content); | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-test-mvc/src/main/java/org/springframework/test/web/client/response/MockRestResponseCreators.java | @@ -56,7 +56,7 @@ public static DefaultResponseCreator withSuccess(String body, MediaType mediaTyp
/**
* {@code ResponseCreator} for a 200 response (OK) with byte[] body.
* @param body the response body
- * @param mediaType the type of the content, may be {@code null}
+ * @param contentType the type of the content, may be {@code null}
*/
public static DefaultResponseCreator withSuccess(byte[] body, MediaType contentType) {
return new DefaultResponseCreator(HttpStatus.OK).body(body).contentType(contentType);
@@ -65,7 +65,7 @@ public static DefaultResponseCreator withSuccess(byte[] body, MediaType contentT
/**
* {@code ResponseCreator} for a 200 response (OK) content with {@link Resource}-based body.
* @param body the response body
- * @param mediaType the type of the content, may be {@code null}
+ * @param contentType the type of the content, may be {@code null}
*/
public static DefaultResponseCreator withSuccess(Resource body, MediaType contentType) {
return new DefaultResponseCreator(HttpStatus.OK).body(body).contentType(contentType); | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-test-mvc/src/main/java/org/springframework/test/web/servlet/ResultMatcher.java | @@ -40,7 +40,7 @@ public interface ResultMatcher {
/**
* Assert the result of an executed request.
*
- * @param mvcResult the result of the executed request
+ * @param result the result of the executed request
* @throws Exception if a failure occurs
*/
void match(MvcResult result) throws Exception; | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-test-mvc/src/main/java/org/springframework/test/web/servlet/request/MockMvcRequestBuilders.java | @@ -87,8 +87,8 @@ public static MockHttpServletRequestBuilder delete(String urlTemplate, Object...
* @param urlTemplate a URL template; the resulting URL will be encoded
* @param urlVariables zero or more URL variables
*/
- public static MockHttpServletRequestBuilder request(HttpMethod httpMethod, String urlTemplate, Object... urlVars) {
- return new MockHttpServletRequestBuilder(httpMethod, urlTemplate, urlVars);
+ public static MockHttpServletRequestBuilder request(HttpMethod httpMethod, String urlTemplate, Object... urlVariables) {
+ return new MockHttpServletRequestBuilder(httpMethod, urlTemplate, urlVariables);
}
/** | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-test-mvc/src/main/java/org/springframework/test/web/servlet/result/ContentResultMatchers.java | @@ -147,8 +147,6 @@ public void match(MvcResult result) throws Exception {
/**
* Parse the response content as {@link Node} and apply the given Hamcrest
* {@link Matcher}.
- *
- * @see org.hamcrest.Matchers#hasXPath
*/
public ResultMatcher node(final Matcher<? super Node> matcher) {
return new ResultMatcher() { | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-test-mvc/src/main/java/org/springframework/test/web/servlet/result/JsonPathResultMatchers.java | @@ -25,7 +25,7 @@
* Factory for assertions on the response content using <a
* href="http://goessner.net/articles/JsonPath/">JSONPath</a> expressions.
* An instance of this class is typically accessed via
- * {@link MockMvcResultMatchers#jsonPpath}.
+ * {@link MockMvcResultMatchers#jsonPath}.
*
* @author Rossen Stoyanchev
* @since 3.2 | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-test-mvc/src/main/java/org/springframework/test/web/servlet/setup/DefaultMockMvcBuilder.java | @@ -56,8 +56,8 @@
/**
- * Protected constructor. Not intended for direct instantiation.
- * @see MockMvcBuilders#webAppContextSetup(WebApplicationContext)
+ * Protected constructor. Not intended for direct instantiation.
+ * @see MockMvcBuilders#webAppContextSetup(WebApplicationContext)
*/
protected DefaultMockMvcBuilder(WebApplicationContext webAppContext) {
Assert.notNull(webAppContext, "WebApplicationContext is required");
@@ -116,7 +116,6 @@ public final <T extends Self> T addFilters(Filter... filters) {
*
* @param filter the filter to add
* @param urlPatterns URL patterns to map to; if empty, "/*" is used by default
- * @return
*/
@SuppressWarnings("unchecked")
public final <T extends Self> T addFilter(Filter filter, String... urlPatterns) { | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-test/src/main/java/org/springframework/mock/env/MockEnvironment.java | @@ -51,7 +51,7 @@ public void setProperty(String key, String value) {
* Convenient synonym for {@link #setProperty} that returns the current instance.
* Useful for method chaining and fluent-style use.
* @return this {@link MockEnvironment} instance
- * @see MockPropertySource#withProperty(String, String)
+ * @see MockPropertySource#withProperty
*/
public MockEnvironment withProperty(String key, String value) {
this.setProperty(key, value); | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-test/src/main/java/org/springframework/mock/web/MockServletContext.java | @@ -159,7 +159,7 @@ public MockServletContext(ResourceLoader resourceLoader) {
* 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}.
+ * {@linkplain #COMMON_DEFAULT_SERVLET_NAME "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
@@ -342,7 +342,7 @@ public void unregisterNamedDispatcher(String name) {
/**
* Get the name of the <em>default</em> {@code Servlet}.
- * <p>Defaults to {@value #COMMON_DEFAULT_SERVLET_NAME}.
+ * <p>Defaults to {@linkplain #COMMON_DEFAULT_SERVLET_NAME "default"}.
* @see #setDefaultServletName
*/
public String getDefaultServletName() { | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-test/src/main/java/org/springframework/test/AssertThrows.java | @@ -76,7 +76,7 @@
*
* Intended for use with JUnit 4 and TestNG (as of Spring 3.0).
* You might want to compare this class with the
- * {@link junit.extensions.ExceptionTestCase} class.
+ * {@code junit.extensions.ExceptionTestCase} class.
*
* @author Rick Evans
* @author Juergen Hoeller | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-test/src/main/java/org/springframework/test/context/junit4/AbstractTransactionalJUnit4SpringContextTests.java | @@ -124,7 +124,7 @@ protected int countRowsInTable(String tableName) {
/**
* Count the rows in the given table, using the provided {@code WHERE} clause.
- * <p>See the Javadoc for {@link JdbcTestUtils#countRowsInTableWhere()} for details.
+ * <p>See the Javadoc for {@link JdbcTestUtils#countRowsInTableWhere} for details.
* @param tableName the name of the table to count rows in
* @param whereClause the {@code WHERE} clause to append to the query
* @return the number of rows in the table that match the provided | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-test/src/main/java/org/springframework/test/context/support/AbstractGenericContextLoader.java | @@ -133,7 +133,7 @@ public final ConfigurableApplicationContext loadContext(MergedContextConfigurati
*
* <p><b>Note</b>: this method does not provide a means to set active bean definition
* profiles for the loaded context. See {@link #loadContext(MergedContextConfiguration)}
- * and {@link #prepareContext(GenericApplicationContext, MergedContextConfiguration)}
+ * and {@link AbstractContextLoader#prepareContext(ConfigurableApplicationContext, MergedContextConfiguration)}
* for an alternative.
*
* @return a new application context | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-test/src/main/java/org/springframework/test/context/support/AnnotationConfigContextLoader.java | @@ -155,7 +155,7 @@ protected String getResourceSuffix() {
* {@link AnnotatedBeanDefinitionReader} is used to register the appropriate
* bean definitions.
*
- * <p>Note that this method does not call {@link #createBeanDefinitionReader()}
+ * <p>Note that this method does not call {@link #createBeanDefinitionReader}
* since <code>AnnotatedBeanDefinitionReader</code> is not an instance of
* {@link BeanDefinitionReader}.
* | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-test/src/main/java/org/springframework/test/context/testng/AbstractTransactionalTestNGSpringContextTests.java | @@ -115,7 +115,7 @@ protected int countRowsInTable(String tableName) {
/**
* Count the rows in the given table, using the provided {@code WHERE} clause.
- * <p>See the Javadoc for {@link JdbcTestUtils#countRowsInTableWhere()} for details.
+ * <p>See the Javadoc for {@link JdbcTestUtils#countRowsInTableWhere} for details.
* @param tableName the name of the table to count rows in
* @param whereClause the {@code WHERE} clause to append to the query
* @return the number of rows in the table that match the provided | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-test/src/main/java/org/springframework/test/context/web/AbstractGenericWebContextLoader.java | @@ -49,7 +49,7 @@
* {@link org.springframework.test.context.ContextLoader ContextLoader} SPI.
*
* <p>Concrete subclasses must provide an appropriate implementation of
- * {@link #loadBeanDefinitions()}.
+ * {@link #loadBeanDefinitions}.
*
* @author Sam Brannen
* @since 3.2
@@ -71,18 +71,18 @@ public abstract class AbstractGenericWebContextLoader extends AbstractContextLoa
*
* <ul>
* <li>Creates a {@link GenericWebApplicationContext} instance.</li>
- * <li>Delegates to {@link #configureWebResources()} to create the
+ * <li>Delegates to {@link #configureWebResources} to create the
* {@link MockServletContext} and set it in the {@code WebApplicationContext}.</li>
- * <li>Calls {@link #prepareContext()} to allow for customizing the context
+ * <li>Calls {@link #prepareContext} to allow for customizing the context
* before bean definitions are loaded.</li>
- * <li>Calls {@link #customizeBeanFactory()} to allow for customizing the
+ * <li>Calls {@link #customizeBeanFactory} to allow for customizing the
* context's {@code DefaultListableBeanFactory}.</li>
- * <li>Delegates to {@link #loadBeanDefinitions()} to populate the context
+ * <li>Delegates to {@link #loadBeanDefinitions} to populate the context
* from the locations or classes in the supplied {@code MergedContextConfiguration}.</li>
* <li>Delegates to {@link AnnotationConfigUtils} for
* {@linkplain AnnotationConfigUtils#registerAnnotationConfigProcessors registering}
* annotation configuration processors.</li>
- * <li>Calls {@link #customizeContext()} to allow for customizing the context
+ * <li>Calls {@link #customizeContext} to allow for customizing the context
* before it is refreshed.</li>
* <li>{@link ConfigurableApplicationContext#refresh Refreshes} the
* context and registers a JVM shutdown hook for it.</li> | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-test/src/main/java/org/springframework/test/context/web/GenericXmlWebContextLoader.java | @@ -30,8 +30,7 @@ public class GenericXmlWebContextLoader extends AbstractGenericWebContextLoader
/**
* Loads bean definitions using an {@link XmlBeanDefinitionReader}.
- *
- * @see AbstractGenericWebContextLoader#loadBeanDefinitions()
+ * @see AbstractGenericWebContextLoader#loadBeanDefinitions
*/
@Override
protected void loadBeanDefinitions(GenericWebApplicationContext context, | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-tx/src/main/java/org/springframework/jca/work/glassfish/GlassFishWorkManagerTaskExecutor.java | @@ -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.
@@ -33,7 +33,6 @@
*
* @author Juergen Hoeller
* @since 2.5.2
- * @see com.sun.enterprise.connectors.work.WorkManagerFactory
*/
public class GlassFishWorkManagerTaskExecutor extends WorkManagerTaskExecutor {
| true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-tx/src/main/java/org/springframework/transaction/jta/OC4JJtaTransactionManager.java | @@ -61,9 +61,6 @@
* @since 2.0.3
* @see org.springframework.transaction.TransactionDefinition#getName
* @see org.springframework.transaction.TransactionDefinition#getIsolationLevel
- * @see oracle.j2ee.transaction.OC4JTransactionManager#begin(String)
- * @see oracle.j2ee.transaction.OC4JTransaction#setTransactionIsolation
- * @see oracle.j2ee.transaction.TransactionUtility
* @deprecated as of Spring 3.2, in favor of {@link WebLogicJtaTransactionManager}
* since Oracle end-of-lifed OC4J in favor of WebLogic
*/ | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-web/src/main/java/org/springframework/http/client/support/ProxyFactoryBean.java | @@ -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.
@@ -43,7 +43,7 @@ public class ProxyFactoryBean implements FactoryBean<Proxy>, InitializingBean {
private Proxy proxy;
/**
- * Sets the proxy type. Defaults to {@link Proxy.Type#HTTP}.
+ * Sets the proxy type. Defaults to {@link java.net.Proxy.Type#HTTP}.
*/
public void setType(Proxy.Type type) {
this.type = type; | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-web/src/main/java/org/springframework/http/converter/GenericHttpMessageConverter.java | @@ -50,7 +50,6 @@
* @param type the type of object to return. This type must have previously
* been passed to the {@link #canRead canRead} method of this interface,
* which must have returned {@code true}.
- * @param type the type of the target object
* @param contextClass a context class for the target type, for example a class
* in which the target type appears in a method signature, can be {@code null}
* @param inputMessage the HTTP input message to read from | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-web/src/main/java/org/springframework/http/converter/json/Jackson2ObjectMapperFactoryBean.java | @@ -221,8 +221,8 @@ public void setIndentOutput(boolean indentOutput) {
* @see MapperFeature
* @see SerializationFeature
* @see DeserializationFeature
- * @see JsonParser.Feature
- * @see JsonGenerator.Feature
+ * @see org.codehaus.jackson.map.JsonParser.Feature
+ * @see org.codehaus.jackson.map.JsonGenerator.Feature
*/
public void setFeaturesToEnable(Object... featuresToEnable) {
if (featuresToEnable != null) {
@@ -238,8 +238,8 @@ public void setFeaturesToEnable(Object... featuresToEnable) {
* @see MapperFeature
* @see SerializationFeature
* @see DeserializationFeature
- * @see JsonParser.Feature
- * @see JsonGenerator.Feature
+ * @see org.codehaus.jackson.map.JsonParser.Feature
+ * @see org.codehaus.jackson.map.JsonGenerator.Feature
*/
public void setFeaturesToDisable(Object... featuresToDisable) {
if (featuresToDisable != null) { | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-web/src/main/java/org/springframework/http/converter/json/JacksonObjectMapperFactoryBean.java | @@ -128,32 +128,32 @@ public void setAnnotationIntrospector(AnnotationIntrospector annotationIntrospec
}
/**
- * Shortcut for {@link SerializationConfig.Feature#AUTO_DETECT_FIELDS} and
- * {@link DeserializationConfig.Feature#AUTO_DETECT_FIELDS}.
+ * Shortcut for {@link org.codehaus.jackson.map.SerializationConfig.Feature#AUTO_DETECT_FIELDS} and
+ * {@link org.codehaus.jackson.map.DeserializationConfig.Feature#AUTO_DETECT_FIELDS}.
*/
public void setAutoDetectFields(boolean autoDetectFields) {
this.features.put(DeserializationConfig.Feature.AUTO_DETECT_FIELDS, autoDetectFields);
this.features.put(SerializationConfig.Feature.AUTO_DETECT_FIELDS, autoDetectFields);
}
/**
- * Shortcut for {@link SerializationConfig.Feature#AUTO_DETECT_GETTERS} and
- * {@link DeserializationConfig.Feature#AUTO_DETECT_SETTERS}.
+ * Shortcut for {@link org.codehaus.jackson.map.SerializationConfig.Feature#AUTO_DETECT_GETTERS} and
+ * {@link org.codehaus.jackson.map.DeserializationConfig.Feature#AUTO_DETECT_SETTERS}.
*/
public void setAutoDetectGettersSetters(boolean autoDetectGettersSetters) {
this.features.put(SerializationConfig.Feature.AUTO_DETECT_GETTERS, autoDetectGettersSetters);
this.features.put(DeserializationConfig.Feature.AUTO_DETECT_SETTERS, autoDetectGettersSetters);
}
/**
- * Shortcut for {@link SerializationConfig.Feature#FAIL_ON_EMPTY_BEANS}.
+ * Shortcut for {@link org.codehaus.jackson.map.SerializationConfig.Feature#FAIL_ON_EMPTY_BEANS}.
*/
public void setFailOnEmptyBeans(boolean failOnEmptyBeans) {
this.features.put(SerializationConfig.Feature.FAIL_ON_EMPTY_BEANS, failOnEmptyBeans);
}
/**
- * Shortcut for {@link SerializationConfig.Feature#INDENT_OUTPUT}.
+ * Shortcut for {@link org.codehaus.jackson.map.SerializationConfig.Feature#INDENT_OUTPUT}.
*/
public void setIndentOutput(boolean indentOutput) {
this.features.put(SerializationConfig.Feature.INDENT_OUTPUT, indentOutput);
@@ -162,10 +162,10 @@ public void setIndentOutput(boolean indentOutput) {
/**
* Specify features to enable.
*
- * @see SerializationConfig.Feature
- * @see DeserializationConfig.Feature
- * @see JsonParser.Feature
- * @see JsonGenerator.Feature
+ * @see org.codehaus.jackson.map.SerializationConfig.Feature
+ * @see org.codehaus.jackson.map.DeserializationConfig.Feature
+ * @see org.codehaus.jackson.map.JsonParser.Feature
+ * @see org.codehaus.jackson.map.JsonGenerator.Feature
*/
public void setFeaturesToEnable(Object[] featuresToEnable) {
if (featuresToEnable != null) {
@@ -178,10 +178,10 @@ public void setFeaturesToEnable(Object[] featuresToEnable) {
/**
* Specify features to disable.
*
- * @see SerializationConfig.Feature
- * @see DeserializationConfig.Feature
- * @see JsonParser.Feature
- * @see JsonGenerator.Feature
+ * @see org.codehaus.jackson.map.SerializationConfig.Feature
+ * @see org.codehaus.jackson.map.DeserializationConfig.Feature
+ * @see org.codehaus.jackson.map.JsonParser.Feature
+ * @see org.codehaus.jackson.map.JsonGenerator.Feature
*/
public void setFeaturesToDisable(Object[] featuresToDisable) {
if (featuresToDisable != null) { | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-web/src/main/java/org/springframework/remoting/jaxrpc/JaxRpcServicePostProcessor.java | @@ -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.
@@ -25,12 +25,6 @@
* or one of its subclasses: {@link LocalJaxRpcServiceFactoryBean},
* {@link JaxRpcPortClientInterceptor}, or {@link JaxRpcPortProxyFactoryBean}.
*
- * <p>Useful, for example, to register custom type mappings. See the
- * {@link org.springframework.remoting.jaxrpc.support.AxisBeanMappingServicePostProcessor}
- * class that registers Axis-specific bean mappings for specified bean classes.
- * This is defined for the domain objects in the JPetStore same application,
- * for example.
- *
* @author Juergen Hoeller
* @since 1.1.4
* @see LocalJaxRpcServiceFactory#setServicePostProcessors | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-web/src/main/java/org/springframework/web/accept/ContentNegotiationManager.java | @@ -84,7 +84,7 @@ public ContentNegotiationManager() {
* implement {@link MediaTypeFileExtensionResolver} and the class constructor
* accepting the former will also detect implementations of the latter. Therefore
* you only need to use this method to register additional instances.
- * @param one more resolvers
+ * @param resolvers one or more resolvers
*/
public void addFileExtensionResolvers(MediaTypeFileExtensionResolver... resolvers) {
this.fileExtensionResolvers.addAll(Arrays.asList(resolvers));
@@ -93,7 +93,7 @@ public void addFileExtensionResolvers(MediaTypeFileExtensionResolver... resolver
/**
* Delegate to all configured ContentNegotiationStrategy instances until one
* returns a non-empty list.
- * @param request the current request
+ * @param webRequest the current request
* @return the requested media types or an empty list, never {@code null}
* @throws HttpMediaTypeNotAcceptableException if the requested media types cannot be parsed
*/ | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-web/src/main/java/org/springframework/web/accept/ContentNegotiationManagerFactoryBean.java | @@ -37,7 +37,7 @@
* <p>By default strategies for checking the extension of the request path and
* the {@code Accept} header are registered. The path extension check will perform
* lookups through the {@link ServletContext} and the Java Activation Framework
- * (if present) unless {@linkplain #setMediaTypes(Map) media types} are configured.
+ * (if present) unless {@linkplain #setMediaTypes(Properties) media types} are configured.
*
* @author Rossen Stoyanchev
* @since 3.2
@@ -99,7 +99,7 @@ public Properties getMediaTypes() {
* {@link #setFavorPathExtension(boolean)} is set to {@code true}.
* <p>The default value is {@code true}.
* @see #parameterName
- * @see #setMediaTypes(Map)
+ * @see #setMediaTypes(Properties)
*/
public void setUseJaf(boolean useJaf) {
this.useJaf = useJaf;
@@ -113,7 +113,7 @@ public void setUseJaf(boolean useJaf) {
* for {@code /hotels?format=pdf} will be interpreted as a request for
* {@code "application/pdf"} regardless of the {@code Accept} header.
* <p>To use this option effectively you must also configure the MediaType
- * type mappings via {@link #setMediaTypes(Map)}.
+ * type mappings via {@link #setMediaTypes(Properties)}.
* @see #setParameterName(String)
*/
public void setFavorParameter(boolean favorParameter) { | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-web/src/main/java/org/springframework/web/accept/ContentNegotiationStrategy.java | @@ -34,7 +34,7 @@ public interface ContentNegotiationStrategy {
* Resolve the given request to a list of media types. The returned list is
* ordered by specificity first and by quality parameter second.
*
- * @param request the current request
+ * @param webRequest the current request
* @return the requested media types or an empty list, never {@code null}
*
* @throws HttpMediaTypeNotAcceptableException if the requested media types cannot be parsed | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-web/src/main/java/org/springframework/web/bind/annotation/RequestMapping.java | @@ -109,7 +109,7 @@
* converters}. Such parameters may optionally be annotated with {@code @Valid}
* and also support access to validation results through an
* {@link org.springframework.validation.Errors} argument.
- * Instead a {@link org.springframework.web.servlet.mvc.method.annotation.MethodArgumentNotValidException}
+ * Instead a {@link org.springframework.web.bind.MethodArgumentNotValidException}
* exception is raised.
* <li>{@link RequestPart @RequestPart} annotated parameters
* (Servlet-only, {@literal @MVC 3.1-only})
@@ -120,7 +120,7 @@
* converters}. Such parameters may optionally be annotated with {@code @Valid}
* and support access to validation results through a
* {@link org.springframework.validation.Errors} argument.
- * Instead a {@link org.springframework.web.servlet.mvc.method.annotation.MethodArgumentNotValidException}
+ * Instead a {@link org.springframework.web.bind.MethodArgumentNotValidException}
* exception is raised.
* <li>{@link org.springframework.http.HttpEntity HttpEntity<?>} parameters
* (Servlet-only) for access to the Servlet request HTTP headers and contents. | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-web/src/main/java/org/springframework/web/context/request/async/DeferredResult.java | @@ -139,7 +139,7 @@ public void onCompletion(Runnable callback) {
/**
* Provide a handler to use to handle the result value.
* @param resultHandler the handler
- * @see {@link DeferredResultProcessingInterceptor}
+ * @see DeferredResultProcessingInterceptor
*/
public final void setResultHandler(DeferredResultHandler resultHandler) {
Assert.notNull(resultHandler, "DeferredResultHandler is required"); | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-web/src/main/java/org/springframework/web/context/request/async/WebAsyncManager.java | @@ -51,9 +51,8 @@
*
* @see org.springframework.web.context.request.AsyncWebRequestInterceptor
* @see org.springframework.web.servlet.AsyncHandlerInterceptor
- * @see org.springframework.web.filter.OncePerRequestFilter#shouldFilterAsyncDispatches
+ * @see org.springframework.web.filter.OncePerRequestFilter#shouldNotFilterAsyncDispatch
* @see org.springframework.web.filter.OncePerRequestFilter#isAsyncDispatch
- * @see org.springframework.web.filter.OncePerRequestFilter#isLastRequestThread
*/
public final class WebAsyncManager {
@@ -195,7 +194,7 @@ public void registerCallableInterceptor(Object key, CallableProcessingIntercepto
/**
* Register a {@link CallableProcessingInterceptor} without a key.
* The key is derived from the class name and hashcode.
- * @param interceptor the interceptor to register
+ * @param interceptors one or more interceptors to register
*/
public void registerCallableInterceptors(CallableProcessingInterceptor... interceptors) {
Assert.notNull(interceptors, "A CallableProcessingInterceptor is required");
@@ -219,8 +218,7 @@ public void registerDeferredResultInterceptor(Object key, DeferredResultProcessi
/**
* Register a {@link DeferredResultProcessingInterceptor} without a key.
* The key is derived from the class name and hashcode.
- * @param key the key
- * @param interceptors the interceptor to register
+ * @param interceptors one or more interceptors to register
*/
public void registerDeferredResultInterceptors(DeferredResultProcessingInterceptor... interceptors) {
Assert.notNull(interceptors, "A DeferredResultProcessingInterceptor is required"); | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-web/src/main/java/org/springframework/web/context/support/StandardServletEnvironment.java | @@ -70,15 +70,15 @@ public class StandardServletEnvironment extends StandardEnvironment
* environment variables contributed by the {@link StandardEnvironment} superclass.
* <p>The {@code Servlet}-related property sources are added as {@link
* StubPropertySource stubs} at this stage, and will be {@linkplain
- * #initPropertySources(ServletContext) fully initialized} once the actual
+ * #initPropertySources(ServletContext, ServletConfig) fully initialized} once the actual
* {@link ServletContext} object becomes available.
* @see StandardEnvironment#customizePropertySources
* @see org.springframework.core.env.AbstractEnvironment#customizePropertySources
* @see ServletConfigPropertySource
* @see ServletContextPropertySource
* @see org.springframework.jndi.JndiPropertySource
* @see org.springframework.context.support.AbstractApplicationContext#initPropertySources
- * @see #initPropertySources(ServletContext)
+ * @see #initPropertySources(ServletContext, ServletConfig)
*/
@Override
protected void customizePropertySources(MutablePropertySources propertySources) { | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-web/src/main/java/org/springframework/web/context/support/WebApplicationContextUtils.java | @@ -247,7 +247,8 @@ public static void initServletPropertySources(
* <p>This method is idempotent with respect to the fact it may be called any number
* of times but will perform replacement of stub property sources with their
* corresponding actual property sources once and only once.
- * @param propertySources the {@link PropertySources} to initialize (must not be {@code null})
+ * @param propertySources the {@link MutablePropertySources} to initialize (must not
+ * be {@code null})
* @param servletContext the current {@link ServletContext} (ignored if {@code null}
* or if the {@link StandardServletEnvironment#SERVLET_CONTEXT_PROPERTY_SOURCE_NAME
* servlet context property source} has already been initialized) | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-webmvc-portlet/src/main/java/org/springframework/web/portlet/context/PortletApplicationContextUtils.java | @@ -188,15 +188,16 @@ static void registerEnvironmentBeans(
}
/**
- * Replace {@code Servlet}- and {@code Portlet}-based {@link StubPropertySource stub
- * property sources} with actual instances populated with the given {@code servletContext},
+ * Replace {@code Servlet}- and {@code Portlet}-based {@link
+ * org.springframework.core.env.PropertySource.StubPropertySource stub property
+ * sources} with actual instances populated with the given {@code servletContext},
* {@code portletContext} and {@code portletConfig} objects.
* <p>This method is idempotent with respect to the fact it may be called any number
* of times but will perform replacement of stub property sources with their
* corresponding actual property sources once and only once.
- * @param propertySources the {@link PropertySources} to initialize (must not be {@code null})
+ * @param propertySources the {@link MutablePropertySources} to initialize (must not be {@code null})
* @param servletContext the current {@link ServletContext} (ignored if {@code null}
- * or if the {@link StandardServletEnvironment#SERVLET_CONTEXT_PROPERTY_SOURCE_NAME
+ * or if the {@link org.springframework.web.context.support.StandardServletEnvironment#SERVLET_CONTEXT_PROPERTY_SOURCE_NAME
* servlet context property source} has already been initialized)
* @param portletContext the current {@link PortletContext} (ignored if {@code null}
* or if the {@link StandardPortletEnvironment#PORTLET_CONTEXT_PROPERTY_SOURCE_NAME | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-webmvc-portlet/src/main/java/org/springframework/web/portlet/mvc/package-info.java | @@ -6,19 +6,18 @@
* comes with Spring. Provides both abstract base classes and concrete
* implementations for often seen use cases.
* </p>
- *
+ *
* <p>
* A <code>Controller</code> - as defined in this package - is analogous to a Struts
* <code>Action</code>. Usually <code>Controllers</code> are JavaBeans
- * to allow easy configuration using the {@link org.springframework.beans org.springframework.beans}
- * package. Controllers define the <code>C</code> from so-called MVC paradigm
- * and can be used in conjunction with the {@link org.springframework.web.portlet.ModelAndView ModelAndView}
- * to achieve interactive applications. The view might be represented by a
- * HTML interface, but, because of model and the controller being completely
- * independent of the view, PDF views are possible, as well as for instance Excel
- * views.
+ * to allow easy configuration. Controllers define the <code>C</code> from so-called
+ * MVC paradigm and can be used in conjunction with the {@link
+ * org.springframework.web.portlet.ModelAndView ModelAndView} to achieve interactive
+ * applications. The view might be represented by a HTML interface, but, because of
+ * model and the controller being completely independent of the view, PDF views are
+ * possible, as well as for instance Excel views.
* </p>
- *
+ *
* <p>
* Especially useful to read, while getting into the Spring MVC framework
* are the following: | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-webmvc-tiles3/src/main/java/org/springframework/web/servlet/view/tiles3/TilesConfigurer.java | @@ -244,7 +244,6 @@ public void setServletContext(ServletContext servletContext) {
* Creates and exposes a TilesContainer for this web application,
* delegating to the TilesInitializer.
* @throws TilesException in case of setup failure
- * @see #createTilesInitializer()
*/
public void afterPropertiesSet() throws TilesException {
| true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-webmvc-tiles3/src/main/java/org/springframework/web/servlet/view/tiles3/TilesViewResolver.java | @@ -38,8 +38,8 @@ protected Class getViewClass() {
}
/**
- * Set the {@link Renderer} to use.
- * If not set, by default {@link DefinitionRenderer} is used.
+ * Set the {@link Renderer} to use. If not set, by default
+ * {@link org.apache.tiles.renderer.DefinitionRenderer} is used.
* @see TilesView#setRenderer(Renderer)
*/
public void setRenderer(Renderer renderer) { | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-webmvc/src/main/java/org/springframework/web/servlet/AsyncHandlerInterceptor.java | @@ -29,7 +29,7 @@
* exits without invoking {@code postHandle} and {@code afterCompletion}, as it
* normally does, since the results of request handling (e.g. ModelAndView)
* will. be produced concurrently in another thread. In such scenarios,
- * {@link #afterConcurrentHandlingStarted(HttpServletRequest, HttpServletResponse)}
+ * {@link #afterConcurrentHandlingStarted(HttpServletRequest, HttpServletResponse, Object)}
* is invoked instead allowing implementations to perform tasks such as cleaning
* up thread bound attributes.
* | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-webmvc/src/main/java/org/springframework/web/servlet/FrameworkServlet.java | @@ -783,8 +783,6 @@ protected void onRefresh(ApplicationContext context) {
/**
* Override the parent class implementation in order to intercept PATCH
* requests.
- *
- * @see #doPatch(HttpServletRequest, HttpServletResponse)
*/
@Override
protected void service(HttpServletRequest request, HttpServletResponse response) | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/ContentNegotiationConfigurer.java | @@ -29,7 +29,7 @@
* <p>By default strategies for checking the extension of the request path and
* the {@code Accept} header are registered. The path extension check will perform
* lookups through the {@link ServletContext} and the Java Activation Framework
- * (if present) unless {@linkplain #setMediaTypes(Map) media types} are configured.
+ * (if present) unless {@linkplain #mediaTypes(Map) media types} are configured.
*
* @author Rossen Stoyanchev
* @since 3.2
@@ -97,7 +97,7 @@ public ContentNegotiationConfigurer replaceMediaTypes(Map<String, MediaType> med
* {@link #favorPathExtension(boolean)} is set to {@code true}.
* <p>The default value is {@code true}.
* @see #parameterName
- * @see #setMediaTypes(Map)
+ * @see #mediaTypes(Map)
*/
public ContentNegotiationConfigurer useJaf(boolean useJaf) {
this.factoryBean.setUseJaf(useJaf);
@@ -112,7 +112,7 @@ public ContentNegotiationConfigurer useJaf(boolean useJaf) {
* for {@code /hotels?format=pdf} will be interpreted as a request for
* {@code "application/pdf"} regardless of the {@code Accept} header.
* <p>To use this option effectively you must also configure the MediaType
- * type mappings via {@link #setMediaTypes(Map)}.
+ * type mappings via {@link #mediaTypes(Map)}.
* @see #parameterName(String)
*/
public ContentNegotiationConfigurer favorParameter(boolean favorParameter) {
@@ -122,7 +122,7 @@ public ContentNegotiationConfigurer favorParameter(boolean favorParameter) {
/**
* Set the parameter name that can be used to determine the requested media type
- * if the {@link #setFavorParameter} property is {@code true}.
+ * if the {@link #favorParameter(boolean)} property is {@code true}.
* <p>The default parameter name is {@code "format"}.
*/
public ContentNegotiationConfigurer parameterName(String parameterName) { | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-webmvc/src/main/java/org/springframework/web/servlet/handler/MappedInterceptor.java | @@ -48,7 +48,8 @@ public MappedInterceptor(String[] includePatterns, HandlerInterceptor intercepto
/**
* Create a new MappedInterceptor instance.
- * @param pathPatterns the path patterns to map with a {@code null} value matching to all paths
+ * @param includePatterns the path patterns to map with a {@code null} value matching to all paths
+ * @param excludePatterns the path patterns to exclude
* @param interceptor the HandlerInterceptor instance to map to the given patterns
*/
public MappedInterceptor(String[] includePatterns, String[] excludePatterns, HandlerInterceptor interceptor) { | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/condition/ProducesRequestCondition.java | @@ -76,7 +76,7 @@ public ProducesRequestCondition(String[] produces, String[] headers) {
* accepting a {@link ContentNegotiationManager}.
* @param produces expressions with syntax defined by {@link RequestMapping#produces()}
* @param headers expressions with syntax defined by {@link RequestMapping#headers()}
- * @param contentNegotiationManager used to determine requested media types
+ * @param manager used to determine requested media types
*/
public ProducesRequestCondition(String[] produces, String[] headers,
ContentNegotiationManager manager) { | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/package-info.java | @@ -1,10 +1,9 @@
/**
- *
* MVC infrastructure for annotation-based handler method processing,
* building on the <code>org.springframework.web.method.annotation</code> package.
- * Entry points are {@link RequestMappingHandlerMapping} and {@link RequestMappingHandlerAdapter}.
- *
+ * Entry points are {@link org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping}
+ * and {@link org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter}.
*/
package org.springframework.web.servlet.mvc.method.annotation;
| true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/package-info.java | @@ -10,9 +10,9 @@
* <p>
* A <code>Controller</code> - as defined in this package - is analogous to a Struts
* <code>Action</code>. Usually <code>Controllers</code> are JavaBeans
- * to allow easy configuration using the {@link org.springframework.beans org.springframework.beans}
- * package. Controllers define the <code>C</code> from so-called MVC paradigm
- * and can be used in conjunction with the {@link org.springframework.web.servlet.ModelAndView ModelAndView}
+ * to allow easy configuration. Controllers define the <code>C</code> from so-called
+ * MVC paradigm and can be used in conjunction with the
+ * {@link org.springframework.web.servlet.ModelAndView ModelAndView}
* to achieve interactive applications. The view might be represented by a
* HTML interface, but, because of model and the controller being completely
* independent of the view, PDF views are possible, as well as for instance Excel | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/support/DefaultHandlerExceptionResolver.java | @@ -71,7 +71,7 @@
* @see #handleHttpMessageNotWritable
* @see #handleMethodArgumentNotValidException
* @see #handleMissingServletRequestParameter
- * @see #handleMissingServletRequestPart
+ * @see #handleMissingServletRequestPartException
* @see #handleBindException
*/
public class DefaultHandlerExceptionResolver extends AbstractHandlerExceptionResolver { | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-webmvc/src/main/java/org/springframework/web/servlet/support/AbstractDispatcherServletInitializer.java | @@ -137,7 +137,7 @@ protected String getServletName() {
* Specify filters to add and also map to the {@code DispatcherServlet}.
*
* @return an array of filters or {@code null}
- * @see #registerServletFilters(ServletContext, String, Filter...)
+ * @see #registerServletFilter(ServletContext, Filter)
*/
protected Filter[] getServletFilters() {
return null;
@@ -158,8 +158,7 @@ protected Filter[] getServletFilters() {
* filters directly with the {@code ServletContext}.
*
* @param servletContext the servlet context to register filters with
- * @param servletName the name of the servlet to map the filters to
- * @param filters the filters to be registered
+ * @param filter the filter to be registered
* @return the filter registration
*/
protected FilterRegistration.Dynamic registerServletFilter(ServletContext servletContext, Filter filter) { | true |
Other | spring-projects | spring-framework | f26534700a6646a6a6cf8debcffe8f108a7c9d9e.json | 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 | spring-webmvc/src/main/java/org/springframework/web/servlet/view/ContentNegotiatingViewResolver.java | @@ -297,11 +297,6 @@ public View resolveViewName(String viewName, Locale locale) throws Exception {
/**
* Determines the list of {@link MediaType} for the given {@link HttpServletRequest}.
- * <p>The default implementation invokes {@link #getMediaTypeFromFilename(String)} if {@linkplain
- * #setFavorPathExtension favorPathExtension} property is <code>true</code>. If the property is
- * <code>false</code>, or when a media type cannot be determined from the request path,
- * this method will inspect the {@code Accept} header of the request.
- * <p>This method can be overridden to provide a different algorithm.
* @param request the current servlet request
* @return the list of media types requested, if any
*/ | true |
Other | spring-projects | spring-framework | e09bdb31cc4d8e77a3157a9ecff3d29750a8614a.json | Add reference documentation for async web requests
Issue: SPR-9400 | src/reference/docbook/mvc.xml | @@ -1567,6 +1567,18 @@ public String processSubmit(<emphasis role="bold">@ModelAttribute("pet") Pet pet
linkend="mvc-ann-httpentity" />.</para>
</listitem>
+ <listitem>
+ <para>A <interfacename>Callable<?></interfacename> can
+ be returned when the application wants to produce the return
+ value asynchronously in a thread managed by Spring MVC.</para>
+ </listitem>
+
+ <listitem>
+ <para>A <classname>DeferredResult<?></classname> can
+ be returned when the application wants to produce the return
+ value from a thread of its own choosing.</para>
+ </listitem>
+
<listitem>
<para>Any other return type is considered to be a single model
attribute to be exposed to the view, using the attribute name
@@ -1576,6 +1588,7 @@ public String processSubmit(<emphasis role="bold">@ModelAttribute("pet") Pet pet
objects and the results of <literal>@ModelAttribute</literal>
annotated reference data accessor methods.</para>
</listitem>
+
</itemizedlist></para>
</section>
@@ -2359,6 +2372,228 @@ public String myHandleMethod(WebRequest webRequest, Model model) {
</section>
</section>
+ <section xml:id="mvc-ann-async">
+ <title>Asynchronous Request Processing</title>
+
+ <para>Spring MVC 3.2 introduced Servlet 3 based asynchronous request
+ processing. Instead of returning a value, as usual, a controller method
+ can now return a <interfacename>java.util.concurrent.Callable</interfacename>
+ and produce the return value from a separate thread. Meanwhile the main Servlet
+ container thread is released and allowed to process other requests.
+ Spring MVC invokes the <interfacename>Callable</interfacename> in a
+ separate thread with the help of a <interfacename>TaskExecutor</interfacename>
+ and when the <interfacename>Callable</interfacename> returns, the
+ request is dispatched back to the Servlet container to resume
+ processing with the value returned by the
+ <interfacename>Callable</interfacename>.
+ Here is an example controller method:</para>
+
+ <programlisting language="java">
+@RequestMapping(method=RequestMethod.POST)
+public Callable<String> processUpload(final MultipartFile file) {
+
+ return new Callable<String>() {
+ public Object call() throws Exception {
+ // ...
+ return "someView";
+ }
+ };
+}</programlisting>
+
+ <para>A second option is for the controller to return an instance of
+ <classname>DeferredResult</classname>. In this case the return value
+ will also be produced from a separate thread. However, that thread is not
+ known to Spring MVC. For example the result may be produced in response
+ to some external event such as a JMS message, a scheduled task, etc.
+ Here is an example controller method:</para>
+
+ <programlisting language="java">
+@RequestMapping("/quotes")
+@ResponseBody
+public DeferredResult<String> quotes() {
+ DeferredResult<String> deferredResult = new DeferredResult<String>();
+ // Save the deferredResult in in-memory queue ...
+ return deferredResult;
+}
+
+// In some other thread...
+deferredResult.setResult(data);
+</programlisting>
+
+ <para>This may be difficult to understand without any knowledge of the
+ Servlet 3 async processing feature. It would certainly help to read up on it.
+ At a very minimum consider the following basic facts:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>A <interfacename>ServletRequest</interfacename>
+ can be put in asynchronous mode by calling
+ <code>request.startAsync()</code>. The main effect of doing so is
+ that the Servlet, as well as any Filters, can exit but the response
+ will remain open allowing some other thread to complete processing.
+ </para>
+ </listitem>
+ <listitem>
+ <para>The call to <code>request.startAsync()</code> returns an
+ <interfacename>AsyncContext</interfacename>, which can be used for
+ further control over async processing. For example it provides
+ the method <code>dispatch</code>, which can be called from an
+ application thread in order to "dispatch" the request back to
+ the Servlet container. An async dispatch is similar to a forward
+ except it is made from one (application) thread to another
+ (Servlet container) thread whereas a forward occurs synchronously
+ in the same (Servlet container) thread.</para>
+ </listitem>
+ <listitem>
+ <para><interfacename>ServletRequest</interfacename> provides access
+ to the current <interfacename>DispatcherType</interfacename>, which
+ can be used to distinguish if a <interfacename>Servlet</interfacename> or
+ a <interfacename>Filter</interfacename> is processing on
+ the initial request processing thread and when it is processing in
+ an async dispatch.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>With the above in mind, the following is the sequence
+ of events for async request processing with a <interfacename>Callable</interfacename>:
+ (1) Controller returns a
+ <interfacename>Callable</interfacename>, (2) Spring MVC starts async processing
+ and submits the <interfacename>Callable</interfacename>
+ to a <interfacename>TaskExecutor</interfacename>
+ for processing in a separate thread, (3) the <classname>DispatcherServlet</classname>
+ and all Filter's exit the request processing thread but the response
+ remains open, (4) the <interfacename>Callable</interfacename> produces a result
+ and Spring MVC dispatches the request back to the Servlet container,
+ (5) the <classname>DispatcherServlet</classname> is invoked again and processing
+ resumes with the asynchronously produced result from the
+ <interfacename>Callable</interfacename>. The exact sequencing of (2),
+ (3), and (4) may vary depending on the speed of execution of the
+ concurrent threads.
+ </para>
+
+ <para>The sequence of events for async request processing with a
+ <classname>DeferredResult</classname> is the same in principal except
+ it's up to the application to produce the asynchronous result from some thread:
+ (1) Controller returns a <classname>DeferredResult</classname> and saves it
+ in some in-memory queue or list where it can be accessed,
+ (2) Spring MVC starts async processing, (3) the <classname>DispatcherServlet</classname>
+ and all configured Filter's exit the request processing thread but the response
+ remains open, (4) the application sets the <classname>DeferredResult</classname>
+ from some thread and Spring MVC dispatches the request back to the Servlet container,
+ (5) the <classname>DispatcherServlet</classname> is invoked again and processing
+ resumes with the asynchronously produced result.
+ </para>
+
+ <para>Explaining the motivation for async request processing, when or why to use it
+ is beyond the scope of this document. For further information you may wish to read
+ <link xl:href="http://http://blog.springsource.org/2012/05/06/spring-mvc-3-2-preview-introducing-servlet-3-async-support/"> this blog post series</link>.
+ </para>
+
+ <section xml:id="mvc-ann-async-exceptions">
+ <title>Async Request Processing and Exception Handling</title>
+
+ <para>What happens if a <interfacename>Callable</interfacename> returned
+ from a controller method raises an Exception while being executed?
+ The effect is similar to what happens when any controller method raises
+ an exception. It is handled by a matching
+ <interfacename>@ExceptionHandler</interfacename> method in the same
+ controller or by one of the configured
+ <interfacename>HandlerExceptionResolver</interfacename> instances.</para>
+
+ <note>
+ <para>Under the covers, when a <interfacename>Callable</interfacename>
+ raises an Exception, Spring MVC still dispatches to the Servlet
+ container to resume processing. The only difference is that the
+ result of executing the <interfacename>Callable</interfacename>
+ is an <classname>Exception</classname> that must be processed
+ with the configured
+ <interfacename>HandlerExceptionResolver</interfacename> instances.</para>
+ </note>
+
+ <para>When using a <classname>DeferredResult</classname>, you have
+ a choice of calling its <code>setErrorResult(Object)</code> method
+ and provide an <classname>Exception</classname> or any other Object
+ you'd like to use as the result. If the result is an
+ <classname>Exception</classname>, it will be processed with a
+ matching <interfacename>@ExceptionHandler</interfacename> method in the
+ same controller or with any configured
+ <interfacename>HandlerExceptionResolver</interfacename> instance.</para>
+ </section>
+
+ <section xml:id="mvc-ann-async-interception">
+ <title>Intercepting Async Requests</title>
+
+ <para>An existing <interfacename>HandlerInterceptor</interfacename> can
+ implement <interfacename>AsyncHandlerInterceptor</interfacename>, which
+ provides one additional method <code>afterConcurrentHandlingStarted</code>.
+ It is invoked after async processing starts and when the initial
+ request processing thread is being exited. See the Javadoc of
+ <interfacename>AsyncHandlerInterceptor</interfacename> for more details
+ on that.</para>
+
+ <para>Further options for async request lifecycle callbacks are
+ provided directly on <classname>DeferredResult</classname>,
+ which has the methods <code>onTimeout(Runnable)</code> and
+ <code>onCompletion(Runnable)</code>. Those are called when the
+ async request is about to time out or has completed respectively.
+ The timeout event can be handled by setting the
+ <classname>DeferredResult</classname> to some value.
+ The completion callback however is final and the result can no
+ longer be set.</para>
+
+ <para>Similar callbacks are also available with a
+ <interfacename>Callable</interfacename>. However, you will need to wrap
+ the <interfacename>Callable</interfacename> in an instance of
+ <classname>WebAsyncTask</classname> and then use that to register
+ the timeout and completion callbacks. Just like with
+ <classname>DeferredResult</classname>, the timeout event can be
+ handled and a value can be returned while the completion event is final.</para>
+
+ <para>You can also register a
+ <interfacename>CallableProcessingInterceptor</interfacename> or a
+ <interfacename>DeferredResultProcessingInterceptor</interfacename>
+ globally through the MVC Java config or the MVC namespace.
+ Those interceptors provide a full set of callbacks and apply every
+ time a <interfacename>Callable</interfacename> or a
+ <classname>DeferredResult</classname> is used.</para>
+
+ </section>
+
+ <section xml:id="mvc-ann-async-configuration">
+ <title>Async Request Configuration</title>
+
+ <para>The MVC Java config and the MVC namespace provide options for
+ configuring async request processing.
+ <interfacename>WebMvcConfigurer</interfacename> has the method
+ <code>configureAsyncSupport</code> while <mvc:annotation-driven>
+ has an <async-support> sub-element.</para>
+
+ <para>Those allow you to configure the default timeout value to use for
+ async requests, which if not set depends on the underlying Servlet
+ container (e.g. 10 seconds on Tomcat). You can also configure an
+ <interfacename>AsyncTaskExecutor</interfacename> to use for executing
+ <interfacename>Callable</interfacename> instances returned from
+ controller methods. It is highly recommended to configure this property
+ since by default Spring MVC uses
+ <classname>SimpleAsyncTaskExecutor</classname>. The MVC Java config
+ and the MVC namespace also allow you to register
+ <interfacename>CallableProcessingInterceptor</interfacename> and
+ <interfacename>DeferredResultProcessingInterceptor</interfacename>
+ instances.</para>
+
+ <para>If you need to override the default timeout value for a
+ specific <classname>DeferredResult</classname>, you can do so by using
+ the appropriate class constructor. Similarly, for a
+ <interfacename>Callable</interfacename>, you can wrap it in a
+ <classname>WebAsyncTask</classname> and use the appropriate class
+ constructor to customize the timeout value. The class constructor of
+ <classname>WebAsyncTask</classname> also allows providing
+ an <interfacename>AsyncTaskExecutor</interfacename>.</para>
+
+ </section>
+
+ </section>
+
<section xml:id="mvc-ann-tests">
<title>Testing Controllers</title>
| true |
Other | spring-projects | spring-framework | e09bdb31cc4d8e77a3157a9ecff3d29750a8614a.json | Add reference documentation for async web requests
Issue: SPR-9400 | src/reference/docbook/new-in-3.2.xml | @@ -37,10 +37,8 @@
</listitem>
</itemizedlist>
- <para>See <link
- xl:href="http://blog.springsource.org/2012/05/06/spring-mvc-3-2-preview-introducing-servlet-3-async-support/">
- Introducing Servlet 3 Async Support</link> (SpringSource team
- blog).</para>
+ <para>See <xref linkend="mvc-ann-async"/>.</para>
+
</section>
<section xml:id="new-in-3.2-spring-mvc-test">
@@ -258,5 +256,6 @@
linkend="testcontext-ctx-management-initializers">ApplicationContextInitializers</link></para>
</listitem>
</itemizedlist>
+
</section>
</chapter> | true |
Other | spring-projects | spring-framework | 7f1b990ee99ef336438f7c3b7e785ce89246e499.json | Reformat the Testing chapter
Reformatted the Testing chapter in preparation for upcoming changes. | src/reference/docbook/testing.xml | @@ -2406,88 +2406,90 @@ public class SimpleTest {
<title>Standalone project</title>
<para>Before inclusion in Spring Framework 3.2, the Spring MVC Test
- framework had already existed as a separate project on Github where
- it grew and evolved through actual use, feedback, and the contribution of
+ framework had already existed as a separate project on GitHub where it
+ grew and evolved through actual use, feedback, and the contribution of
many.</para>
- <para>The standalone
- <link xl:href="https://github.com/SpringSource/spring-test-mvc">spring-test-mvc project</link>
- is still available on Github and can be used in conjunction with
- Spring Framework 3.1.x. Applications upgrading to 3.2 should replace
- the <filename>spring-test-mvc</filename> dependency with a dependency on
- <filename>spring-test</filename>.</para>
-
- <para>The <filename>spring-test</filename> module uses a
- different package <classname>org.springframework.test.web</classname>
- but otherwise is nearly identical with two exceptions.
- One is support for features new in 3.2 (e.g. async web requests).
- The other relates to the options
- for creating a <classname>MockMvc</classname> instance. In Spring
- Framework 3.2, this can only be done through the TestContext framework,
- which provides caching benefits for the loaded configuration.</para>
+
+ <para>The standalone <link
+ xl:href="https://github.com/SpringSource/spring-test-mvc">spring-test-mvc
+ project</link> is still available on GitHub and can be used in
+ conjunction with Spring Framework 3.1.x. Applications upgrading to 3.2
+ should replace the <filename>spring-test-mvc</filename> dependency
+ with a dependency on <filename>spring-test</filename>.</para>
+
+ <para>The <filename>spring-test</filename> module uses a different
+ package <classname>org.springframework.test.web</classname> but
+ otherwise is nearly identical with two exceptions. One is support for
+ features new in 3.2 (e.g. async web requests). The other relates to
+ the options for creating a <classname>MockMvc</classname> instance. In
+ Spring Framework 3.2, this can only be done through the TestContext
+ framework, which provides caching benefits for the loaded
+ configuration.</para>
</sidebar>
- <para>The <emphasis>Spring MVC Test framework</emphasis> provides
- first class JUnit support for testing client and server-side
- Spring MVC code through a fluent API. Typically it loads
- the actual Spring configuration through the
- <emphasis>TestContext framework</emphasis> and always uses the
- <classname>DispatcherServlet</classname> to process requests
- thus approximating full integration tests without requiring
- a running servlet container.</para>
-
- <para>Client-side tests are
- <classname>RestTemplate</classname>-based and allow tests for code
- that relies on the <code>RestTemplate</code> without requiring a
- running server to respond to the requests.
- </para>
+ <para>The <emphasis>Spring MVC Test framework</emphasis> provides first
+ class JUnit support for testing client and server-side Spring MVC code
+ through a fluent API. Typically it loads the actual Spring configuration
+ through the <emphasis>TestContext framework</emphasis> and always uses
+ the <classname>DispatcherServlet</classname> to process requests thus
+ approximating full integration tests without requiring a running servlet
+ container.</para>
+
+ <para>Client-side tests are <classname>RestTemplate</classname>-based
+ and allow tests for code that relies on the <code>RestTemplate</code>
+ without requiring a running server to respond to the requests.</para>
<section xml:id="spring-mvc-test-server">
<title>Server-Side Tests</title>
- <para>Before Spring Framework 3.2, the most likely way to test a Spring MVC
- controller was to write a unit test that instantiates the controller,
- injects it with mock or stub dependencies, and then calls its methods
- directly, using a <classname>MockHttpServletRequest</classname> and
+ <para>Before Spring Framework 3.2, the most likely way to test a
+ Spring MVC controller was to write a unit test that instantiates the
+ controller, injects it with mock or stub dependencies, and then calls
+ its methods directly, using a
+ <classname>MockHttpServletRequest</classname> and
<classname>MockHttpServletResponse</classname> where necessary.</para>
- <para>Although this is pretty easy to do, controllers have many annotations,
- and much remains not tested. Request mappings, data binding,
- type conversion, and validation are just a few examples of what isn't tested.
- Furthermore, there are other types of annotated methods
- such as <interfacename>@InitBinder</interfacename>,
+
+ <para>Although this is pretty easy to do, controllers have many
+ annotations, and much remains untested. Request mappings, data
+ binding, type conversion, and validation are just a few examples of
+ what isn't tested. Furthermore, there are other types of annotated
+ methods such as <interfacename>@InitBinder</interfacename>,
<interfacename>@ModelAttribute</interfacename>, and
- <interfacename>@ExceptionHandler</interfacename> that get invoked as part
- of request processing.</para>
-
- <para>The idea behind Spring MVC Test is to be able to
- re-write those controller tests by performing actual requests, and generating
- responses, as they would be at runtime, along the way invoking controllers
- through the Spring MVC <classname>DispatcherServlet</classname>. Controllers
- can still be injected with mock dependencies, so tests can remain focused
- on the web layer.</para>
-
- <para>Spring MVC Test builds on the familiar "mock" implementations
- of the Servlet API available in the <filename>spring-test</filename> module.
- This allows performing requests and generating responses without
- the need for running in a Servlet container. For the most part everything should
- work as it does at runtime with the exception of JSP rendering, which is
- not available outside a Servlet container. Furthermore,
- if you are familiar with how the <classname>MockHttpServletResponse</classname>
- works, you'll know that forwards and redirects are not actually executed.
- Instead "forwarded" and "redirected" URLs are saved and can be asserted
- in tests. This means if using JSPs, you can verify the JSP page
- the request was forwarded to.</para>
+ <interfacename>@ExceptionHandler</interfacename> that get invoked as
+ part of request processing.</para>
+
+ <para>The idea behind Spring MVC Test is to be able to re-write those
+ controller tests by performing actual requests and generating
+ responses, as they would be at runtime, along the way invoking
+ controllers through the Spring MVC
+ <classname>DispatcherServlet</classname>. Controllers can still be
+ injected with mock dependencies, so tests can remain focused on the
+ web layer.</para>
+
+ <para>Spring MVC Test builds on the familiar "mock" implementations of
+ the Servlet API available in the <filename>spring-test</filename>
+ module. This allows performing requests and generating responses
+ without the need for running in a Servlet container. For the most part
+ everything should work as it does at runtime with the exception of JSP
+ rendering, which is not available outside a Servlet container.
+ Furthermore, if you are familiar with how the
+ <classname>MockHttpServletResponse</classname> works, you'll know that
+ forwards and redirects are not actually executed. Instead "forwarded"
+ and "redirected" URLs are saved and can be asserted in tests. This
+ means if you are using JSPs, you can verify the JSP page to which the request was
+ forwarded.</para>
<para>All other means of rendering including
<interfacename>@ResponseBody</interfacename> methods and
<interfacename>View</interfacename> types (besides JSPs) such as
- Freemarker, Velocity, Thymeleaf, and others for rendering HTML,
- JSON, XML, and so on should work as expected and the response will
- contain the generated content.
- </para>
+ Freemarker, Velocity, Thymeleaf, and others for rendering HTML, JSON,
+ XML, and so on should work as expected, and the response will contain
+ the generated content.</para>
- <para>Below is an example of a test requesting account information in JSON format:</para>
+ <para>Below is an example of a test requesting account information in
+ JSON format:</para>
-<programlisting language="java">import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
+ <programlisting language="java">import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
@RunWith(SpringJUnit4ClassRunner.class)
@@ -2515,59 +2517,56 @@ public class ExampleTests {
}</programlisting>
- <para>The test relies on the <interfacename>WebApplicationContext</interfacename>
- support of the <emphasis>TestContext framework</emphasis>. It loads Spring configuration from
- an XML config file located in the same
- package as the test class (also supports Java config) and injects
- the created <interfacename>WebApplicationContext</interfacename>
- into the test so a <classname>MockMvc</classname> instance can be
- created with it.</para>
-
- <para>The <classname>MockMvc</classname> is then
- used to perform a request to <filename>"/accounts/1"</filename>
- and verify the resulting
+ <para>The test relies on the
+ <interfacename>WebApplicationContext</interfacename> support of the
+ <emphasis>TestContext framework</emphasis>. It loads Spring
+ configuration from an XML config file located in the same package as
+ the test class (also supports Java config) and injects the created
+ <interfacename>WebApplicationContext</interfacename> into the test so
+ a <classname>MockMvc</classname> instance can be created with
+ it.</para>
+
+ <para>The <classname>MockMvc</classname> is then used to perform a
+ request to <filename>"/accounts/1"</filename> and verify the resulting
response status is 200, the response content type is
- <filename>"application/json"</filename>, and response content
- has a JSON property called "name" with the value "Lee".
- JSON content is inspected with the help of Jayway's
- <link xl:href="https://github.com/jayway/JsonPath">JsonPath project</link>.
- There are lots of other options for verifying the
- result of the performed request and those will be discussed later.</para>
+ <filename>"application/json"</filename>, and response content has a
+ JSON property called "name" with the value "Lee". JSON content is
+ inspected with the help of Jayway's <link
+ xl:href="https://github.com/jayway/JsonPath">JsonPath project</link>.
+ There are lots of other options for verifying the result of the
+ performed request and those will be discussed later.</para>
<section xml:id="spring-mvc-test-server-static-imports">
<title>Static Imports</title>
- <para>The fluent API in the example above requires a few static imports
- such as <classname>MockMvcRequestBuilders.*</classname>,
+ <para>The fluent API in the example above requires a few static
+ imports such as <classname>MockMvcRequestBuilders.*</classname>,
<classname>MockMvcResultMatchers.*</classname>, and
- <classname>MockMvcBuilders.*</classname>. An easy way to find
- these classes is to search for types matching
- <emphasis>"MockMvc*"</emphasis>.
- If using Eclipse, be sure to add them as
- "favorite static members" in the Eclipse preferences under
- <emphasis>Java -> Editor -> Content Assist -> Favorites</emphasis>.
- That will allow use of content assist after typing
- the first character of the static method name.
- Other IDEs (e.g. IntelliJ) may not require any additional
- configuration. Just check the support for code completion
- on static members.
- </para>
+ <classname>MockMvcBuilders.*</classname>. An easy way to find these
+ classes is to search for types matching
+ <emphasis>"MockMvc*"</emphasis>. If using Eclipse, be sure to add
+ them as "favorite static members" in the Eclipse preferences under
+ <emphasis>Java -> Editor -> Content Assist ->
+ Favorites</emphasis>. That will allow use of content assist after
+ typing the first character of the static method name. Other IDEs
+ (e.g. IntelliJ) may not require any additional configuration. Just
+ check the support for code completion on static members.</para>
</section>
<section xml:id="spring-mvc-test-server-setup-options">
<title>Setup Options</title>
- <para>The goal of server-side test setup is to create
- an instance of <classname>MockMvc</classname> that can be used
- to perform requests. There are two main options.</para>
+ <para>The goal of server-side test setup is to create an instance of
+ <classname>MockMvc</classname> that can be used to perform requests.
+ There are two main options.</para>
<para>The first option is to point to Spring MVC configuration
- through the <emphasis>TestContext framework</emphasis>,
- which loads the Spring configuration and injects a
- <interfacename>WebApplicationContext</interfacename> into the
- test to use to create a <classname>MockMvc</classname>:</para>
+ through the <emphasis>TestContext framework</emphasis>, which loads
+ the Spring configuration and injects a
+ <interfacename>WebApplicationContext</interfacename> into the test
+ to use to create a <classname>MockMvc</classname>:</para>
-<programlisting language="java">@RunWith(SpringJUnit4ClassRunner.class)
+ <programlisting language="java">@RunWith(SpringJUnit4ClassRunner.class)
@WebAppConfiguration
@ContextConfiguration("my-servlet-context.xml")
public class MyWebTests {
@@ -2586,15 +2585,14 @@ public class MyWebTests {
}</programlisting>
- <para>The second option is to simply register a controller
- instance without loading any Spring configuration.
- Instead basic Spring MVC configuration suitable for testing
- annotated controllers is automatically created. The created
- configuration is comparable to that of the MVC Java config
- (and the MVC namespace) and can be customized to a degree
- through builder-style methods:</para>
+ <para>The second option is to simply register a controller instance
+ without loading any Spring configuration. Instead basic Spring MVC
+ configuration suitable for testing annotated controllers is
+ automatically created. The created configuration is comparable to
+ that of the MVC Java config (and the MVC namespace) and can be
+ customized to a degree through builder-style methods:</para>
-<programlisting language="java">public class MyWebTests {
+ <programlisting language="java">public class MyWebTests {
private MockMvc mockMvc;
@@ -2609,26 +2607,25 @@ public class MyWebTests {
<para>Which option should you use?</para>
- <para>The <emphasis>"webAppContextSetup"</emphasis> loads
- the actual Spring MVC configuration
- resulting in a more complete integration test. Since the
- <emphasis>TestContext framework</emphasis> caches the loaded
- Spring configuration, it helps to keep tests running fast
+ <para>The <emphasis>"webAppContextSetup"</emphasis> loads the actual
+ Spring MVC configuration resulting in a more complete integration
+ test. Since the <emphasis>TestContext framework</emphasis> caches
+ the loaded Spring configuration, it helps to keep tests running fast
even as more tests get added. Furthermore, you can inject mock
- services into controllers through Spring configuration,
- in order to remain focused on testing the web layer.
- Here is an example of declaring a mock service with Mockito:</para>
+ services into controllers through Spring configuration, in order to
+ remain focused on testing the web layer. Here is an example of
+ declaring a mock service with Mockito:</para>
-<programlisting language="xml">
+ <programlisting language="xml">
<bean id="accountService" class="org.mockito.Mockito" factory-method="mock">
<constructor-arg value="org.example.AccountService"/>
</bean>
</programlisting>
- <para>Then you can inject the mock service into the test
- in order set up and verify expectations:</para>
+ <para>Then you can inject the mock service into the test in order
+ set up and verify expectations:</para>
-<programlisting language="java">@RunWith(SpringJUnit4ClassRunner.class)
+ <programlisting language="java">@RunWith(SpringJUnit4ClassRunner.class)
@WebAppConfiguration
@ContextConfiguration("test-servlet-context.xml")
public class AccountTests {
@@ -2645,78 +2642,78 @@ public class AccountTests {
}</programlisting>
- <para>The <emphasis>"standaloneSetup"</emphasis> on the other
- hand is a little closer to a unit test. It tests one controller at a time,
- the controller can be injected with mock dependencies manually,
- and it doesn't involve loading Spring configuration.
- Such tests are more focused in style and make it easier to see
- which controller is being tested, whether any specific Spring MVC
- configuration is required to work, and so on. The "standaloneSetup" is also
- a very convenient way to write ad-hoc tests to verify some
+ <para>The <emphasis>"standaloneSetup"</emphasis> on the other hand
+ is a little closer to a unit test. It tests one controller at a
+ time, the controller can be injected with mock dependencies
+ manually, and it doesn't involve loading Spring configuration. Such
+ tests are more focused in style and make it easier to see which
+ controller is being tested, whether any specific Spring MVC
+ configuration is required to work, and so on. The "standaloneSetup"
+ is also a very convenient way to write ad-hoc tests to verify some
behavior or to debug an issue.</para>
- <para>Just like with integration vs unit testing, there is no right or
- wrong answer. Using the "standaloneSetup" does imply the
- need for some additional "webAppContextSetup" tests to verify the
- Spring MVC configuration. Alternatively, you can decide write all
- tests with "webAppContextSetup" and always test against actual
- Spring MVC configuration.</para>
+ <para>Just like with integration vs unit testing, there is no right
+ or wrong answer. Using the "standaloneSetup" does imply the need for
+ some additional "webAppContextSetup" tests to verify the Spring MVC
+ configuration. Alternatively, you can decide write all tests with
+ "webAppContextSetup" and always test against actual Spring MVC
+ configuration.</para>
</section>
<section xml:id="spring-mvc-test-server-performing-requests">
<title>Performing Requests</title>
- <para>To perform requests, use the appropriate HTTP
- method and additional builder-style methods corresponding
- to properties of <classname>MockHttpServletRequest</classname>.
- For example:</para>
+ <para>To perform requests, use the appropriate HTTP method and
+ additional builder-style methods corresponding to properties of
+ <classname>MockHttpServletRequest</classname>. For example:</para>
-<programlisting language="java">
+ <programlisting language="java">
mockMvc.perform(post("/hotels/{id}", 42).accept(MediaType.APPLICATION_JSON));
</programlisting>
<para>In addition to all the HTTP methods, you can also perform file
upload requests, which internally creates an instance of
<classname>MockMultipartHttpServletRequest</classname>:</para>
-<programlisting language="java">
+ <programlisting language="java">
mockMvc.perform(fileUpload("/doc").file("a1", "ABC".getBytes("UTF-8")));
</programlisting>
- <para>Query string parameters can be specified in the URI template:</para>
+ <para>Query string parameters can be specified in the URI
+ template:</para>
-<programlisting language="java">
+ <programlisting language="java">
mockMvc.perform(get("/hotels?foo={foo}", "bar"));
</programlisting>
<para>Or by adding Servlet request parameters:</para>
-<programlisting language="java">
+ <programlisting language="java">
mockMvc.perform(get("/hotels").param("foo", "bar"));
</programlisting>
<para>If application code relies on Servlet request parameters, and
- doesn't check the query string, as is most often the case,
- then it doesn't matter how parameters are added. Keep in mind
- though that parameters provided in the URI template will be decoded
- while parameters provided through the <code>param(...)</code>
- method are expected to be decoded.</para>
-
- <para>In most cases it's preferable to leave out the context path and
- the servlet path from the request URI. If you must test with the full
- request URI, be sure to set the contextPath and servletPath
+ doesn't check the query string, as is most often the case, then it
+ doesn't matter how parameters are added. Keep in mind though that
+ parameters provided in the URI template will be decoded while
+ parameters provided through the <code>param(...)</code> method are
+ expected to be decoded.</para>
+
+ <para>In most cases it's preferable to leave out the context path
+ and the servlet path from the request URI. If you must test with the
+ full request URI, be sure to set the contextPath and servletPath
accordingly so that request mappings will work:</para>
-<programlisting language="java">
+ <programlisting language="java">
mockMvc.perform(get("/app/main/hotels/{id}").contextPath("/app").servletPath("/main"))
</programlisting>
<para>Looking at the above example, it would be cumbersome to set
- the contextPath and servletPath with every peformed request.
- That's why you can define default request
- properties when building the <classname>MockMvc</classname>:</para>
+ the contextPath and servletPath with every performed request. That's
+ why you can define default request properties when building the
+ <classname>MockMvc</classname>:</para>
-<programlisting language="java">
+ <programlisting language="java">
public class MyWebTests {
private MockMvc mockMvc;
@@ -2731,43 +2728,44 @@ public class MyWebTests {
}</programlisting>
- <para>The above properties will apply to every request performed through
- the <classname>MockMvc</classname>. If the same property is also specified
- on a given request, it will override the default value. That is why, the
- HTTP method and URI don't matter, when setting default request properties,
- since they must be specified on every request.</para>
-
+ <para>The above properties will apply to every request performed
+ through the <classname>MockMvc</classname>. If the same property is
+ also specified on a given request, it will override the default
+ value. That is why, the HTTP method and URI don't matter, when
+ setting default request properties, since they must be specified on
+ every request.</para>
</section>
<section xml:id="spring-mvc-test-server-defining-expectations">
<title>Defining Expectations</title>
<para>Expectations can be defined by appending one or more
- <code>.andExpect(..)</code> after call to perform the request:</para>
+ <code>.andExpect(..)</code> after call to perform the
+ request:</para>
-<programlisting language="java">
+ <programlisting language="java">
mockMvc.perform(get("/accounts/1")).andExpect(status().isOk());
</programlisting>
- <para><code>MockMvcResultMatchers.*</code> defines a number of static
- members, some of which return types with additional methods, for
- asserting the result of the performed request. The assertions
+ <para><code>MockMvcResultMatchers.*</code> defines a number of
+ static members, some of which return types with additional methods,
+ for asserting the result of the performed request. The assertions
fall in two general categories.</para>
<para>The first category of assertions verify properties of the
- response, i.e the response status, headers, and content.
- Those are the most important things to test for.</para>
-
- <para>The second category of assertions go beyond the response, and allow
- inspecting Spring MVC specific constructs such as which controller
- method processed the request, whether an exception was raised and handled,
- what the content of the model is, what view was selected, what flash
- attributes were added, and so on. It is also possible to
- verify Servlet specific constructs such as request and session attributes.
- The following test asserts that binding/validation failed:
- </para>
-
-<programlisting language="java">
+ response, i.e the response status, headers, and content. Those are
+ the most important things to test for.</para>
+
+ <para>The second category of assertions go beyond the response, and
+ allow inspecting Spring MVC specific constructs such as which
+ controller method processed the request, whether an exception was
+ raised and handled, what the content of the model is, what view was
+ selected, what flash attributes were added, and so on. It is also
+ possible to verify Servlet specific constructs such as request and
+ session attributes. The following test asserts that
+ binding/validation failed:</para>
+
+ <programlisting language="java">
mockMvc.perform(post("/persons"))
.andExpect(status().isOk())
.andExpect(model().attributeHasErrors("person"));
@@ -2776,7 +2774,7 @@ mockMvc.perform(post("/persons"))
<para>Many times when writing tests, it's useful to dump the result
of the performed request. This can be done as follows:</para>
-<programlisting language="java">
+ <programlisting language="java">
mockMvc.perform(post("/persons"))
.andDo(print())
.andExpect(status().isOk())
@@ -2785,14 +2783,16 @@ mockMvc.perform(post("/persons"))
<para>where <code>print()</code> is a static import from
<code>MockMvcResultHandlers</code>. As long as request processing
- does cause an unhandled exception, the <code>print()</code>
- method will print all the available result data to <code>System.out</code>.</para>
+ does cause an unhandled exception, the <code>print()</code> method
+ will print all the available result data to
+ <code>System.out</code>.</para>
- <para>In some cases, you may want to get direct access to the result and
- verify something that cannot be verified otherwise. This can be done by
- appending <code>.andReturn()</code> at the end after all expectations:</para>
+ <para>In some cases, you may want to get direct access to the result
+ and verify something that cannot be verified otherwise. This can be
+ done by appending <code>.andReturn()</code> at the end after all
+ expectations:</para>
-<programlisting language="java">
+ <programlisting language="java">
MvcResult mvcResult = mockMvc.perform(post("/persons")).andExpect(status().isOk()).andReturn();
// ...
</programlisting>
@@ -2801,75 +2801,76 @@ MvcResult mvcResult = mockMvc.perform(post("/persons")).andExpect(status().isOk(
the common expectations once when building the
<classname>MockMvc</classname>:</para>
-<programlisting language="java">
+ <programlisting language="java">
standaloneSetup(new SimpleController())
.alwaysExpect(status().isOk())
.alwaysExpect(content().contentType("application/json;charset=UTF-8"))
.build()
</programlisting>
- <para>Note that the expectation is <emphasis>always</emphasis> applied
- and cannot be overridden without creating a separate
- <classname>MockMvc</classname> instance. </para>
+ <para>Note that the expectation is <emphasis>always</emphasis>
+ applied and cannot be overridden without creating a separate
+ <classname>MockMvc</classname> instance.</para>
- <para>When JSON response content contains hypermedia links created with
- <link xl:href="https://github.com/SpringSource/spring-hateoas">Spring HATEOAS</link>,
- the resulting links can be verified:</para>
+ <para>When JSON response content contains hypermedia links created
+ with <link
+ xl:href="https://github.com/SpringSource/spring-hateoas">Spring
+ HATEOAS</link>, the resulting links can be verified:</para>
-<programlisting language="java">
+ <programlisting language="java">
mockMvc.perform(get("/people").accept(MediaType.APPLICATION_JSON))
.andExpect(jsonPath("$.links[?(@.rel == 'self')].href").value("http://localhost:8080/people"));
</programlisting>
- <para>When XML response content contains hypermedia links created with
- <link xl:href="https://github.com/SpringSource/spring-hateoas">Spring HATEOAS</link>,
- the resulting links can be verified:</para>
+ <para>When XML response content contains hypermedia links created
+ with <link
+ xl:href="https://github.com/SpringSource/spring-hateoas">Spring
+ HATEOAS</link>, the resulting links can be verified:</para>
-<programlisting language="java">
+ <programlisting language="java">
Map<String, String> ns = Collections.singletonMap("ns", "http://www.w3.org/2005/Atom");
mockMvc.perform(get("/handle").accept(MediaType.APPLICATION_XML))
.andExpect(xpath("/person/ns:link[@rel='self']/@href", ns).string("http://localhost:8080/people"));
</programlisting>
-
</section>
<section xml:id="spring-mvc-test-server-filters">
<title>Filter Registrations</title>
<para>When setting up a <classname>MockMvc</classname>, you can
- register one or more <interfacename>Filter</interfacename> instances:</para>
+ register one or more <interfacename>Filter</interfacename>
+ instances:</para>
-<programlisting language="java">
+ <programlisting language="java">
mockMvc = standaloneSetup(new PersonController()).addFilters(new CharacterEncodingFilter()).build();
</programlisting>
<para>Registered filters will be invoked through
<classname>MockFilterChain</classname> from
- <filename>spring-test</filename> and the last filter will delegates to
- the <classname>DispatcherServlet</classname>.</para>
-
+ <filename>spring-test</filename> and the last filter will delegates
+ to the <classname>DispatcherServlet</classname>.</para>
</section>
<section xml:id="spring-mvc-test-server-resources">
<title>Further Server-Side Test Examples</title>
- <para>The framework's own tests include
- <link xl:href="https://github.com/SpringSource/spring-framework/tree/master/spring-test-mvc/src/test/java/org/springframework/test/web/servlet/samples">many sample tests</link>
- intended to demonstrate how to use Spring MVC Test.
- Browse these examples for further ideas. Also the
- <link xl:href="https://github.com/SpringSource/spring-mvc-showcase">spring-mvc-showcase</link>
- has full test coverage based on Spring MVC Test.</para>
+ <para>The framework's own tests include <link
+ xl:href="https://github.com/SpringSource/spring-framework/tree/master/spring-test-mvc/src/test/java/org/springframework/test/web/servlet/samples">many
+ sample tests</link> intended to demonstrate how to use Spring MVC
+ Test. Browse these examples for further ideas. Also the <link
+ xl:href="https://github.com/SpringSource/spring-mvc-showcase">spring-mvc-showcase</link>
+ has full test coverage based on Spring MVC Test.</para>
</section>
-
</section>
<section xml:id="spring-mvc-test-client">
<title>Client-Side REST Tests</title>
- <para>Client-side tests are for code using the <classname>RestTemplate</classname>.
- The goal is to define expected requests and provide "stub" responses:</para>
+ <para>Client-side tests are for code using the
+ <classname>RestTemplate</classname>. The goal is to define expected
+ requests and provide "stub" responses:</para>
-<programlisting language="java">
+ <programlisting language="java">
RestTemplate restTemplate = new RestTemplate();
MockRestServiceServer mockServer = MockRestServiceServer.createServer(restTemplate);
@@ -2880,48 +2881,45 @@ mockServer.expect(requestTo("/greeting")).andRespond(withSuccess("Hello world",
mockServer.verify();
</programlisting>
- <para>In the above example, <classname>MockRestServiceServer</classname> --
- the central class for client-side REST tests -- configures the
+ <para>In the above example,
+ <classname>MockRestServiceServer</classname> -- the central class for
+ client-side REST tests -- configures the
<classname>RestTemplate</classname> with a custom
<interfacename>ClientHttpRequestFactory</interfacename> that asserts
- actual requests against expectations and returns "stub" responses.
- In this case we expect a single request to "/greeting" and want to return
+ actual requests against expectations and returns "stub" responses. In
+ this case we expect a single request to "/greeting" and want to return
a 200 response with "text/plain" content. We could define as many
additional requests and stub responses as necessary.</para>
- <para>Once expected requests and stub
- responses have been defined, the <classname>RestTemplate</classname> can
- be used in client-side code as usual. At the end of the tests
- <code>mockServer.verify()</code>
- can be used to verify that all expected requests were performed.</para>
+ <para>Once expected requests and stub responses have been defined, the
+ <classname>RestTemplate</classname> can be used in client-side code as
+ usual. At the end of the tests <code>mockServer.verify()</code> can be
+ used to verify that all expected requests were performed.</para>
<section xml:id="spring-mvc-test-client-static-imports">
<title>Static Imports</title>
- <para>Just like with server-side tests, the fluent API for client-side tests
- requires a few static imports. Those are easy to find by searching
- <emphasis>"MockRest*"</emphasis>. Eclipse users should add
- <classname>"MockRestRequestMatchers.*"</classname> and
- <classname>"MockRestResponseCreators.*"</classname>
- as "favorite static members" in the Eclipse preferences under
- <emphasis>Java -> Editor -> Content Assist -> Favorites</emphasis>.
- That allows using content assist after typing
- the first character of the static method name.
- Other IDEs (e.g. IntelliJ) may not require any additional
- configuration. Just check the support for code completion
+ <para>Just like with server-side tests, the fluent API for
+ client-side tests requires a few static imports. Those are easy to
+ find by searching <emphasis>"MockRest*"</emphasis>. Eclipse users
+ should add <classname>"MockRestRequestMatchers.*"</classname> and
+ <classname>"MockRestResponseCreators.*"</classname> as "favorite
+ static members" in the Eclipse preferences under <emphasis>Java
+ -> Editor -> Content Assist -> Favorites</emphasis>. That
+ allows using content assist after typing the first character of the
+ static method name. Other IDEs (e.g. IntelliJ) may not require any
+ additional configuration. Just check the support for code completion
on static members.</para>
</section>
<section xml:id="spring-mvc-test-client-resources">
<title>Further Examples of Client-side REST Tests</title>
- <para>Spring MVC Test's own tests include
- <link xl:href="https://github.com/SpringSource/spring-framework/tree/master/spring-test-mvc/src/test/java/org/springframework/test/web/client/samples">example tests</link>
- of client-side REST tests.</para>
+ <para>Spring MVC Test's own tests include <link
+ xl:href="https://github.com/SpringSource/spring-framework/tree/master/spring-test-mvc/src/test/java/org/springframework/test/web/client/samples">example
+ tests</link> of client-side REST tests.</para>
</section>
-
</section>
-
</section>
<section xml:id="testing-examples-petclinic"> | false |
Other | spring-projects | spring-framework | acf32726d75280a2ea7383aa96db9427cd5cc7f1.json | Add documentation for Spring MVC Test
Issue: SPR-9860, SPR-9886 | src/reference/docbook/mvc.xml | @@ -2358,6 +2358,15 @@ public String myHandleMethod(WebRequest webRequest, Model model) {
request.</para>
</section>
</section>
+
+ <section xml:id="mvc-ann-tests">
+ <title>Testing Controllers</title>
+
+ <para>The <filename>spring-test</filename> module offers first class support
+ for testing annotated controllers.
+ See <xref linkend="spring-mvc-test-framework"/>.</para>
+ </section>
+
</section>
<section xml:id="mvc-handlermapping"> | true |
Other | spring-projects | spring-framework | acf32726d75280a2ea7383aa96db9427cd5cc7f1.json | Add documentation for Spring MVC Test
Issue: SPR-9860, SPR-9886 | src/reference/docbook/new-in-3.2.xml | @@ -49,10 +49,7 @@
fluent API and without a servlet container. Server-side tests involve
use of the <classname>DispatcherServlet</classname> while client-side
REST tests rely on the <classname>RestTemplate</classname>.
- See the following presentation for more information before
- documentation is added:
- <link xl:href="https://github.com/rstoyanchev/spring-32-test-webapps">
- "Testing Web Applications with Spring 3.2"</link>.
+ See <xref linkend="spring-mvc-test-framework"/>.
</para>
</section> | true |
Other | spring-projects | spring-framework | acf32726d75280a2ea7383aa96db9427cd5cc7f1.json | Add documentation for Spring MVC Test
Issue: SPR-9860, SPR-9886 | src/reference/docbook/testing.xml | @@ -2399,6 +2399,531 @@ public class SimpleTest {
</section>
</section>
+ <section xml:id="spring-mvc-test-framework">
+ <title>Spring MVC Test Framework</title>
+
+ <sidebar xml:id="spring-mvc-test-origins">
+ <title>Standalone project</title>
+
+ <para>Before inclusion in Spring Framework 3.2, the Spring MVC Test
+ framework had already existed as a separate project on Github where
+ it grew and evolved through actual use, feedback, and the contribution of
+ many.</para>
+ <para>The standalone
+ <link xl:href="https://github.com/SpringSource/spring-test-mvc">spring-test-mvc project</link>
+ is still available on Github and can be used in conjunction with
+ Spring Framework 3.1.x. Applications upgrading to 3.2 should replace
+ the <filename>spring-test-mvc</filename> dependency with a dependency on
+ <filename>spring-test</filename>.</para>
+
+ <para>The <filename>spring-test</filename> module uses a
+ different package <classname>org.springframework.test.web</classname>
+ but otherwise is nearly identical with two exceptions.
+ One is support for features new in 3.2 (e.g. async web requests).
+ The other relates to the options
+ for creating a <classname>MockMvc</classname> instance. In Spring
+ Framework 3.2, this can only be done through the TestContext framework,
+ which provides caching benefits for the loaded configuration.</para>
+ </sidebar>
+
+ <para>The <emphasis>Spring MVC Test framework</emphasis> provides
+ first class JUnit support for testing client and server-side
+ Spring MVC code through a fluent API. Typically it loads
+ the actual Spring configuration through the
+ <emphasis>TestContext framework</emphasis> and always uses the
+ <classname>DispatcherServlet</classname> to process requests
+ thus approximating full integration tests without requiring
+ a running servlet container.</para>
+
+ <para>Client-side tests are
+ <classname>RestTemplate</classname>-based and allow tests for code
+ that relies on the <code>RestTemplate</code> without requiring a
+ running server to respond to the requests.
+ </para>
+
+ <section xml:id="spring-mvc-test-server">
+ <title>Server-Side Tests</title>
+
+ <para>Before Spring Framework 3.2, the most likely way to test a Spring MVC
+ controller was to write a unit test that instantiates the controller,
+ injects it with mock or stub dependencies, and then calls its methods
+ directly, using a <classname>MockHttpServletRequest</classname> and
+ <classname>MockHttpServletResponse</classname> where necessary.</para>
+ <para>Although this is pretty easy to do, controllers have many annotations,
+ and much remains not tested. Request mappings, data binding,
+ type conversion, and validation are just a few examples of what isn't tested.
+ Furthermore, there are other types of annotated methods
+ such as <interfacename>@InitBinder</interfacename>,
+ <interfacename>@ModelAttribute</interfacename>, and
+ <interfacename>@ExceptionHandler</interfacename> that get invoked as part
+ of request processing.</para>
+
+ <para>The idea behind Spring MVC Test is to be able to
+ re-write those controller tests by performing actual requests, and generating
+ responses, as they would be at runtime, along the way invoking controllers
+ through the Spring MVC <classname>DispatcherServlet</classname>. Controllers
+ can still be injected with mock dependencies, so tests can remain focused
+ on the web layer.</para>
+
+ <para>Spring MVC Test builds on the familiar "mock" implementations
+ of the Servlet API available in the <filename>spring-test</filename> module.
+ This allows performing requests and generating responses without
+ the need for running in a Servlet container. For the most part everything should
+ work as it does at runtime with the exception of JSP rendering, which is
+ not available outside a Servlet container. Furthermore,
+ if you are familiar with how the <classname>MockHttpServletResponse</classname>
+ works, you'll know that forwards and redirects are not actually executed.
+ Instead "forwarded" and "redirected" URLs are saved and can be asserted
+ in tests. This means if using JSPs, you can verify the JSP page
+ the request was forwarded to.</para>
+
+ <para>All other means of rendering including
+ <interfacename>@ResponseBody</interfacename> methods and
+ <interfacename>View</interfacename> types (besides JSPs) such as
+ Freemarker, Velocity, Thymeleaf, and others for rendering HTML,
+ JSON, XML, and so on should work as expected and the response will
+ contain the generated content.
+ </para>
+
+ <para>Below is an example of a test requesting account information in JSON format:</para>
+
+<programlisting language="java">import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
+
+@RunWith(SpringJUnit4ClassRunner.class)
+@WebAppConfiguration
+@ContextConfiguration("test-servlet-context.xml")
+public class ExampleTests {
+
+ @Autowired
+ private WebApplicationContext wac;
+
+ private MockMvc mockMvc;
+
+ @Before
+ public void setup() {
+ this.mockMvc = MockMvcBuilders.webAppContextSetup(this.wac).build();
+ }
+
+ @Test
+ public void getAccount() throws Exception {
+ this.mockMvc.perform(get("/accounts/1").accept("application/json;charset=UTF-8"))
+ .andExpect(status().isOk())
+ .andExpect(content().contentType("application/json"))
+ .andExpect(jsonPath("$.name").value("Lee");
+ }
+
+}</programlisting>
+
+ <para>The test relies on the <interfacename>WebApplicationContext</interfacename>
+ support of the <emphasis>TestContext framework</emphasis>. It loads Spring configuration from
+ an XML config file located in the same
+ package as the test class (also supports Java config) and injects
+ the created <interfacename>WebApplicationContext</interfacename>
+ into the test so a <classname>MockMvc</classname> instance can be
+ created with it.</para>
+
+ <para>The <classname>MockMvc</classname> is then
+ used to perform a request to <filename>"/accounts/1"</filename>
+ and verify the resulting
+ response status is 200, the response content type is
+ <filename>"application/json"</filename>, and response content
+ has a JSON property called "name" with the value "Lee".
+ JSON content is inspected with the help of Jayway's
+ <link xl:href="https://github.com/jayway/JsonPath">JsonPath project</link>.
+ There are lots of other options for verifying the
+ result of the performed request and those will be discussed later.</para>
+
+ <section xml:id="spring-mvc-test-server-static-imports">
+ <title>Static Imports</title>
+
+ <para>The fluent API in the example above requires a few static imports
+ such as <classname>MockMvcRequestBuilders.*</classname>,
+ <classname>MockMvcResultMatchers.*</classname>, and
+ <classname>MockMvcBuilders.*</classname>. An easy way to find
+ these classes is to search for types matching
+ <emphasis>"MockMvc*"</emphasis>.
+ If using Eclipse, be sure to add them as
+ "favorite static members" in the Eclipse preferences under
+ <emphasis>Java -> Editor -> Content Assist -> Favorites</emphasis>.
+ That will allow use of content assist after typing
+ the first character of the static method name.
+ Other IDEs (e.g. IntelliJ) may not require any additional
+ configuration. Just check the support for code completion
+ on static members.
+ </para>
+ </section>
+
+ <section xml:id="spring-mvc-test-server-setup-options">
+ <title>Setup Options</title>
+
+ <para>The goal of server-side test setup is to create
+ an instance of <classname>MockMvc</classname> that can be used
+ to perform requests. There are two main options.</para>
+
+ <para>The first option is to point to Spring MVC configuration
+ through the <emphasis>TestContext framework</emphasis>,
+ which loads the Spring configuration and injects a
+ <interfacename>WebApplicationContext</interfacename> into the
+ test to use to create a <classname>MockMvc</classname>:</para>
+
+<programlisting language="java">@RunWith(SpringJUnit4ClassRunner.class)
+@WebAppConfiguration
+@ContextConfiguration("my-servlet-context.xml")
+public class MyWebTests {
+
+ @Autowired
+ private WebApplicationContext wac;
+
+ private MockMvc mockMvc;
+
+ @Before
+ public void setup() {
+ this.mockMvc = MockMvcBuilders.webAppContextSetup(this.wac).build();
+ }
+
+ // ...
+
+}</programlisting>
+
+ <para>The second option is to simply register a controller
+ instance without loading any Spring configuration.
+ Instead basic Spring MVC configuration suitable for testing
+ annotated controllers is automatically created. The created
+ configuration is comparable to that of the MVC Java config
+ (and the MVC namespace) and can be customized to a degree
+ through builder-style methods:</para>
+
+<programlisting language="java">public class MyWebTests {
+
+ private MockMvc mockMvc;
+
+ @Before
+ public void setup() {
+ this.mockMvc = MockMvcBuilders.standaloneSetup(new AccountController()).build();
+ }
+
+ // ...
+
+}</programlisting>
+
+ <para>Which option should you use?</para>
+
+ <para>The <emphasis>"webAppContextSetup"</emphasis> loads
+ the actual Spring MVC configuration
+ resulting in a more complete integration test. Since the
+ <emphasis>TestContext framework</emphasis> caches the loaded
+ Spring configuration, it helps to keep tests running fast
+ even as more tests get added. Furthermore, you can inject mock
+ services into controllers through Spring configuration,
+ in order to remain focused on testing the web layer.
+ Here is an example of declaring a mock service with Mockito:</para>
+
+<programlisting language="xml">
+<bean id="accountService" class="org.mockito.Mockito" factory-method="mock">
+ <constructor-arg value="org.example.AccountService"/>
+</bean>
+</programlisting>
+
+ <para>Then you can inject the mock service into the test
+ in order set up and verify expectations:</para>
+
+<programlisting language="java">@RunWith(SpringJUnit4ClassRunner.class)
+@WebAppConfiguration
+@ContextConfiguration("test-servlet-context.xml")
+public class AccountTests {
+
+ @Autowired
+ private WebApplicationContext wac;
+
+ private MockMvc mockMvc;
+
+ @Autowired
+ private AccountService accountService;
+
+ // ...
+
+}</programlisting>
+
+ <para>The <emphasis>"standaloneSetup"</emphasis> on the other
+ hand is a little closer to a unit test. It tests one controller at a time,
+ the controller can be injected with mock dependencies manually,
+ and it doesn't involve loading Spring configuration.
+ Such tests are more focused in style and make it easier to see
+ which controller is being tested, whether any specific Spring MVC
+ configuration is required to work, and so on. The "standaloneSetup" is also
+ a very convenient way to write ad-hoc tests to verify some
+ behavior or to debug an issue.</para>
+
+ <para>Just like with integration vs unit testing, there is no right or
+ wrong answer. Using the "standaloneSetup" does imply the
+ need for some additional "webAppContextSetup" tests to verify the
+ Spring MVC configuration. Alternatively, you can decide write all
+ tests with "webAppContextSetup" and always test against actual
+ Spring MVC configuration.</para>
+ </section>
+
+ <section xml:id="spring-mvc-test-server-performing-requests">
+ <title>Performing Requests</title>
+
+ <para>To perform requests, use the appropriate HTTP
+ method and additional builder-style methods corresponding
+ to properties of <classname>MockHttpServletRequest</classname>.
+ For example:</para>
+
+<programlisting language="java">
+mockMvc.perform(post("/hotels/{id}", 42).accept(MediaType.APPLICATION_JSON));
+</programlisting>
+
+ <para>In addition to all the HTTP methods, you can also perform file
+ upload requests, which internally creates an instance of
+ <classname>MockMultipartHttpServletRequest</classname>:</para>
+
+<programlisting language="java">
+mockMvc.perform(fileUpload("/doc").file("a1", "ABC".getBytes("UTF-8")));
+</programlisting>
+
+ <para>Query string parameters can be specified in the URI template:</para>
+
+<programlisting language="java">
+mockMvc.perform(get("/hotels?foo={foo}", "bar"));
+</programlisting>
+
+ <para>Or by adding Servlet request parameters:</para>
+
+<programlisting language="java">
+mockMvc.perform(get("/hotels").param("foo", "bar"));
+</programlisting>
+
+ <para>If application code relies on Servlet request parameters, and
+ doesn't check the query string, as is most often the case,
+ then it doesn't matter how parameters are added. Keep in mind
+ though that parameters provided in the URI template will be decoded
+ while parameters provided through the <code>param(...)</code>
+ method are expected to be decoded.</para>
+
+ <para>In most cases it's preferable to leave out the context path and
+ the servlet path from the request URI. If you must test with the full
+ request URI, be sure to set the contextPath and servletPath
+ accordingly so that request mappings will work:</para>
+
+<programlisting language="java">
+mockMvc.perform(get("/app/main/hotels/{id}").contextPath("/app").servletPath("/main"))
+</programlisting>
+
+ <para>Looking at the above example, it would be cumbersome to set
+ the contextPath and servletPath with every peformed request.
+ That's why you can define default request
+ properties when building the <classname>MockMvc</classname>:</para>
+
+<programlisting language="java">
+public class MyWebTests {
+
+ private MockMvc mockMvc;
+
+ @Before
+ public void setup() {
+ mockMvc = standaloneSetup(new AccountController())
+ .defaultRequest(get("/")
+ .contextPath("/app").servletPath("/main")
+ .accept(MediaType.APPLICATION_JSON).build();
+ }
+
+}</programlisting>
+
+ <para>The above properties will apply to every request performed through
+ the <classname>MockMvc</classname>. If the same property is also specified
+ on a given request, it will override the default value. That is why, the
+ HTTP method and URI don't matter, when setting default request properties,
+ since they must be specified on every request.</para>
+
+ </section>
+
+ <section xml:id="spring-mvc-test-server-defining-expectations">
+ <title>Defining Expectations</title>
+
+ <para>Expectations can be defined by appending one or more
+ <code>.andExpect(..)</code> after call to perform the request:</para>
+
+<programlisting language="java">
+mockMvc.perform(get("/accounts/1")).andExpect(status().isOk());
+</programlisting>
+
+ <para><code>MockMvcResultMatchers.*</code> defines a number of static
+ members, some of which return types with additional methods, for
+ asserting the result of the performed request. The assertions
+ fall in two general categories.</para>
+
+ <para>The first category of assertions verify properties of the
+ response, i.e the response status, headers, and content.
+ Those are the most important things to test for.</para>
+
+ <para>The second category of assertions go beyond the response, and allow
+ inspecting Spring MVC specific constructs such as which controller
+ method processed the request, whether an exception was raised and handled,
+ what the content of the model is, what view was selected, what flash
+ attributes were added, and so on. It is also possible to
+ verify Servlet specific constructs such as request and session attributes.
+ The following test asserts that binding/validation failed:
+ </para>
+
+<programlisting language="java">
+mockMvc.perform(post("/persons"))
+ .andExpect(status().isOk())
+ .andExpect(model().attributeHasErrors("person"));
+</programlisting>
+
+ <para>Many times when writing tests, it's useful to dump the result
+ of the performed request. This can be done as follows:</para>
+
+<programlisting language="java">
+mockMvc.perform(post("/persons"))
+ .andDo(print())
+ .andExpect(status().isOk())
+ .andExpect(model().attributeHasErrors("person"));
+</programlisting>
+
+ <para>where <code>print()</code> is a static import from
+ <code>MockMvcResultHandlers</code>. As long as request processing
+ does cause an unhandled exception, the <code>print()</code>
+ method will print all the available result data to <code>System.out</code>.</para>
+
+ <para>In some cases, you may want to get direct access to the result and
+ verify something that cannot be verified otherwise. This can be done by
+ appending <code>.andReturn()</code> at the end after all expectations:</para>
+
+<programlisting language="java">
+MvcResult mvcResult = mockMvc.perform(post("/persons")).andExpect(status().isOk()).andReturn();
+// ...
+</programlisting>
+
+ <para>When all tests repeat the same expectations, you can define
+ the common expectations once when building the
+ <classname>MockMvc</classname>:</para>
+
+<programlisting language="java">
+standaloneSetup(new SimpleController())
+ .alwaysExpect(status().isOk())
+ .alwaysExpect(content().contentType("application/json;charset=UTF-8"))
+ .build()
+</programlisting>
+
+ <para>Note that the expectation is <emphasis>always</emphasis> applied
+ and cannot be overridden without creating a separate
+ <classname>MockMvc</classname> instance. </para>
+
+ <para>When JSON response content contains hypermedia links created with
+ <link xl:href="https://github.com/SpringSource/spring-hateoas">Spring HATEOAS</link>,
+ the resulting links can be verified:</para>
+
+<programlisting language="java">
+mockMvc.perform(get("/people").accept(MediaType.APPLICATION_JSON))
+ .andExpect(jsonPath("$.links[?(@.rel == 'self')].href").value("http://localhost:8080/people"));
+</programlisting>
+
+ <para>When XML response content contains hypermedia links created with
+ <link xl:href="https://github.com/SpringSource/spring-hateoas">Spring HATEOAS</link>,
+ the resulting links can be verified:</para>
+
+<programlisting language="java">
+Map<String, String> ns = Collections.singletonMap("ns", "http://www.w3.org/2005/Atom");
+mockMvc.perform(get("/handle").accept(MediaType.APPLICATION_XML))
+ .andExpect(xpath("/person/ns:link[@rel='self']/@href", ns).string("http://localhost:8080/people"));
+</programlisting>
+
+ </section>
+
+ <section xml:id="spring-mvc-test-server-filters">
+ <title>Filter Registrations</title>
+
+ <para>When setting up a <classname>MockMvc</classname>, you can
+ register one or more <interfacename>Filter</interfacename> instances:</para>
+
+<programlisting language="java">
+mockMvc = standaloneSetup(new PersonController()).addFilters(new CharacterEncodingFilter()).build();
+</programlisting>
+
+ <para>Registered filters will be invoked through
+ <classname>MockFilterChain</classname> from
+ <filename>spring-test</filename> and the last filter will delegates to
+ the <classname>DispatcherServlet</classname>.</para>
+
+ </section>
+
+ <section xml:id="spring-mvc-test-server-resources">
+ <title>Further Server-Side Test Examples</title>
+
+ <para>The framework's own tests include
+ <link xl:href="https://github.com/SpringSource/spring-framework/tree/master/spring-test-mvc/src/test/java/org/springframework/test/web/servlet/samples">many sample tests</link>
+ intended to demonstrate how to use Spring MVC Test.
+ Browse these examples for further ideas. Also the
+ <link xl:href="https://github.com/SpringSource/spring-mvc-showcase">spring-mvc-showcase</link>
+ has full test coverage based on Spring MVC Test.</para>
+ </section>
+
+ </section>
+
+ <section xml:id="spring-mvc-test-client">
+ <title>Client-Side REST Tests</title>
+
+ <para>Client-side tests are for code using the <classname>RestTemplate</classname>.
+ The goal is to define expected requests and provide "stub" responses:</para>
+
+<programlisting language="java">
+RestTemplate restTemplate = new RestTemplate();
+
+MockRestServiceServer mockServer = MockRestServiceServer.createServer(restTemplate);
+mockServer.expect(requestTo("/greeting")).andRespond(withSuccess("Hello world", "text/plain"));
+
+// use RestTemplate ...
+
+mockServer.verify();
+</programlisting>
+
+ <para>In the above example, <classname>MockRestServiceServer</classname> --
+ the central class for client-side REST tests -- configures the
+ <classname>RestTemplate</classname> with a custom
+ <interfacename>ClientHttpRequestFactory</interfacename> that asserts
+ actual requests against expectations and returns "stub" responses.
+ In this case we expect a single request to "/greeting" and want to return
+ a 200 response with "text/plain" content. We could define as many
+ additional requests and stub responses as necessary.</para>
+
+ <para>Once expected requests and stub
+ responses have been defined, the <classname>RestTemplate</classname> can
+ be used in client-side code as usual. At the end of the tests
+ <code>mockServer.verify()</code>
+ can be used to verify that all expected requests were performed.</para>
+
+ <section xml:id="spring-mvc-test-client-static-imports">
+ <title>Static Imports</title>
+
+ <para>Just like with server-side tests, the fluent API for client-side tests
+ requires a few static imports. Those are easy to find by searching
+ <emphasis>"MockRest*"</emphasis>. Eclipse users should add
+ <classname>"MockRestRequestMatchers.*"</classname> and
+ <classname>"MockRestResponseCreators.*"</classname>
+ as "favorite static members" in the Eclipse preferences under
+ <emphasis>Java -> Editor -> Content Assist -> Favorites</emphasis>.
+ That allows using content assist after typing
+ the first character of the static method name.
+ Other IDEs (e.g. IntelliJ) may not require any additional
+ configuration. Just check the support for code completion
+ on static members.</para>
+ </section>
+
+ <section xml:id="spring-mvc-test-client-resources">
+ <title>Further Examples of Client-side REST Tests</title>
+
+ <para>Spring MVC Test's own tests include
+ <link xl:href="https://github.com/SpringSource/spring-framework/tree/master/spring-test-mvc/src/test/java/org/springframework/test/web/client/samples">example tests</link>
+ of client-side REST tests.</para>
+ </section>
+
+ </section>
+
+ </section>
+
<section xml:id="testing-examples-petclinic">
<title>PetClinic Example</title>
| true |
Other | spring-projects | spring-framework | 4be2d15950a978979d2b2e10cd273d6e9b8c1a53.json | Reformat the Testing chapter
Reformatted the Testing chapter in preparation for upcoming changes. | src/reference/docbook/testing.xml | @@ -1,13 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
-<chapter xml:id="testing"
- xmlns="http://docbook.org/ns/docbook" version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink"
- xmlns:xi="http://www.w3.org/2001/XInclude"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="
- http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
- http://www.w3.org/1999/xlink http://www.docbook.org/xml/5.0/xsd/xlink.xsd">
-
+<chapter version="5.0"
+ xsi:schemaLocation="http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd http://www.w3.org/1999/xlink http://www.docbook.org/xml/5.0/xsd/xlink.xsd"
+ xml:id="testing" xmlns="http://docbook.org/ns/docbook"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns:xs="http://www.w3.org/2001/XMLSchema"
+ xmlns:xl="http://www.w3.org/1999/xlink"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns:ns="http://docbook.org/ns/docbook">
<title>Testing</title>
<section xml:id="testing-introduction">
@@ -85,8 +84,8 @@
usage with Spring's Web MVC framework, which are useful for testing
web contexts and controllers. These mock objects are generally more
convenient to use than dynamic mock objects such as <link
- xl:href="http://www.easymock.org">EasyMock</link> or existing
- Servlet API mock objects such as <link
+ xl:href="http://www.easymock.org">EasyMock</link> or existing Servlet
+ API mock objects such as <link
xl:href="http://www.mockobjects.com">MockObjects</link>.</para>
</section>
@@ -2558,28 +2557,27 @@ public class HibernateClinicTests extends AbstractClinicTests { }
<listitem>
<para><link
- xl:href="http://www.mockobjects.com/">MockObjects.com</link>: Web
- site dedicated to mock objects, a technique for improving the design
- of code within test-driven development.</para>
+ xl:href="http://www.mockobjects.com/">MockObjects.com</link>: Web site
+ dedicated to mock objects, a technique for improving the design of
+ code within test-driven development.</para>
</listitem>
<listitem>
- <para><link
- xl:href="http://en.wikipedia.org/wiki/Mock_Object">"Mock
+ <para><link xl:href="http://en.wikipedia.org/wiki/Mock_Object">"Mock
Objects"</link>: Article in Wikipedia.</para>
</listitem>
<listitem>
- <para><link xl:href="http://www.easymock.org/">EasyMock</link>:
- Java library <quote> <emphasis>that provides Mock Objects for
- interfaces (and objects through the class extension) by generating
- them on the fly using Java's proxy mechanism.</emphasis> </quote> Used
- by the Spring Framework in its test suite.</para>
+ <para><link xl:href="http://www.easymock.org/">EasyMock</link>: Java
+ library <quote> <emphasis>that provides Mock Objects for interfaces
+ (and objects through the class extension) by generating them on the
+ fly using Java's proxy mechanism.</emphasis> </quote> Used by the
+ Spring Framework in its test suite.</para>
</listitem>
<listitem>
- <para><link xl:href="http://www.jmock.org/">JMock</link>: Library
- that supports test-driven development of Java code with mock
+ <para><link xl:href="http://www.jmock.org/">JMock</link>: Library that
+ supports test-driven development of Java code with mock
objects.</para>
</listitem>
| false |
Other | spring-projects | spring-framework | be7b07f8327f1dc3b3fd78eb2041892114ba99a2.json | Make DeferredResult extensible
Previously it was cumbersome to associate data or behavior to a
DeferredResult because it was marked as final and had no extension
points.
Now DeferredResult is non-final which allows subclasses to associate
additional data and behavior to it.
Issue: SPR-10059 | spring-web/src/main/java/org/springframework/web/context/request/async/DeferredResult.java | @@ -15,6 +15,7 @@
*/
package org.springframework.web.context.request.async;
+import java.util.PriorityQueue;
import java.util.concurrent.Callable;
import org.apache.commons.logging.Log;
@@ -28,10 +29,24 @@
* concurrently on behalf of the application, with a {@code DeferredResult} the
* application can produce the result from a thread of its choice.
*
+ * <p>Subclasses can extend this class to easily associate additional data or
+ * behavior with the {@link DeferredResult}. For example, one might want to
+ * associate the user used to create the {@link DeferredResult} by extending the
+ * class and adding an addition property for the user. In this way, the user
+ * could easily be accessed later without the need to use a data structure to do
+ * the mapping.
+ *
+ * <p>An example of associating additional behavior to this class might be
+ * realized by extending the class to implement an additional interface. For
+ * example, one might want to implement a {@link Comparable} so that when the
+ * {@link DeferredResult} is added to a {@link PriorityQueue} it is handled in
+ * the correct order.
+ *
* @author Rossen Stoyanchev
+ * @author Rob Winch
* @since 3.2
*/
-public final class DeferredResult<T> {
+public class DeferredResult<T> {
private static final Log logger = LogFactory.getLog(DeferredResult.class);
@@ -88,14 +103,14 @@ public DeferredResult(Long timeout, Object timeoutResult) {
* timeout result was provided to the constructor. The request may also
* expire due to a timeout or network error.
*/
- public boolean isSetOrExpired() {
+ public final boolean isSetOrExpired() {
return ((this.result != RESULT_NONE) || this.expired);
}
/**
* Return the configured timeout value in milliseconds.
*/
- Long getTimeoutValue() {
+ final Long getTimeoutValue() {
return this.timeout;
}
@@ -126,7 +141,7 @@ public void onCompletion(Runnable callback) {
* @param resultHandler the handler
* @see {@link DeferredResultProcessingInterceptor}
*/
- public void setResultHandler(DeferredResultHandler resultHandler) {
+ public final void setResultHandler(DeferredResultHandler resultHandler) {
Assert.notNull(resultHandler, "DeferredResultHandler is required");
synchronized (this) {
this.resultHandler = resultHandler;
@@ -179,7 +194,7 @@ public boolean setErrorResult(Object result) {
return setResultInternal(result);
}
- DeferredResultProcessingInterceptor getInterceptor() {
+ final DeferredResultProcessingInterceptor getInterceptor() {
return new DeferredResultProcessingInterceptorAdapter() {
@Override | false |
Other | spring-projects | spring-framework | 809d62e31860c5e0574814a873b76aa0519d0b3e.json | Add buildSrc to generated eclipse project
Post process the generated 'spring' eclipse project to include the
buildSrc/src/main/groovy folder. | build.gradle | @@ -660,6 +660,11 @@ configure(rootProject) {
apply plugin: "groovy"
apply from: "${gradleScriptDir}/jdiff.gradle"
+ eclipse.classpath.file.whenMerged { classpath ->
+ classpath.entries.add(0, new org.gradle.plugins.ide.eclipse.model.SourceFolder(
+ "buildSrc/src/main/groovy", null))
+ }
+
reference {
sourceDir = file("src/reference/docbook")
pdfFilename = "spring-framework-reference.pdf" | false |
Other | spring-projects | spring-framework | 42bbcc322021e9d1a57cc34053f6f659fc90839e.json | Move Merge plugin into a build package structure | build.gradle | @@ -46,7 +46,7 @@ configure(allprojects) {
}
configure(subprojects) { subproject ->
- apply plugin: MergePlugin
+ apply plugin: "merge"
apply from: "${gradleScriptDir}/publish-maven.gradle"
jar { | true |
Other | spring-projects | spring-framework | 42bbcc322021e9d1a57cc34053f6f659fc90839e.json | Move Merge plugin into a build package structure | buildSrc/src/main/groovy/org/springframework/build/gradle/merge/MergePlugin.groovy | @@ -1,3 +1,21 @@
+/*
+ * 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.build.gradle.merge
+
import org.gradle.api.*
import org.gradle.api.artifacts.Configuration
import org.gradle.api.artifacts.ProjectDependency; | true |
Other | spring-projects | spring-framework | 42bbcc322021e9d1a57cc34053f6f659fc90839e.json | Move Merge plugin into a build package structure | buildSrc/src/main/resources/META-INF/gradle-plugins/merge.properties | @@ -0,0 +1 @@
+implementation-class=org.springframework.build.gradle.merge.MergePlugin | true |
Other | spring-projects | spring-framework | 9e790829d9902736cf476fa9a19179f05309d316.json | Upgrade reference plugin to version 0.2.3
Upgrade to the latest reference plugin, providing slightly refined
titlepage and admon graphics. | build.gradle | @@ -4,7 +4,7 @@ buildscript {
}
dependencies {
classpath("org.springframework.build.gradle:propdeps-plugin:0.0.1")
- classpath("org.springframework.build.gradle:docbook-reference-plugin:0.2.2")
+ classpath("org.springframework.build.gradle:docbook-reference-plugin:0.2.3")
}
}
| false |
Other | spring-projects | spring-framework | 4551cfcdfcc0957e449ea0d9a02606012b6e742e.json | Remove superfluous exclusions from Gradle build
Remove several dependency exclusions from the Gradle build that are
no longer required and were not present in Spring 3.1. | build.gradle | @@ -39,11 +39,9 @@ configure(allprojects) {
}
dependencies {
+ testCompile("junit:junit:${junitVersion}")
testCompile("org.hamcrest:hamcrest-all:1.3")
testCompile("org.easymock:easymock:${easymockVersion}")
- testCompile("junit:junit:${junitVersion}") {
- exclude group: "org.hamcrest", module: "hamcrest-core"
- }
}
}
@@ -157,9 +155,7 @@ project("spring-core") {
compile(files(asmRepackJar))
compile("commons-logging:commons-logging:1.1.1")
optional("org.aspectj:aspectjweaver:${aspectjVersion}")
- optional("net.sf.jopt-simple:jopt-simple:3.0") {
- exclude group: "org.apache.ant", module: "ant"
- }
+ optional("net.sf.jopt-simple:jopt-simple:3.0")
optional("log4j:log4j:1.2.17")
testCompile("xmlunit:xmlunit:1.2")
testCompile("org.codehaus.woodstox:wstx-asl:3.2.7")
@@ -247,9 +243,7 @@ project("spring-context") {
optional("org.jruby:jruby:1.6.5.1")
optional("joda-time:joda-time:2.1")
optional("org.slf4j:slf4j-api:${slf4jVersion}")
- optional("org.hibernate:hibernate-validator:4.3.0.Final") {
- exclude group: "org.slf4j", module: "slf4j-api"
- }
+ optional("org.hibernate:hibernate-validator:4.3.0.Final")
optional("org.aspectj:aspectjweaver:${aspectjVersion}")
optional("org.apache.geronimo.specs:geronimo-jta_1.1_spec:1.1")
testCompile("commons-dbcp:commons-dbcp:1.2.2")
@@ -350,15 +344,10 @@ project("spring-context-support") {
optional("velocity:velocity:1.5")
optional("org.freemarker:freemarker:2.3.15")
optional("com.lowagie:itext:2.1.7")
- optional("jasperreports:jasperreports:2.0.5") {
- transitive = false
- exclude group: "bouncycastle", module: "bctsp-jdk14"
- }
+ optional("jasperreports:jasperreports:2.0.5")
optional("org.slf4j:slf4j-api:${slf4jVersion}")
provided("javax.activation:activation:1.1")
- testCompile("org.apache.poi:poi:3.0.2-FINAL") {
- exclude group: "log4j", module: "log4j"
- }
+ testCompile("org.apache.poi:poi:3.0.2-FINAL")
testCompile("commons-beanutils:commons-beanutils:1.8.0") // for Velocity/JasperReports
testCompile("commons-digester:commons-digester:1.8.1") // for Velocity/JasperReports
testCompile("hsqldb:hsqldb:${hsqldbVersion}")
@@ -437,9 +426,7 @@ project("spring-orm") {
optional(project(":spring-context"))
compile(project(":spring-tx"))
compile(project(":spring-jdbc"))
- optional(project(":spring-web")) {
- exclude group: "javax.persistence", module: "persistence-api"
- }
+ optional(project(":spring-web"))
}
}
@@ -453,9 +440,7 @@ project("spring-orm-hibernate4") {
compile(project(":spring-jdbc"))
optional("org.hibernate:hibernate-core:4.1.0.Final")
optional("org.hibernate:hibernate-entitymanager:4.1.0.Final")
- optional(project(":spring-web")) {
- exclude group: "javax.persistence", module: "persistence-api"
- }
+ optional(project(":spring-web"))
optional("javax.servlet:servlet-api:2.5")
}
}
@@ -479,7 +464,6 @@ project("spring-webmvc") {
optional("org.apache.poi:poi:3.0.2-FINAL")
optional("com.lowagie:itext:2.1.7")
optional("jasperreports:jasperreports:2.0.5") {
- transitive = false
exclude group: "xml-apis", module: "xml-apis"
}
optional("rome:rome:1.0")
@@ -579,15 +563,8 @@ project("spring-test") {
optional(project(":spring-web"))
optional(project(":spring-webmvc"))
optional(project(":spring-webmvc-portlet"), )
- optional("junit:junit:${junitVersion}") {
- // We already have hamcrest-all as a global testCompile dependency.
- exclude group: "org.hamcrest", module: "hamcrest-core"
- }
- optional("org.testng:testng:6.5.2") {
- exclude group: "junit", module: "junit"
- // We already have hamcrest-all as a global testCompile dependency.
- exclude group: "org.hamcrest", module: "hamcrest-core"
- }
+ optional("junit:junit:${junitVersion}")
+ optional("org.testng:testng:6.5.2")
optional("javax.servlet:servlet-api:2.5")
optional("javax.servlet.jsp:jsp-api:2.1")
optional("javax.portlet:portlet-api:2.0") | false |
Other | spring-projects | spring-framework | 0751b2cbeb96697bd377578771e9c7b29b94658a.json | Convert Gradle build to use new propdeps-plugin
Replace existing 'optional' and 'provided' Spring specific build
extensions with a new Gradle propdeps-plugin. Optional and Provided
dependencies are now defined use dependency configurations.
The new plugin does not currently support the notion of optional
runtime dependencies. All optional dependencies are implicitly
part of the 'compile' scope. This is an intentional design decision
that aims to keep both the plugin and the build simple. Since optional
dependencies are non-transitive this restriction should not cause
any real problems for existing users. The only existing dependency
affected is 'commons-io' in the 'spring-beans' project, however, this
was an optional compile scope dependency in the previous Spring 3.1
release.
Both provided and optional dependencies are no longer exported from
generated eclipse .classpath files. This fixes several tests that
would previously fail when running within eclipse. The servlet-api
specific elements of ide.gradle are also no longer required.
Issue: SPR-9656, SPR-10070 | build.gradle | @@ -3,6 +3,7 @@ buildscript {
maven { url "http://repo.springsource.org/plugins-release" }
}
dependencies {
+ classpath("org.springframework.build.gradle:propdeps-plugin:0.0.1")
classpath("org.springframework.build.gradle:docbook-reference-plugin:0.2.2")
}
}
@@ -15,9 +16,10 @@ configure(allprojects) {
ext.slf4jVersion = "1.6.1"
ext.gradleScriptDir = "${rootProject.projectDir}/gradle"
+ apply plugin: "propdeps"
apply plugin: "java"
- apply plugin: "eclipse"
- apply plugin: "idea"
+ apply plugin: "propdeps-eclipse"
+ apply plugin: "propdeps-idea"
apply from: "${gradleScriptDir}/ide.gradle"
group = "org.springframework"
@@ -39,13 +41,7 @@ configure(allprojects) {
dependencies {
testCompile("org.hamcrest:hamcrest-all:1.3")
testCompile("org.easymock:easymock:${easymockVersion}")
- }
-}
-
-configure(subprojects - project(":spring-test")) {
- dependencies {
testCompile("junit:junit:${junitVersion}") {
- // We already have hamcrest-all as a global testCompile dependency.
exclude group: "org.hamcrest", module: "hamcrest-core"
}
}
@@ -160,12 +156,11 @@ project("spring-core") {
compile(files(asmRepackJar))
compile("commons-logging:commons-logging:1.1.1")
- compile("org.aspectj:aspectjweaver:${aspectjVersion}", optional)
- compile("net.sf.jopt-simple:jopt-simple:3.0") { dep ->
- optional dep
+ optional("org.aspectj:aspectjweaver:${aspectjVersion}")
+ optional("net.sf.jopt-simple:jopt-simple:3.0") {
exclude group: "org.apache.ant", module: "ant"
}
- compile("log4j:log4j:1.2.17", optional)
+ optional("log4j:log4j:1.2.17")
testCompile("xmlunit:xmlunit:1.2")
testCompile("org.codehaus.woodstox:wstx-asl:3.2.7")
}
@@ -188,8 +183,9 @@ project("spring-beans") {
dependencies {
compile(project(":spring-core"))
compile(files(project(":spring-core").cglibRepackJar))
- compile("javax.el:el-api:1.0", provided)
- compile("javax.inject:javax.inject:1", provided)
+ provided("javax.el:el-api:1.0")
+ provided("javax.inject:javax.inject:1")
+ testCompile("log4j:log4j:1.2.17")
}
}
@@ -200,9 +196,9 @@ project("spring-aop") {
compile(files(project(":spring-core").cglibRepackJar))
compile(project(":spring-beans"))
compile("aopalliance:aopalliance:1.0")
- compile("com.jamonapi:jamon:2.4", optional)
- compile("commons-pool:commons-pool:1.5.3", optional)
- compile("org.aspectj:aspectjweaver:${aspectjVersion}", optional)
+ optional("com.jamonapi:jamon:2.4")
+ optional("commons-pool:commons-pool:1.5.3")
+ optional("org.aspectj:aspectjweaver:${aspectjVersion}")
}
}
@@ -227,35 +223,35 @@ project("spring-instrument") {
project("spring-instrument-tomcat") {
description = "Spring Instrument Tomcat"
dependencies {
- compile("org.apache.tomcat:catalina:6.0.16", provided)
+ provided("org.apache.tomcat:catalina:6.0.16")
}
}
project("spring-context") {
description = "Spring Context"
dependencies {
- compile(project(":spring-instrument"), optional)
+ optional(project(":spring-instrument"))
compile(project(":spring-aop"))
compile(project(":spring-beans"))
compile(project(":spring-expression"))
compile(project(":spring-core"))
compile(files(project(":spring-core").cglibRepackJar))
- compile("backport-util-concurrent:backport-util-concurrent:3.0", optional)
- compile("javax.ejb:ejb-api:3.0", optional)
- compile("javax.inject:javax.inject:1", optional)
- compile("org.apache.geronimo.specs:geronimo-jms_1.1_spec:1.1", optional)
- compile("javax.persistence:persistence-api:1.0", optional)
- compile("javax.validation:validation-api:1.0.0.GA", optional)
- compile("org.beanshell:bsh:2.0b4", optional)
- compile("org.codehaus.groovy:groovy-all:1.8.8", optional)
- compile("org.jruby:jruby:1.6.5.1", optional)
- compile("joda-time:joda-time:2.1", optional)
- compile("org.slf4j:slf4j-api:${slf4jVersion}", optional)
- compile("org.hibernate:hibernate-validator:4.3.0.Final") { dep ->
- optional dep
+ optional("backport-util-concurrent:backport-util-concurrent:3.0")
+ optional("javax.ejb:ejb-api:3.0")
+ optional("javax.inject:javax.inject:1")
+ optional("org.apache.geronimo.specs:geronimo-jms_1.1_spec:1.1")
+ optional("javax.persistence:persistence-api:1.0")
+ optional("javax.validation:validation-api:1.0.0.GA")
+ optional("org.beanshell:bsh:2.0b4")
+ optional("org.codehaus.groovy:groovy-all:1.8.8")
+ optional("org.jruby:jruby:1.6.5.1")
+ optional("joda-time:joda-time:2.1")
+ optional("org.slf4j:slf4j-api:${slf4jVersion}")
+ optional("org.hibernate:hibernate-validator:4.3.0.Final") {
exclude group: "org.slf4j", module: "slf4j-api"
}
- compile("org.aspectj:aspectjweaver:${aspectjVersion}", optional)
+ optional("org.aspectj:aspectjweaver:${aspectjVersion}")
+ optional("org.apache.geronimo.specs:geronimo-jta_1.1_spec:1.1")
testCompile("commons-dbcp:commons-dbcp:1.2.2")
testCompile("javax.inject:com.springsource.org.atinject.tck:1.0.0")
}
@@ -268,15 +264,18 @@ project("spring-context") {
project("spring-tx") {
description = "Spring Transaction"
dependencies {
- compile(project(":spring-context"), optional) // for JCA, @EnableTransactionManagement
- compile(project(":spring-aop"), optional)
+ optional(project(":spring-context")) // for JCA, @EnableTransactionManagement
+ optional(project(":spring-aop"))
compile(project(":spring-beans"))
compile(project(":spring-core"))
compile("aopalliance:aopalliance:1.0")
- compile("com.ibm.websphere:uow:6.0.2.17", provided)
- compile("javax.resource:connector-api:1.5", optional)
- compile("org.apache.geronimo.specs:geronimo-jta_1.1_spec:1.1", optional)
- testCompile("org.easymock:easymockclassextension:${easymockVersion}")
+ provided("com.ibm.websphere:uow:6.0.2.17")
+ optional("javax.resource:connector-api:1.5")
+ optional("org.apache.geronimo.specs:geronimo-jta_1.1_spec:1.1")
+ optional("javax.ejb:ejb-api:3.0")
+ testCompile "org.easymock:easymockclassextension:${easymockVersion}"
+ testCompile("javax.persistence:persistence-api:1.0")
+ testCompile("org.aspectj:aspectjweaver:${aspectjVersion}")
}
}
@@ -286,13 +285,13 @@ project("spring-oxm") {
dependencies {
compile(project(":spring-beans"))
compile(project(":spring-core"))
- compile(project(":spring-context"), optional) // for Jaxb2Marshaller
+ optional(project(":spring-context")) // for Jaxb2Marshaller
compile("commons-lang:commons-lang:2.5")
- compile("com.thoughtworks.xstream:xstream:1.3.1", optional)
- compile("com.sun.xml.bind:jaxb-impl:2.1.7", optional)
- compile("org.jibx:jibx-run:1.2.3", optional)
- compile("org.apache.xmlbeans:xmlbeans:2.4.0", optional)
- compile("org.codehaus.castor:castor-xml:1.3.2", optional)
+ optional("com.thoughtworks.xstream:xstream:1.3.1")
+ optional("com.sun.xml.bind:jaxb-impl:2.1.7")
+ optional("org.jibx:jibx-run:1.2.3")
+ optional("org.apache.xmlbeans:xmlbeans:2.4.0")
+ optional("org.codehaus.castor:castor-xml:1.3.2")
testCompile("org.codehaus.jettison:jettison:1.0.1")
testCompile("xmlunit:xmlunit:1.2")
testCompile("xmlpull:xmlpull:1.1.3.4a")
@@ -310,9 +309,12 @@ project("spring-jms") {
compile(project(":spring-aop"))
compile(project(":spring-context"))
compile(project(":spring-tx"))
- compile(project(":spring-oxm"), optional)
+ optional(project(":spring-oxm"))
compile("aopalliance:aopalliance:1.0")
- compile("org.codehaus.jackson:jackson-mapper-asl:1.4.2", optional)
+ optional("org.codehaus.jackson:jackson-mapper-asl:1.4.2")
+ provided("org.apache.geronimo.specs:geronimo-jms_1.1_spec:1.1")
+ optional("org.apache.geronimo.specs:geronimo-jta_1.1_spec:1.1")
+ optional("javax.resource:connector-api:1.5")
}
}
@@ -321,14 +323,14 @@ project("spring-jdbc") {
dependencies {
compile(project(":spring-core"))
compile(project(":spring-beans"))
- compile(project(":spring-context"), optional) // for JndiDataSourceLookup
+ optional(project(":spring-context")) // for JndiDataSourceLookup
compile(project(":spring-tx"))
- compile("c3p0:c3p0:0.9.1.2", optional)
- compile("hsqldb:hsqldb:${hsqldbVersion}", optional)
- compile("com.h2database:h2:1.0.71", optional)
- compile("org.apache.derby:derby:10.5.3.0_1", optional)
- compile("org.apache.derby:derbyclient:10.5.3.0_1", optional)
- compile("org.apache.geronimo.specs:geronimo-jta_1.1_spec:1.1", optional)
+ optional("c3p0:c3p0:0.9.1.2")
+ optional("hsqldb:hsqldb:${hsqldbVersion}")
+ optional("com.h2database:h2:1.0.71")
+ optional("org.apache.derby:derby:10.5.3.0_1")
+ optional("org.apache.derby:derbyclient:10.5.3.0_1")
+ optional("org.apache.geronimo.specs:geronimo-jta_1.1_spec:1.1")
}
}
@@ -338,20 +340,22 @@ project("spring-context-support") {
compile(project(":spring-core"))
compile(project(":spring-beans"))
compile(project(":spring-context"))
- compile(project(":spring-jdbc"), optional) // for Quartz support
- compile(project(":spring-tx"), optional) // for Quartz support
- compile("javax.mail:mail:1.4", optional)
- compile("javax.cache:cache-api:0.5", optional)
- compile("net.sf.ehcache:ehcache-core:2.0.0", optional)
- compile("opensymphony:quartz:1.6.2", optional)
- compile("org.codehaus.fabric3.api:commonj:1.1.0", optional)
- compile("velocity:velocity:1.5", optional)
- compile("org.freemarker:freemarker:2.3.15", optional)
- compile("com.lowagie:itext:2.1.7", optional)
- compile("jasperreports:jasperreports:2.0.5") { dep ->
- optional dep
+ optional(project(":spring-jdbc")) // for Quartz support
+ optional(project(":spring-tx")) // for Quartz support
+ optional("javax.mail:mail:1.4")
+ optional("javax.cache:cache-api:0.5")
+ optional("net.sf.ehcache:ehcache-core:2.0.0")
+ optional("opensymphony:quartz:1.6.2")
+ optional("org.codehaus.fabric3.api:commonj:1.1.0")
+ optional("velocity:velocity:1.5")
+ optional("org.freemarker:freemarker:2.3.15")
+ optional("com.lowagie:itext:2.1.7")
+ optional("jasperreports:jasperreports:2.0.5") {
transitive = false
+ exclude group: "bouncycastle", module: "bctsp-jdk14"
}
+ optional("org.slf4j:slf4j-api:${slf4jVersion}")
+ provided("javax.activation:activation:1.1")
testCompile("org.apache.poi:poi:3.0.2-FINAL") {
exclude group: "log4j", module: "log4j"
}
@@ -371,32 +375,32 @@ project("spring-web") {
compile(project(":spring-beans")) // for MultiPartFilter
compile(project(":spring-aop")) // for JaxWsPortProxyFactoryBean
compile(project(":spring-context"))
- compile(project(":spring-oxm"), optional) // for MarshallingHttpMessageConverter
+ optional(project(":spring-oxm")) // for MarshallingHttpMessageConverter
compile("aopalliance:aopalliance:1.0")
- compile("com.caucho:hessian:3.2.1", optional)
- compile("rome:rome:1.0", optional)
- compile("javax.el:el-api:1.0", optional)
- compile("javax.faces:jsf-api:1.2_08", optional)
- compile("javax.portlet:portlet-api:2.0", provided)
- compile("javax.servlet:javax.servlet-api:3.0.1", provided)
- compile("javax.servlet.jsp:jsp-api:2.1", provided)
- compile("javax.xml:jaxrpc-api:1.1")
- compile("javax.xml.soap:saaj-api:1.3", provided)
- compile("commons-fileupload:commons-fileupload:1.2", optional)
- runtime("commons-io:commons-io:1.3", optional)
- compile("commons-httpclient:commons-httpclient:3.1", optional)
- compile("org.apache.httpcomponents:httpclient:4.2", optional)
- compile("org.codehaus.jackson:jackson-mapper-asl:1.4.2", optional)
- compile("com.fasterxml.jackson.core:jackson-databind:2.0.1", optional)
- compile("taglibs:standard:1.1.2", optional)
- compile("org.eclipse.jetty:jetty-servlet:8.1.5.v20120716") { dep ->
- optional dep
+ optional("com.caucho:hessian:3.2.1")
+ optional("rome:rome:1.0")
+ optional("javax.el:el-api:1.0")
+ optional("javax.faces:jsf-api:1.2_08")
+ provided("javax.portlet:portlet-api:2.0")
+ provided("javax.servlet:javax.servlet-api:3.0.1")
+ provided("javax.servlet.jsp:jsp-api:2.1")
+ optional("javax.xml:jaxrpc-api:1.1")
+ provided("javax.xml.soap:saaj-api:1.3")
+ provided("javax.activation:activation:1.1")
+ optional("commons-fileupload:commons-fileupload:1.2")
+ optional("commons-io:commons-io:1.3")
+ optional("commons-httpclient:commons-httpclient:3.1")
+ optional("org.apache.httpcomponents:httpclient:4.2")
+ optional("org.codehaus.jackson:jackson-mapper-asl:1.4.2")
+ optional("com.fasterxml.jackson.core:jackson-databind:2.0.1")
+ optional("taglibs:standard:1.1.2")
+ optional("org.eclipse.jetty:jetty-servlet:8.1.5.v20120716") {
exclude group: "org.eclipse.jetty.orbit", module: "javax.servlet"
}
- compile("org.eclipse.jetty:jetty-server:8.1.5.v20120716") { dep ->
- optional dep
+ optional("org.eclipse.jetty:jetty-server:8.1.5.v20120716") {
exclude group: "org.eclipse.jetty.orbit", module: "javax.servlet"
}
+ optional("log4j:log4j:1.2.17")
testCompile(project(":spring-context-support")) // for JafMediaTypeFactory
testCompile("xmlunit:xmlunit:1.2")
}
@@ -409,29 +413,31 @@ project("spring-orm") {
description = "Spring Object/Relational Mapping"
dependencies {
compile("aopalliance:aopalliance:1.0")
- compile("org.hibernate:hibernate-core:3.3.2.GA", optional)
- compile("org.hibernate:hibernate-annotations:3.4.0.GA", optional)
- compile("org.hibernate:hibernate-entitymanager:3.4.0.GA", optional)
- compile("org.apache.openjpa:openjpa:1.1.0", optional)
- compile("org.eclipse.persistence:org.eclipse.persistence.core:1.0.1", optional)
- compile("org.eclipse.persistence:org.eclipse.persistence.jpa:1.0.1", optional)
- compile("toplink.essentials:toplink-essentials:2.0-41b", optional)
- compile("javax.jdo:jdo-api:3.0", optional)
- compile("org.apache.ibatis:ibatis-sqlmap:2.3.4.726", optional)
- testCompile("javax.servlet:servlet-api:2.5")
+ optional("org.hibernate:hibernate-core:3.3.2.GA")
+ optional("org.hibernate:hibernate-annotations:3.4.0.GA")
+ optional("org.hibernate:hibernate-entitymanager:3.4.0.GA")
+ optional("org.apache.openjpa:openjpa:1.1.0")
+ optional("org.eclipse.persistence:org.eclipse.persistence.core:1.0.1")
+ optional("org.eclipse.persistence:org.eclipse.persistence.jpa:1.0.1")
+ optional("toplink.essentials:toplink-essentials:2.0-41b")
+ optional("javax.jdo:jdo-api:3.0")
+ optional("org.apache.ibatis:ibatis-sqlmap:2.3.4.726")
+ optional("javax.persistence:persistence-api:1.0")
+ provided("javax.servlet:servlet-api:2.5")
+ testCompile("javax.servlet:javax.servlet-api:3.0.1")
testCompile("org.slf4j:slf4j-jcl:${slf4jVersion}")
testCompile("commons-dbcp:commons-dbcp:1.2.2")
testCompile("org.eclipse.persistence:org.eclipse.persistence.asm:1.0.1")
testCompile("org.eclipse.persistence:org.eclipse.persistence.antlr:1.0.1")
+ testCompile("hsqldb:hsqldb:${hsqldbVersion}")
testCompile(project(":spring-web").sourceSets.test.output)
compile(project(":spring-core"))
compile(project(":spring-beans"))
- compile(project(":spring-aop"), optional)
- compile(project(":spring-context"), optional)
+ optional(project(":spring-aop"))
+ optional(project(":spring-context"))
compile(project(":spring-tx"))
compile(project(":spring-jdbc"))
- compile(project(":spring-web")) { dep ->
- optional dep
+ optional(project(":spring-web")) {
exclude group: "javax.persistence", module: "persistence-api"
}
}
@@ -445,13 +451,12 @@ project("spring-orm-hibernate4") {
compile(project(":spring-orm").sourceSets.main.output)
compile(project(":spring-tx"))
compile(project(":spring-jdbc"))
- compile("org.hibernate:hibernate-core:4.1.0.Final", optional)
- compile("org.hibernate:hibernate-entitymanager:4.1.0.Final", optional)
- compile(project(":spring-web")) { dep ->
- optional dep
+ optional("org.hibernate:hibernate-core:4.1.0.Final")
+ optional("org.hibernate:hibernate-entitymanager:4.1.0.Final")
+ optional(project(":spring-web")) {
exclude group: "javax.persistence", module: "persistence-api"
}
- compile("javax.servlet:servlet-api:2.5", optional)
+ optional("javax.servlet:servlet-api:2.5")
}
}
@@ -463,32 +468,28 @@ project("spring-webmvc") {
compile(project(":spring-beans"))
compile(project(":spring-web"))
compile(project(":spring-context"))
- compile(project(":spring-context-support"), optional) // for Velocity support
- compile(project(":spring-oxm"), optional) // for MarshallingView
- compile("org.apache.tiles:tiles-api:2.1.2", optional)
- compile("org.apache.tiles:tiles-core:2.1.2") { dep ->
- optional dep
- exclude group: "org.slf4j", module: "jcl-over-slf4j"
- }
- compile("org.apache.tiles:tiles-jsp:2.1.2") { dep ->
- optional dep
- exclude group: "org.slf4j", module: "jcl-over-slf4j"
- }
- compile("org.apache.tiles:tiles-servlet:2.1.2") { dep ->
- optional dep
- exclude group: "org.slf4j", module: "jcl-over-slf4j"
- }
- compile("velocity-tools:velocity-tools-view:1.4", optional)
- compile("net.sourceforge.jexcelapi:jxl:2.6.3") { dep ->
- optional dep
- exclude group: "log4j", module: "log4j"
- }
- compile("org.apache.poi:poi:3.0.2-FINAL") { dep ->
- optional dep
- exclude group: "log4j", module: "log4j"
+ optional(project(":spring-context-support")) // for Velocity support
+ optional(project(":spring-oxm")) // for MarshallingView
+ optional("org.apache.tiles:tiles-api:2.1.2")
+ optional("org.apache.tiles:tiles-core:2.1.2")
+ optional("org.apache.tiles:tiles-jsp:2.1.2")
+ optional("org.apache.tiles:tiles-servlet:2.1.2")
+ optional("velocity-tools:velocity-tools-view:1.4")
+ optional("net.sourceforge.jexcelapi:jxl:2.6.3")
+ optional("org.apache.poi:poi:3.0.2-FINAL")
+ optional("com.lowagie:itext:2.1.7")
+ optional("jasperreports:jasperreports:2.0.5") {
+ transitive = false
+ exclude group: "xml-apis", module: "xml-apis"
}
- compile("javax.servlet:jstl:1.1.2", provided)
- compile("javax.servlet:javax.servlet-api:3.0.1", provided)
+ optional("rome:rome:1.0")
+ optional("velocity:velocity:1.5")
+ optional("org.freemarker:freemarker:2.3.15")
+ optional("org.codehaus.jackson:jackson-mapper-asl:1.4.2")
+ optional("com.fasterxml.jackson.core:jackson-databind:2.0.1")
+ provided("javax.servlet:jstl:1.2")
+ provided("javax.servlet:javax.servlet-api:3.0.1")
+ provided("javax.servlet.jsp:jsp-api:2.1")
testCompile(project(":spring-aop"))
testCompile("org.slf4j:slf4j-jcl:${slf4jVersion}")
testCompile("rhino:js:1.7R1")
@@ -501,6 +502,17 @@ project("spring-webmvc") {
exclude group: "xom", module: "xom"
exclude group: "xerces", module: "xercesImpl"
}
+ testCompile("org.eclipse.jetty:jetty-servlet:8.1.5.v20120716") {
+ exclude group: "org.eclipse.jetty.orbit", module: "javax.servlet"
+ }
+ testCompile("org.eclipse.jetty:jetty-server:8.1.5.v20120716") {
+ exclude group: "org.eclipse.jetty.orbit", module: "javax.servlet"
+ }
+ testCompile("javax.validation:validation-api:1.0.0.GA")
+ testCompile("commons-fileupload:commons-fileupload:1.2")
+ testCompile("commons-io:commons-io:1.3")
+ testCompile("org.hibernate:hibernate-validator:4.3.0.Final")
+ testCompile("org.apache.httpcomponents:httpclient:4.2")
testCompile(project(":spring-web").sourceSets.test.output)
}
@@ -515,41 +527,40 @@ project("spring-webmvc-tiles3") {
dependencies {
compile(project(":spring-context"))
compile(project(":spring-webmvc").sourceSets.main.output)
- compile("javax.el:el-api:1.0", provided)
- compile("javax.servlet:jstl:1.1.2", provided)
- compile("javax.servlet.jsp:jsp-api:2.1", provided)
- compile("org.apache.tiles:tiles-request-api:1.0.1", optional)
- compile("org.apache.tiles:tiles-api:3.0.1", optional)
- compile("org.apache.tiles:tiles-core:3.0.1") { dep ->
- optional dep
+ provided("javax.el:el-api:1.0")
+ provided("javax.servlet:jstl:1.2")
+ provided("javax.servlet.jsp:jsp-api:2.1")
+ optional("org.apache.tiles:tiles-request-api:1.0.1")
+ optional("org.apache.tiles:tiles-api:3.0.1")
+ optional("org.apache.tiles:tiles-core:3.0.1") {
exclude group: "org.slf4j", module: "jcl-over-slf4j"
}
- compile("org.apache.tiles:tiles-servlet:3.0.1") { dep ->
- optional dep
+ optional("org.apache.tiles:tiles-servlet:3.0.1") {
exclude group: "org.slf4j", module: "jcl-over-slf4j"
}
- compile("org.apache.tiles:tiles-jsp:3.0.1") { dep ->
- optional dep
+ optional("org.apache.tiles:tiles-jsp:3.0.1") {
exclude group: "org.slf4j", module: "jcl-over-slf4j"
}
- compile("org.apache.tiles:tiles-el:3.0.1") { dep ->
- optional dep
+ optional("org.apache.tiles:tiles-el:3.0.1") {
exclude group: "org.slf4j", module: "jcl-over-slf4j"
}
- compile("javax.servlet:javax.servlet-api:3.0.1", provided)
+ provided("javax.servlet:javax.servlet-api:3.0.1")
compile(project(":spring-web").sourceSets*.output) // mock request & response
+ testCompile("org.slf4j:slf4j-jcl:${slf4jVersion}")
}
}
project("spring-webmvc-portlet") {
description = "Spring Web Portlet"
dependencies {
- compile("javax.servlet:servlet-api:2.5", provided)
+ provided("javax.servlet:servlet-api:2.5")
+ provided("javax.portlet:portlet-api:2.0")
compile(project(":spring-core"))
compile(project(":spring-beans"))
compile(project(":spring-context"))
compile(project(":spring-web"))
compile(project(":spring-webmvc"))
+ optional("commons-fileupload:commons-fileupload:1.2")
}
// pick up DispatcherPortlet.properties in src/main
@@ -560,30 +571,34 @@ project("spring-test") {
description = "Spring TestContext Framework"
dependencies {
compile(project(":spring-core"))
- compile(project(":spring-beans"), optional)
- compile(project(":spring-context"), optional)
- compile(project(":spring-jdbc"), optional)
- compile(project(":spring-tx"), optional)
- compile(project(":spring-orm"), optional)
- compile(project(":spring-web"), optional)
- compile(project(":spring-webmvc"), optional)
- compile(project(":spring-webmvc-portlet"), optional)
- compile("junit:junit:${junitVersion}") { dep ->
- optional dep
+ optional(project(":spring-beans"))
+ optional(project(":spring-context"))
+ optional(project(":spring-jdbc"))
+ optional(project(":spring-tx"))
+ optional(project(":spring-orm"))
+ optional(project(":spring-web"))
+ optional(project(":spring-webmvc"))
+ optional(project(":spring-webmvc-portlet"), )
+ optional("junit:junit:${junitVersion}") {
// We already have hamcrest-all as a global testCompile dependency.
exclude group: "org.hamcrest", module: "hamcrest-core"
}
- compile("org.testng:testng:6.5.2") { dep ->
- optional dep
+ optional("org.testng:testng:6.5.2") {
exclude group: "junit", module: "junit"
// We already have hamcrest-all as a global testCompile dependency.
exclude group: "org.hamcrest", module: "hamcrest-core"
}
- compile("javax.servlet:servlet-api:2.5", optional)
- compile("javax.servlet.jsp:jsp-api:2.1", optional)
- compile("javax.portlet:portlet-api:2.0", optional)
- compile("javax.activation:activation:1.0", provided)
- testCompile("org.slf4j:slf4j-jcl:${slf4jVersion}")
+ optional("javax.servlet:servlet-api:2.5")
+ optional("javax.servlet.jsp:jsp-api:2.1")
+ optional("javax.portlet:portlet-api:2.0")
+ optional("javax.persistence:persistence-api:1.0")
+ optional("org.aspectj:aspectjweaver:${aspectjVersion}")
+ testCompile("org.hibernate:hibernate-core:3.3.2.GA")
+ provided("javax.inject:javax.inject:1")
+ provided("javax.activation:activation:1.1")
+ provided("javax.servlet:jstl:1.2")
+ testCompile "org.slf4j:slf4j-jcl:${slf4jVersion}"
+ testCompile("hsqldb:hsqldb:${hsqldbVersion}")
}
}
@@ -593,25 +608,25 @@ project("spring-test-mvc") {
apply from: "${gradleScriptDir}/merge-artifacts.gradle"
apply from: "ide.gradle"
dependencies {
- compile(project(":spring-context"))
+ optional(project(":spring-context"))
compile(project(":spring-webmvc"))
compile(project(":spring-test").sourceSets.main.output)
- compile("javax.servlet:javax.servlet-api:3.0.1", provided)
- compile("org.hamcrest:hamcrest-core:1.3", optional)
- compile("com.jayway.jsonpath:json-path:0.8.1", optional)
- compile("xmlunit:xmlunit:1.2", optional)
- testCompile("org.slf4j:jcl-over-slf4j:${slf4jVersion}")
- testCompile("org.slf4j:slf4j-log4j12:${slf4jVersion}") {
- exclude group: "log4j", module: "log4j"
- }
- testCompile("log4j:log4j:1.2.17")
+ provided("javax.servlet:javax.servlet-api:3.0.1")
+ optional("org.hamcrest:hamcrest-core:1.3")
+ optional("com.jayway.jsonpath:json-path:0.8.1")
+ optional("xmlunit:xmlunit:1.2")
+ testCompile("org.slf4j:slf4j-jcl:${slf4jVersion}")
testCompile("javax.servlet:jstl:1.2")
testCompile("org.hibernate:hibernate-validator:4.3.0.Final")
testCompile("org.codehaus.jackson:jackson-mapper-asl:1.4.2")
+ testCompile("com.fasterxml.jackson.core:jackson-databind:2.0.1")
+ testCompile(project(":spring-context-support"))
testCompile(project(":spring-oxm"))
testCompile("com.thoughtworks.xstream:xstream:1.3.1")
testCompile("cglib:cglib-nodep:2.2")
testCompile("rome:rome:1.0")
+ testCompile("javax.activation:activation:1.1")
+ testCompile("javax.mail:mail:1.4")
testCompile("javax.xml.bind:jaxb-api:2.2.6")
testCompile("org.easymock:easymockclassextension:${easymockVersion}")
testCompile("org.apache.tiles:tiles-request-api:1.0.1")
@@ -635,7 +650,8 @@ project("spring-struts") {
compile(project(":spring-webmvc"))
compile("struts:struts:1.2.9")
compile("commons-beanutils:commons-beanutils:1.7.0")
- compile("javax.servlet:servlet-api:2.5", provided)
+ provided("javax.servlet:servlet-api:2.5")
+ provided("javax.servlet:jstl:1.2")
testCompile(project(":spring-test"))
}
}
@@ -644,13 +660,15 @@ project("spring-aspects") {
description = "Spring Aspects"
apply from: "aspects.gradle"
dependencies {
- compile(project(":spring-beans"), optional) // for @Configurable support
- compile(project(":spring-aop"), optional) // for @Async support
- compile(project(":spring-context"), optional) // for @Enable* support
- compile(project(":spring-context-support"), optional) // for JavaMail support
- compile(project(":spring-tx"), optional) // for JPA, @Transactional support
- compile(project(":spring-orm"), optional) // for JPA exception translation support
+ optional(project(":spring-beans")) // for @Configurable support
+ optional(project(":spring-aop")) // for @Async support
+ optional(project(":spring-context")) // for @Enable* support
+ compile(project(":spring-context-support")) // for JavaMail support
+ optional(project(":spring-tx")) // for JPA, @Transactional support
+ optional(project(":spring-orm")) // for JPA exception translation support
aspects(project(":spring-orm"))
+ provided("javax.persistence:persistence-api:1.0")
+ testCompile("javax.mail:mail:1.4")
ajc("org.aspectj:aspectjtools:${aspectjVersion}")
compile("org.aspectj:aspectjweaver:${aspectjVersion}")
testCompile(project(":spring-core")) // for CodeStyleAspect
@@ -689,8 +707,14 @@ configure(rootProject) {
testCompile(project(":spring-test"))
testCompile(project(":spring-web"))
testCompile(project(":spring-webmvc-portlet"))
+ testCompile(project(":spring-orm"))
testCompile("org.hibernate:hibernate-core:4.1.0.Final")
testCompile("javax.servlet:servlet-api:2.5")
+ testCompile("javax.portlet:portlet-api:2.0")
+ testCompile("javax.inject:javax.inject:1")
+ testCompile("javax.resource:connector-api:1.5")
+ testCompile("org.aspectj:aspectjweaver:${aspectjVersion}")
+ testCompile("hsqldb:hsqldb:${hsqldbVersion}")
}
task api(type: Javadoc) {
@@ -817,7 +841,8 @@ configure(rootProject) {
def projectNames = rootProject.subprojects*.name
def artifacts = new HashSet()
subprojects.each { subproject ->
- subproject.configurations.runtime.resolvedConfiguration.resolvedArtifacts.each { artifact ->
+ (subproject.configurations.runtime.resolvedConfiguration.resolvedArtifacts +
+ subproject.configurations.optional.resolvedConfiguration.resolvedArtifacts).each { artifact ->
def dependency = artifact.moduleVersion.id
if (!projectNames.contains(dependency.name)) {
artifacts << artifact.file | true |
Other | spring-projects | spring-framework | 0751b2cbeb96697bd377578771e9c7b29b94658a.json | Convert Gradle build to use new propdeps-plugin
Replace existing 'optional' and 'provided' Spring specific build
extensions with a new Gradle propdeps-plugin. Optional and Provided
dependencies are now defined use dependency configurations.
The new plugin does not currently support the notion of optional
runtime dependencies. All optional dependencies are implicitly
part of the 'compile' scope. This is an intentional design decision
that aims to keep both the plugin and the build simple. Since optional
dependencies are non-transitive this restriction should not cause
any real problems for existing users. The only existing dependency
affected is 'commons-io' in the 'spring-beans' project, however, this
was an optional compile scope dependency in the previous Spring 3.1
release.
Both provided and optional dependencies are no longer exported from
generated eclipse .classpath files. This fixes several tests that
would previously fail when running within eclipse. The servlet-api
specific elements of ide.gradle are also no longer required.
Issue: SPR-9656, SPR-10070 | gradle/ide.gradle | @@ -1,11 +1,6 @@
import org.gradle.plugins.ide.eclipse.model.ProjectDependency
eclipse.classpath.file.whenMerged { classpath ->
- // servlet-api (2.5) and tomcat-servlet-api (3.0) classpath entries should not be
- // exported to dependent projects in Eclipse to avoid false compilation errors due
- // to changing APIs across these versions
- classpath.entries.findAll { entry -> entry.path.contains('servlet-api') }*.exported = false
-
// GRADLE-1116
def regexp = /.*?\/([^\/]+)\/build\/[^\/]+\/(?:main|test)/ // only match those that end in main or test (avoids removing necessary entries like build/classes/jaxb)
def projectOutputDependencies = classpath.entries.findAll { entry -> entry.path =~ regexp } | true |
Other | spring-projects | spring-framework | 0751b2cbeb96697bd377578771e9c7b29b94658a.json | Convert Gradle build to use new propdeps-plugin
Replace existing 'optional' and 'provided' Spring specific build
extensions with a new Gradle propdeps-plugin. Optional and Provided
dependencies are now defined use dependency configurations.
The new plugin does not currently support the notion of optional
runtime dependencies. All optional dependencies are implicitly
part of the 'compile' scope. This is an intentional design decision
that aims to keep both the plugin and the build simple. Since optional
dependencies are non-transitive this restriction should not cause
any real problems for existing users. The only existing dependency
affected is 'commons-io' in the 'spring-beans' project, however, this
was an optional compile scope dependency in the previous Spring 3.1
release.
Both provided and optional dependencies are no longer exported from
generated eclipse .classpath files. This fixes several tests that
would previously fail when running within eclipse. The servlet-api
specific elements of ide.gradle are also no longer required.
Issue: SPR-9656, SPR-10070 | gradle/merge-artifacts.gradle | @@ -57,8 +57,6 @@ gradle.taskGraph.whenReady {
configure(mergeIntoProject.install.repositories.mavenInstaller.pom.scopeMappings) {
addMapping(mapping.priority + 100, mergeIntoProject.configurations."$newConfigName", mapping.scope)
}
- mergeIntoProject.optionalDeps += mergeFromProject.optionalDeps
- mergeIntoProject.providedDeps += mergeFromProject.providedDeps
}
}
} | true |
Other | spring-projects | spring-framework | 0751b2cbeb96697bd377578771e9c7b29b94658a.json | Convert Gradle build to use new propdeps-plugin
Replace existing 'optional' and 'provided' Spring specific build
extensions with a new Gradle propdeps-plugin. Optional and Provided
dependencies are now defined use dependency configurations.
The new plugin does not currently support the notion of optional
runtime dependencies. All optional dependencies are implicitly
part of the 'compile' scope. This is an intentional design decision
that aims to keep both the plugin and the build simple. Since optional
dependencies are non-transitive this restriction should not cause
any real problems for existing users. The only existing dependency
affected is 'commons-io' in the 'spring-beans' project, however, this
was an optional compile scope dependency in the previous Spring 3.1
release.
Both provided and optional dependencies are no longer exported from
generated eclipse .classpath files. This fixes several tests that
would previously fail when running within eclipse. The servlet-api
specific elements of ide.gradle are also no longer required.
Issue: SPR-9656, SPR-10070 | gradle/publish-maven.gradle | @@ -1,10 +1,4 @@
-apply plugin: "maven"
-
-ext.optionalDeps = []
-ext.providedDeps = []
-
-ext.optional = { optionalDeps << it }
-ext.provided = { providedDeps << it }
+apply plugin: "propdeps-maven"
install {
repositories.mavenInstaller {
@@ -14,14 +8,6 @@ install {
def customizePom(pom, gradleProject) {
pom.whenConfigured { generatedPom ->
- // respect "optional" and "provided" dependencies
- gradleProject.optionalDeps.each { dep ->
- generatedPom.dependencies.findAll { it.artifactId == dep.name }*.optional = true
- }
- gradleProject.providedDeps.each { dep ->
- generatedPom.dependencies.findAll { it.artifactId == dep.name }*.scope = "provided"
- }
-
// eliminate test-scoped dependencies (no need in maven central poms)
generatedPom.dependencies.removeAll { dep ->
dep.scope == "test" | true |
Other | spring-projects | spring-framework | 0751b2cbeb96697bd377578771e9c7b29b94658a.json | Convert Gradle build to use new propdeps-plugin
Replace existing 'optional' and 'provided' Spring specific build
extensions with a new Gradle propdeps-plugin. Optional and Provided
dependencies are now defined use dependency configurations.
The new plugin does not currently support the notion of optional
runtime dependencies. All optional dependencies are implicitly
part of the 'compile' scope. This is an intentional design decision
that aims to keep both the plugin and the build simple. Since optional
dependencies are non-transitive this restriction should not cause
any real problems for existing users. The only existing dependency
affected is 'commons-io' in the 'spring-beans' project, however, this
was an optional compile scope dependency in the previous Spring 3.1
release.
Both provided and optional dependencies are no longer exported from
generated eclipse .classpath files. This fixes several tests that
would previously fail when running within eclipse. The servlet-api
specific elements of ide.gradle are also no longer required.
Issue: SPR-9656, SPR-10070 | spring-aspects/aspects.gradle | @@ -26,7 +26,7 @@ task compileJava(overwrite: true) {
aspectPath: configurations.aspects.asPath,
inpath: configurations.ajInpath.asPath,
sourceRootCopyFilter: "**/*.java",
- classpath: configurations.compile.asPath) {
+ classpath: sourceSets.main.runtimeClasspath.asPath) {
sourceroots {
sourceSets.main.java.srcDirs.each {
pathelement(location:it.absolutePath)
@@ -55,7 +55,7 @@ task compileTestJava(overwrite: true) {
destDir: outputDir.absolutePath,
aspectPath: jar.archivePath,
inpath: configurations.ajInpath.asPath,
- classpath: configurations.testRuntime.asPath + configurations.compile.asPath + jar.archivePath) {
+ classpath: sourceSets.test.runtimeClasspath.asPath + jar.archivePath) {
sourceroots {
sourceSets.test.java.srcDirs.each {
pathelement(location:it.absolutePath) | true |
Other | spring-projects | spring-framework | 6103a7f1c1a1ff70e19f44355c811a82e249c0a1.json | Upgrade log4j dependency to version 1.2.17
Upgrade to the latest stable release of log4j. The previous 'jms'
and 'jmx' exclusions are not longer required since these have now
been marked as optional dependencies in the upstream POM. | build.gradle | @@ -165,13 +165,7 @@ project("spring-core") {
optional dep
exclude group: "org.apache.ant", module: "ant"
}
- compile("log4j:log4j:1.2.15") { dep ->
- optional dep
- exclude group: "javax.mail", module: "mail"
- exclude group: "javax.jms", module: "jms"
- exclude group: "com.sun.jdmk", module: "jmxtools"
- exclude group: "com.sun.jmx", module: "jmxri"
- }
+ compile("log4j:log4j:1.2.17", optional)
testCompile("xmlunit:xmlunit:1.2")
testCompile("org.codehaus.woodstox:wstx-asl:3.2.7")
}
@@ -610,12 +604,7 @@ project("spring-test-mvc") {
testCompile("org.slf4j:slf4j-log4j12:${slf4jVersion}") {
exclude group: "log4j", module: "log4j"
}
- testCompile("log4j:log4j:1.2.15") {
- exclude group: "javax.mail", module: "mail"
- exclude group: "javax.jms", module: "jms"
- exclude group: "com.sun.jdmk", module: "jmxtools"
- exclude group: "com.sun.jmx", module: "jmxri"
- }
+ testCompile("log4j:log4j:1.2.17")
testCompile("javax.servlet:jstl:1.2")
testCompile("org.hibernate:hibernate-validator:4.3.0.Final")
testCompile("org.codehaus.jackson:jackson-mapper-asl:1.4.2") | false |
Other | spring-projects | spring-framework | 85a552daed9766ff9f9c5de05181dd5fa5ec7214.json | Fix package cycle among http message converters
This change introduces a new AllEncompassingFormHttpMessageConverter
class that adds JSON and XML converters for individual mime parts of
a multi-part request. The new converter is used in place of the
previously used XmlAwareFormHttpMessageConverter.
Issue: SPR-10055 | spring-web/src/main/java/org/springframework/http/converter/FormHttpMessageConverter.java | @@ -36,15 +36,11 @@
import org.springframework.http.HttpInputMessage;
import org.springframework.http.HttpOutputMessage;
import org.springframework.http.MediaType;
-import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
-import org.springframework.http.converter.json.MappingJacksonHttpMessageConverter;
import org.springframework.util.Assert;
-import org.springframework.util.ClassUtils;
import org.springframework.util.FileCopyUtils;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.util.MultiValueMap;
import org.springframework.util.StringUtils;
-import org.springframework.web.client.RestTemplate;
/**
* Implementation of {@link HttpMessageConverter} that can handle form data, including multipart form data (i.e. file
@@ -76,14 +72,6 @@
*/
public class FormHttpMessageConverter implements HttpMessageConverter<MultiValueMap<String, ?>> {
- private static final boolean jackson2Present =
- ClassUtils.isPresent("com.fasterxml.jackson.databind.ObjectMapper", RestTemplate.class.getClassLoader()) &&
- ClassUtils.isPresent("com.fasterxml.jackson.core.JsonGenerator", RestTemplate.class.getClassLoader());
-
- private static final boolean jacksonPresent =
- ClassUtils.isPresent("org.codehaus.jackson.map.ObjectMapper", RestTemplate.class.getClassLoader()) &&
- ClassUtils.isPresent("org.codehaus.jackson.JsonGenerator", RestTemplate.class.getClassLoader());
-
private static final byte[] BOUNDARY_CHARS =
new byte[]{'-', '_', '1', '2', '3', '4', '5', '6', '7', '8', '9', '0', 'a', 'b', 'c', 'd', 'e', 'f', 'g',
'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', 'u', 'v', 'w', 'x', 'y', 'z', 'A',
@@ -108,12 +96,6 @@ public FormHttpMessageConverter() {
stringHttpMessageConverter.setWriteAcceptCharset(false);
this.partConverters.add(stringHttpMessageConverter);
this.partConverters.add(new ResourceHttpMessageConverter());
- if (jackson2Present) {
- this.partConverters.add(new MappingJackson2HttpMessageConverter());
- }
- else if (jacksonPresent) {
- this.partConverters.add(new MappingJacksonHttpMessageConverter());
- }
}
| true |
Other | spring-projects | spring-framework | 85a552daed9766ff9f9c5de05181dd5fa5ec7214.json | Fix package cycle among http message converters
This change introduces a new AllEncompassingFormHttpMessageConverter
class that adds JSON and XML converters for individual mime parts of
a multi-part request. The new converter is used in place of the
previously used XmlAwareFormHttpMessageConverter.
Issue: SPR-10055 | spring-web/src/main/java/org/springframework/http/converter/support/AllEncompassingFormHttpMessageConverter.java | @@ -0,0 +1,59 @@
+/*
+ * 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.http.converter.support;
+
+import org.springframework.http.converter.FormHttpMessageConverter;
+import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
+import org.springframework.http.converter.json.MappingJacksonHttpMessageConverter;
+import org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter;
+import org.springframework.http.converter.xml.SourceHttpMessageConverter;
+import org.springframework.util.ClassUtils;
+
+/**
+ * Extension of {@link org.springframework.http.converter.FormHttpMessageConverter},
+ * adding support for XML and JSON-based parts.
+ *
+ * @author Rossen Stoyanchev
+ * @since 3.2
+ */
+public class AllEncompassingFormHttpMessageConverter extends FormHttpMessageConverter {
+
+ private static final boolean jackson2Present =
+ ClassUtils.isPresent("com.fasterxml.jackson.databind.ObjectMapper", AllEncompassingFormHttpMessageConverter.class.getClassLoader()) &&
+ ClassUtils.isPresent("com.fasterxml.jackson.core.JsonGenerator", AllEncompassingFormHttpMessageConverter.class.getClassLoader());
+
+ private static final boolean jacksonPresent =
+ ClassUtils.isPresent("org.codehaus.jackson.map.ObjectMapper", AllEncompassingFormHttpMessageConverter.class.getClassLoader()) &&
+ ClassUtils.isPresent("org.codehaus.jackson.JsonGenerator", AllEncompassingFormHttpMessageConverter.class.getClassLoader());
+
+ private static final boolean jaxb2Present =
+ ClassUtils.isPresent("javax.xml.bind.Binder", AllEncompassingFormHttpMessageConverter.class.getClassLoader());
+
+
+ public AllEncompassingFormHttpMessageConverter() {
+ addPartConverter(new SourceHttpMessageConverter());
+ if (jaxb2Present) {
+ addPartConverter(new Jaxb2RootElementHttpMessageConverter());
+ }
+ if (jackson2Present) {
+ addPartConverter(new MappingJackson2HttpMessageConverter());
+ }
+ else if (jacksonPresent) {
+ addPartConverter(new MappingJacksonHttpMessageConverter());
+ }
+ }
+
+} | true |
Other | spring-projects | spring-framework | 85a552daed9766ff9f9c5de05181dd5fa5ec7214.json | Fix package cycle among http message converters
This change introduces a new AllEncompassingFormHttpMessageConverter
class that adds JSON and XML converters for individual mime parts of
a multi-part request. The new converter is used in place of the
previously used XmlAwareFormHttpMessageConverter.
Issue: SPR-10055 | spring-web/src/main/java/org/springframework/http/converter/xml/XmlAwareFormHttpMessageConverter.java | @@ -17,13 +17,15 @@
package org.springframework.http.converter.xml;
import org.springframework.http.converter.FormHttpMessageConverter;
+import org.springframework.http.converter.support.AllEncompassingFormHttpMessageConverter;
/**
* Extension of {@link org.springframework.http.converter.FormHttpMessageConverter},
* adding support for XML-based parts through a {@link SourceHttpMessageConverter}.
*
* @author Juergen Hoeller
* @since 3.0.3
+ * @deprecated in favor of {@link AllEncompassingFormHttpMessageConverter}
*/
public class XmlAwareFormHttpMessageConverter extends FormHttpMessageConverter {
| true |
Other | spring-projects | spring-framework | 85a552daed9766ff9f9c5de05181dd5fa5ec7214.json | Fix package cycle among http message converters
This change introduces a new AllEncompassingFormHttpMessageConverter
class that adds JSON and XML converters for individual mime parts of
a multi-part request. The new converter is used in place of the
previously used XmlAwareFormHttpMessageConverter.
Issue: SPR-10055 | spring-web/src/main/java/org/springframework/web/client/RestTemplate.java | @@ -45,6 +45,7 @@
import org.springframework.http.converter.feed.RssChannelHttpMessageConverter;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
import org.springframework.http.converter.json.MappingJacksonHttpMessageConverter;
+import org.springframework.http.converter.support.AllEncompassingFormHttpMessageConverter;
import org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter;
import org.springframework.http.converter.xml.SourceHttpMessageConverter;
import org.springframework.http.converter.xml.XmlAwareFormHttpMessageConverter;
@@ -151,7 +152,7 @@ public RestTemplate() {
this.messageConverters.add(new StringHttpMessageConverter());
this.messageConverters.add(new ResourceHttpMessageConverter());
this.messageConverters.add(new SourceHttpMessageConverter());
- this.messageConverters.add(new XmlAwareFormHttpMessageConverter());
+ this.messageConverters.add(new AllEncompassingFormHttpMessageConverter());
if (romePresent) {
this.messageConverters.add(new AtomFeedHttpMessageConverter());
this.messageConverters.add(new RssChannelHttpMessageConverter()); | true |
Other | spring-projects | spring-framework | 85a552daed9766ff9f9c5de05181dd5fa5ec7214.json | Fix package cycle among http message converters
This change introduces a new AllEncompassingFormHttpMessageConverter
class that adds JSON and XML converters for individual mime parts of
a multi-part request. The new converter is used in place of the
previously used XmlAwareFormHttpMessageConverter.
Issue: SPR-10055 | spring-web/src/main/java/org/springframework/web/filter/HttpPutFormContentFilter.java | @@ -38,6 +38,7 @@
import org.springframework.http.HttpInputMessage;
import org.springframework.http.MediaType;
import org.springframework.http.converter.FormHttpMessageConverter;
+import org.springframework.http.converter.support.AllEncompassingFormHttpMessageConverter;
import org.springframework.http.converter.xml.XmlAwareFormHttpMessageConverter;
import org.springframework.http.server.ServletServerHttpRequest;
import org.springframework.util.LinkedMultiValueMap;
@@ -60,7 +61,7 @@
*/
public class HttpPutFormContentFilter extends OncePerRequestFilter {
- private final FormHttpMessageConverter formConverter = new XmlAwareFormHttpMessageConverter();
+ private final FormHttpMessageConverter formConverter = new AllEncompassingFormHttpMessageConverter();
/**
* The default character set to use for reading form data. | true |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.