Skip to content

Commit 93efb20

Browse files
committed
Fix broken links in Javadoc
This commit removes several links that were broken due to the removal of various APIs in 6.0. See gh-27480
1 parent 3dc84c2 commit 93efb20

File tree

24 files changed

+150
-198
lines changed

24 files changed

+150
-198
lines changed

spring-context/src/main/java/org/springframework/cache/concurrent/ConcurrentMapCacheManager.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2020 the original author or authors.
2+
* Copyright 2002-2021 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -38,8 +38,7 @@
3838
* <p>Note: This is by no means a sophisticated CacheManager; it comes with no
3939
* cache configuration options. However, it may be useful for testing or simple
4040
* caching scenarios. For advanced local caching needs, consider
41-
* {@link org.springframework.cache.jcache.JCacheCacheManager},
42-
* {@link org.springframework.cache.ehcache.EhCacheCacheManager},
41+
* {@link org.springframework.cache.jcache.JCacheCacheManager} or
4342
* {@link org.springframework.cache.caffeine.CaffeineCacheManager}.
4443
*
4544
* @author Juergen Hoeller

spring-context/src/main/java/org/springframework/scheduling/SchedulingAwareRunnable.java

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2012 the original author or authors.
2+
* Copyright 2002-2021 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -17,22 +17,17 @@
1717
package org.springframework.scheduling;
1818

1919
/**
20-
* Extension of the Runnable interface, adding special callbacks
20+
* Extension of the {@link Runnable} interface, adding special callbacks
2121
* for long-running operations.
2222
*
23-
* <p>This interface closely corresponds to the CommonJ Work interface,
24-
* but is kept separate to avoid a required CommonJ dependency.
25-
*
2623
* <p>Scheduling-capable TaskExecutors are encouraged to check a submitted
2724
* Runnable, detecting whether this interface is implemented and reacting
2825
* as appropriately as they are able to.
2926
*
3027
* @author Juergen Hoeller
3128
* @since 2.0
32-
* @see commonj.work.Work
3329
* @see org.springframework.core.task.TaskExecutor
3430
* @see SchedulingTaskExecutor
35-
* @see org.springframework.scheduling.commonj.WorkManagerTaskExecutor
3631
*/
3732
public interface SchedulingAwareRunnable extends Runnable {
3833

spring-context/src/main/java/org/springframework/scheduling/SchedulingTaskExecutor.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2018 the original author or authors.
2+
* Copyright 2002-2021 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -28,7 +28,7 @@
2828
*
2929
* <p>Note: {@link SchedulingTaskExecutor} implementations are encouraged to also
3030
* implement the {@link org.springframework.core.task.AsyncListenableTaskExecutor}
31-
* interface. This is not required due to the dependency on Spring 4.0's new
31+
* interface. This is not required due to the dependency on Spring 4.0's
3232
* {@link org.springframework.util.concurrent.ListenableFuture} interface,
3333
* which would make it impossible for third-party executor implementations
3434
* to remain compatible with both Spring 4.0 and Spring 3.x.
@@ -37,7 +37,6 @@
3737
* @since 2.0
3838
* @see SchedulingAwareRunnable
3939
* @see org.springframework.core.task.TaskExecutor
40-
* @see org.springframework.scheduling.commonj.WorkManagerTaskExecutor
4140
*/
4241
public interface SchedulingTaskExecutor extends AsyncTaskExecutor {
4342

spring-core/src/main/java/org/springframework/core/ConfigurableObjectInputStream.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2016 the original author or authors.
2+
* Copyright 2002-2021 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -26,12 +26,12 @@
2626
import org.springframework.util.ClassUtils;
2727

2828
/**
29-
* Special ObjectInputStream subclass that resolves class names
30-
* against a specific ClassLoader. Serves as base class for
31-
* {@link org.springframework.remoting.rmi.CodebaseAwareObjectInputStream}.
29+
* Special {@link ObjectInputStream} subclass that resolves class names
30+
* against a specific {@link ClassLoader}.
3231
*
3332
* @author Juergen Hoeller
3433
* @since 2.5.5
34+
* @see org.springframework.core.serializer.DefaultDeserializer
3535
*/
3636
public class ConfigurableObjectInputStream extends ObjectInputStream {
3737

spring-core/src/main/java/org/springframework/core/io/VfsResource.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2018 the original author or authors.
2+
* Copyright 2002-2021 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -38,7 +38,6 @@
3838
* @author Costin Leau
3939
* @author Sam Brannen
4040
* @since 3.0
41-
* @see org.jboss.vfs.VirtualFile
4241
*/
4342
public class VfsResource extends AbstractResource {
4443

spring-core/src/main/java/org/springframework/core/io/VfsUtils.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2018 the original author or authors.
2+
* Copyright 2002-2021 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -35,8 +35,9 @@
3535
* (package {@code org.jboss.vfs}) and is in particular compatible with
3636
* JBoss AS 7 and WildFly 8+.
3737
*
38-
* <p>Thanks go to Marius Bogoevici for the initial patch.
39-
* <b>Note:</b> This is an internal class and should not be used outside the framework.
38+
* <p>Thanks go to Marius Bogoevici for the initial implementation.
39+
*
40+
* <p><b>Note:</b> This is an internal class and should not be used outside the framework.
4041
*
4142
* @author Costin Leau
4243
* @author Juergen Hoeller

spring-core/src/main/java/org/springframework/core/task/SimpleAsyncTaskExecutor.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2020 the original author or authors.
2+
* Copyright 2002-2021 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -45,7 +45,6 @@
4545
* @see #setConcurrencyLimit
4646
* @see SyncTaskExecutor
4747
* @see org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor
48-
* @see org.springframework.scheduling.commonj.WorkManagerTaskExecutor
4948
*/
5049
@SuppressWarnings("serial")
5150
public class SimpleAsyncTaskExecutor extends CustomizableThreadCreator

spring-jms/src/main/java/org/springframework/jms/listener/DefaultMessageListenerContainer.java

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,11 +62,10 @@
6262
* abstraction. By default, the specified number of invoker tasks will be created
6363
* on startup, according to the {@link #setConcurrentConsumers "concurrentConsumers"}
6464
* setting. Specify an alternative {@code TaskExecutor} to integrate with an existing
65-
* thread pool facility (such as a Jakarta EE server's), for example using a
66-
* {@link org.springframework.scheduling.commonj.WorkManagerTaskExecutor CommonJ WorkManager}.
67-
* With a native JMS setup, each of those listener threads is going to use a
68-
* cached JMS {@code Session} and {@code MessageConsumer} (only refreshed in case
69-
* of failure), using the JMS provider's resources as efficiently as possible.
65+
* thread pool facility (such as a Jakarta EE server's). With a native JMS setup,
66+
* each of those listener threads is going to use a cached JMS {@code Session} and
67+
* {@code MessageConsumer} (only refreshed in case of failure), using the JMS provider's
68+
* resources as efficiently as possible.
7069
*
7170
* <p>Message reception and listener execution can automatically be wrapped
7271
* in transactions by passing a Spring
@@ -224,7 +223,6 @@ public class DefaultMessageListenerContainer extends AbstractPollingMessageListe
224223
* will occupy a number of threads for its entire lifetime.
225224
* @see #setConcurrentConsumers
226225
* @see org.springframework.core.task.SimpleAsyncTaskExecutor
227-
* @see org.springframework.scheduling.commonj.WorkManagerTaskExecutor
228226
*/
229227
public void setTaskExecutor(Executor taskExecutor) {
230228
this.taskExecutor = taskExecutor;

spring-jms/src/main/java/org/springframework/jms/listener/SimpleMessageListenerContainer.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2020 the original author or authors.
2+
* Copyright 2002-2021 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -177,7 +177,6 @@ public void setConcurrentConsumers(int concurrentConsumers) {
177177
* {@link jakarta.jms.MessageListener} will work fine, in general.
178178
* @see #setConcurrentConsumers
179179
* @see org.springframework.core.task.SimpleAsyncTaskExecutor
180-
* @see org.springframework.scheduling.commonj.WorkManagerTaskExecutor
181180
*/
182181
public void setTaskExecutor(Executor taskExecutor) {
183182
this.taskExecutor = taskExecutor;

spring-jms/src/main/java/org/springframework/jms/support/converter/MessageConverter.java

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2017 the original author or authors.
2+
* Copyright 2002-2021 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -31,8 +31,6 @@
3131
* @since 1.1
3232
* @see org.springframework.jms.core.JmsTemplate#setMessageConverter
3333
* @see org.springframework.jms.listener.adapter.MessageListenerAdapter#setMessageConverter
34-
* @see org.springframework.jms.remoting.JmsInvokerClientInterceptor#setMessageConverter
35-
* @see org.springframework.jms.remoting.JmsInvokerServiceExporter#setMessageConverter
3634
*/
3735
public interface MessageConverter {
3836

spring-tx/src/main/java/org/springframework/jca/endpoint/GenericMessageEndpointManager.java

Lines changed: 65 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2020 the original author or authors.
2+
* Copyright 2002-2021 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -39,59 +39,61 @@
3939
*
4040
* <pre class="code">
4141
* &lt;bean class="org.springframework.jca.endpoint.GenericMessageEndpointManager"&gt;
42-
* &lt;property name="resourceAdapter" ref="resourceAdapter"/&gt;
43-
* &lt;property name="messageEndpointFactory"&gt;
44-
* &lt;bean class="org.springframework.jca.endpoint.GenericMessageEndpointFactory"&gt;
45-
* &lt;property name="messageListener" ref="messageListener"/&gt;
46-
* &lt;/bean&gt;
47-
* &lt;/property&gt;
48-
* &lt;property name="activationSpec"&gt;
49-
* &lt;bean class="org.apache.activemq.ra.ActiveMQActivationSpec"&gt;
50-
* &lt;property name="destination" value="myQueue"/&gt;
51-
* &lt;property name="destinationType" value="jakarta.jms.Queue"/&gt;
52-
* &lt;/bean&gt;
53-
* &lt;/property&gt;
54-
* &lt;/bean&gt;</pre>
42+
* &lt;property name="resourceAdapter" ref="resourceAdapter"/&gt;
43+
* &lt;property name="messageEndpointFactory"&gt;
44+
* &lt;bean class="org.springframework.jca.endpoint.GenericMessageEndpointFactory"&gt;
45+
* &lt;property name="messageListener" ref="messageListener"/&gt;
46+
* &lt;/bean&gt;
47+
* &lt;/property&gt;
48+
* &lt;property name="activationSpec"&gt;
49+
* &lt;bean class="org.apache.activemq.ra.ActiveMQActivationSpec"&gt;
50+
* &lt;property name="destination" value="myQueue"/&gt;
51+
* &lt;property name="destinationType" value="jakarta.jms.Queue"/&gt;
52+
* &lt;/bean&gt;
53+
* &lt;/property&gt;
54+
* &lt;/bean&gt;
55+
* </pre>
5556
*
56-
* In this example, Spring's own {@link GenericMessageEndpointFactory} is used
57+
* <p>In this example, Spring's own {@link GenericMessageEndpointFactory} is used
5758
* to point to a standard message listener object that happens to be supported
5859
* by the specified target ResourceAdapter: in this case, a JMS
5960
* {@link jakarta.jms.MessageListener} object as supported by the ActiveMQ
6061
* message broker, defined as a Spring bean:
6162
*
6263
* <pre class="code">
6364
* &lt;bean id="messageListener" class="com.myorg.messaging.myMessageListener"&gt;
64-
* ...
65-
* &lt;/bean&gt;</pre>
65+
* &lt;!-- ... --&gt;
66+
* &lt;/bean&gt;
67+
* </pre>
6668
*
67-
* The target ResourceAdapter may be configured as a local Spring bean as well
69+
* <p>The target ResourceAdapter may be configured as a local Spring bean as well
6870
* (the typical case) or obtained from JNDI (e.g. on WebLogic). For the
6971
* example above, a local ResourceAdapter bean could be defined as follows
7072
* (matching the "resourceAdapter" bean reference above):
7173
*
7274
* <pre class="code">
7375
* &lt;bean id="resourceAdapter" class="org.springframework.jca.support.ResourceAdapterFactoryBean"&gt;
74-
* &lt;property name="resourceAdapter"&gt;
75-
* &lt;bean class="org.apache.activemq.ra.ActiveMQResourceAdapter"&gt;
76-
* &lt;property name="serverUrl" value="tcp://localhost:61616"/&gt;
77-
* &lt;/bean&gt;
78-
* &lt;/property&gt;
79-
* &lt;property name="workManager"&gt;
80-
* &lt;bean class="org.springframework.jca.work.SimpleTaskWorkManager"/&gt;
81-
* &lt;/property&gt;
82-
* &lt;/bean&gt;</pre>
76+
* &lt;property name="resourceAdapter"&gt;
77+
* &lt;bean class="org.apache.activemq.ra.ActiveMQResourceAdapter"&gt;
78+
* &lt;property name="serverUrl" value="tcp://localhost:61616"/&gt;
79+
* &lt;/bean&gt;
80+
* &lt;/property&gt;
81+
* &lt;property name="workManager"&gt;
82+
* &lt;bean class="..."/&gt;
83+
* &lt;/property&gt;
84+
* &lt;/bean&gt;
85+
* </pre>
8386
*
84-
* For a different target resource, the configuration would simply point to a
87+
* <p>For a different target resource, the configuration would simply point to a
8588
* different ResourceAdapter and a different ActivationSpec object (which are
8689
* both specific to the resource provider), and possibly a different message
8790
* listener (e.g. a CCI {@link jakarta.resource.cci.MessageListener} for a
8891
* resource adapter which is based on the JCA Common Client Interface).
8992
*
9093
* <p>The asynchronous execution strategy can be customized through the
91-
* "workManager" property on the ResourceAdapterFactoryBean (as shown above).
92-
* Check out {@link org.springframework.jca.work.SimpleTaskWorkManager}'s
93-
* javadoc for its configuration options; alternatively, any other
94-
* JCA-compliant WorkManager can be used (e.g. Geronimo's).
94+
* "workManager" property on the ResourceAdapterFactoryBean as shown above,
95+
* where {@code <bean class="..."/>} should be replaced with configuration for
96+
* any JCA-compliant {@code WorkManager}.
9597
*
9698
* <p>Transactional execution is a responsibility of the concrete message endpoint,
9799
* as built by the specified MessageEndpointFactory. {@link GenericMessageEndpointFactory}
@@ -101,43 +103,45 @@
101103
*
102104
* <pre class="code">
103105
* &lt;bean class="org.springframework.jca.endpoint.GenericMessageEndpointManager"&gt;
104-
* &lt;property name="resourceAdapter" ref="resourceAdapter"/&gt;
105-
* &lt;property name="messageEndpointFactory"&gt;
106-
* &lt;bean class="org.springframework.jca.endpoint.GenericMessageEndpointFactory"&gt;
107-
* &lt;property name="messageListener" ref="messageListener"/&gt;
108-
* &lt;property name="transactionManager" ref="transactionManager"/&gt;
109-
* &lt;/bean&gt;
110-
* &lt;/property&gt;
111-
* &lt;property name="activationSpec"&gt;
112-
* &lt;bean class="org.apache.activemq.ra.ActiveMQActivationSpec"&gt;
113-
* &lt;property name="destination" value="myQueue"/&gt;
114-
* &lt;property name="destinationType" value="jakarta.jms.Queue"/&gt;
115-
* &lt;/bean&gt;
116-
* &lt;/property&gt;
106+
* &lt;property name="resourceAdapter" ref="resourceAdapter"/&gt;
107+
* &lt;property name="messageEndpointFactory"&gt;
108+
* &lt;bean class="org.springframework.jca.endpoint.GenericMessageEndpointFactory"&gt;
109+
* &lt;property name="messageListener" ref="messageListener"/&gt;
110+
* &lt;property name="transactionManager" ref="transactionManager"/&gt;
111+
* &lt;/bean&gt;
112+
* &lt;/property&gt;
113+
* &lt;property name="activationSpec"&gt;
114+
* &lt;bean class="org.apache.activemq.ra.ActiveMQActivationSpec"&gt;
115+
* &lt;property name="destination" value="myQueue"/&gt;
116+
* &lt;property name="destinationType" value="jakarta.jms.Queue"/&gt;
117+
* &lt;/bean&gt;
118+
* &lt;/property&gt;
117119
* &lt;/bean&gt;
118120
*
119-
* &lt;bean id="transactionManager" class="org.springframework.transaction.jta.JtaTransactionManager"/&gt;</pre>
121+
* &lt;bean id="transactionManager" class="org.springframework.transaction.jta.JtaTransactionManager"/&gt;
122+
* </pre>
120123
*
121-
* Alternatively, check out your resource provider's ActivationSpec object,
124+
* <p>Alternatively, check out your resource provider's ActivationSpec object,
122125
* which should support local transactions through a provider-specific config flag,
123126
* e.g. ActiveMQActivationSpec's "useRAManagedTransaction" bean property.
124127
*
125128
* <pre class="code">
126129
* &lt;bean class="org.springframework.jca.endpoint.GenericMessageEndpointManager"&gt;
127-
* &lt;property name="resourceAdapter" ref="resourceAdapter"/&gt;
128-
* &lt;property name="messageEndpointFactory"&gt;
129-
* &lt;bean class="org.springframework.jca.endpoint.GenericMessageEndpointFactory"&gt;
130-
* &lt;property name="messageListener" ref="messageListener"/&gt;
131-
* &lt;/bean&gt;
132-
* &lt;/property&gt;
133-
* &lt;property name="activationSpec"&gt;
134-
* &lt;bean class="org.apache.activemq.ra.ActiveMQActivationSpec"&gt;
135-
* &lt;property name="destination" value="myQueue"/&gt;
136-
* &lt;property name="destinationType" value="jakarta.jms.Queue"/&gt;
137-
* &lt;property name="useRAManagedTransaction" value="true"/&gt;
138-
* &lt;/bean&gt;
139-
* &lt;/property&gt;
140-
* &lt;/bean&gt;</pre>
130+
* &lt;property name="resourceAdapter" ref="resourceAdapter"/&gt;
131+
* &lt;property name="messageEndpointFactory"&gt;
132+
* &lt;bean class="org.springframework.jca.endpoint.GenericMessageEndpointFactory"&gt;
133+
* &lt;property name="messageListener" ref="messageListener"/&gt;
134+
* &lt;/bean&gt;
135+
* &lt;/property&gt;
136+
* &lt;property name="activationSpec"&gt;
137+
* &lt;bean class="org.apache.activemq.ra.ActiveMQActivationSpec"&gt;
138+
* &lt;property name="destination" value="myQueue"/&gt;
139+
* &lt;property name="destinationType" value="jakarta.jms.Queue"/&gt;
140+
* &lt;property name="useRAManagedTransaction" value="true"/&gt;
141+
* &lt;/bean&gt;
142+
* &lt;/property&gt;
143+
* &lt;/bean&gt;
144+
* </pre>
141145
*
142146
* @author Juergen Hoeller
143147
* @since 2.5

0 commit comments

Comments
 (0)