Skip to content

Commit b69ebe7

Browse files
committed
Consistent javadoc references to java.util.concurrent and javax.enterprise.concurrent
1 parent 3402628 commit b69ebe7

File tree

9 files changed

+40
-42
lines changed

9 files changed

+40
-42
lines changed

spring-context/src/main/java/org/springframework/scheduling/concurrent/ConcurrentTaskExecutor.java

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@
3131
import org.springframework.util.ClassUtils;
3232

3333
/**
34-
* Adapter that takes a JDK 1.5 {@code java.util.concurrent.Executor} and
35-
* exposes a Spring {@link org.springframework.core.task.TaskExecutor} for it.
34+
* Adapter that takes a {@code java.util.concurrent.Executor} and exposes
35+
* a Spring {@link org.springframework.core.task.TaskExecutor} for it.
3636
* Also detects an extended {@code java.util.concurrent.ExecutorService}, adapting
3737
* the {@link org.springframework.core.task.AsyncTaskExecutor} interface accordingly.
3838
*
@@ -41,8 +41,8 @@
4141
* exposing a long-running hint based on {@link SchedulingAwareRunnable} and an
4242
* identity name based on the given Runnable/Callable's {@code toString()}.
4343
*
44-
* <p>Note that there is a pre-built {@link ThreadPoolTaskExecutor} that allows for
45-
* defining a JDK 1.5 {@link java.util.concurrent.ThreadPoolExecutor} in bean style,
44+
* <p>Note that there is a pre-built {@link ThreadPoolTaskExecutor} that allows
45+
* for defining a {@link java.util.concurrent.ThreadPoolExecutor} in bean style,
4646
* exposing it as a Spring {@link org.springframework.core.task.TaskExecutor} directly.
4747
* This is a convenient alternative to a raw ThreadPoolExecutor definition with
4848
* a separate definition of the present adapter class.
@@ -77,28 +77,26 @@ public class ConcurrentTaskExecutor implements SchedulingTaskExecutor {
7777

7878

7979
/**
80-
* Create a new ConcurrentTaskExecutor,
81-
* using a single thread executor as default.
80+
* Create a new ConcurrentTaskExecutor, using a single thread executor as default.
8281
* @see java.util.concurrent.Executors#newSingleThreadExecutor()
8382
*/
8483
public ConcurrentTaskExecutor() {
8584
setConcurrentExecutor(null);
8685
}
8786

8887
/**
89-
* Create a new ConcurrentTaskExecutor,
90-
* using the given JDK 1.5 concurrent executor.
88+
* Create a new ConcurrentTaskExecutor, using the given {@link java.util.concurrent.Executor}.
9189
* <p>Autodetects a JSR-236 {@link javax.enterprise.concurrent.ManagedExecutorService}
9290
* in order to expose {@link javax.enterprise.concurrent.ManagedTask} adapters for it.
93-
* @param concurrentExecutor the JDK 1.5 concurrent executor to delegate to
91+
* @param concurrentExecutor the {@link java.util.concurrent.Executor} to delegate to
9492
*/
9593
public ConcurrentTaskExecutor(Executor concurrentExecutor) {
9694
setConcurrentExecutor(concurrentExecutor);
9795
}
9896

9997

10098
/**
101-
* Specify the JDK 1.5 concurrent executor to delegate to.
99+
* Specify the {@link java.util.concurrent.Executor} to delegate to.
102100
* <p>Autodetects a JSR-236 {@link javax.enterprise.concurrent.ManagedExecutorService}
103101
* in order to expose {@link javax.enterprise.concurrent.ManagedTask} adapters for it.
104102
*/
@@ -119,7 +117,7 @@ public final void setConcurrentExecutor(Executor concurrentExecutor) {
119117
}
120118

121119
/**
122-
* Return the JDK 1.5 concurrent executor that this adapter delegates to.
120+
* Return the {@link java.util.concurrent.Executor} that this adapter delegates to.
123121
*/
124122
public final Executor getConcurrentExecutor() {
125123
return this.concurrentExecutor;

spring-context/src/main/java/org/springframework/scheduling/concurrent/ConcurrentTaskScheduler.java

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@
3636
import org.springframework.util.ErrorHandler;
3737

3838
/**
39-
* Adapter that takes a JDK 1.5 {@code java.util.concurrent.ScheduledExecutorService}
40-
* and exposes a Spring {@link org.springframework.scheduling.TaskScheduler} for it.
39+
* Adapter that takes a {@code java.util.concurrent.ScheduledExecutorService} and
40+
* exposes a Spring {@link org.springframework.scheduling.TaskScheduler} for it.
4141
* Extends {@link ConcurrentTaskExecutor} in order to implement the
4242
* {@link org.springframework.scheduling.SchedulingTaskExecutor} interface as well.
4343
*
@@ -47,7 +47,7 @@
4747
* against the {@code java.util.concurrent.ScheduledExecutorService} API.
4848
*
4949
* <p>Note that there is a pre-built {@link ThreadPoolTaskScheduler} that allows for
50-
* defining a JDK 1.5 {@link java.util.concurrent.ScheduledThreadPoolExecutor} in bean style,
50+
* defining a {@link java.util.concurrent.ScheduledThreadPoolExecutor} in bean style,
5151
* exposing it as a Spring {@link org.springframework.scheduling.TaskScheduler} directly.
5252
* This is a convenient alternative to a raw ScheduledThreadPoolExecutor definition with
5353
* a separate definition of the present adapter class.
@@ -94,30 +94,30 @@ public ConcurrentTaskScheduler() {
9494
}
9595

9696
/**
97-
* Create a new ConcurrentTaskScheduler,
98-
* using the given JDK 1.5 executor as shared delegate.
97+
* Create a new ConcurrentTaskScheduler, using the given
98+
* {@link java.util.concurrent.ScheduledExecutorService} as shared delegate.
9999
* <p>Autodetects a JSR-236 {@link javax.enterprise.concurrent.ManagedScheduledExecutorService}
100100
* in order to use it for trigger-based scheduling if possible,
101101
* instead of Spring's local trigger management.
102-
* @param scheduledExecutor the JDK 1.5 scheduled executor to delegate to
103-
* for {@link org.springframework.scheduling.SchedulingTaskExecutor} as well
104-
* as {@link TaskScheduler} invocations
102+
* @param scheduledExecutor the {@link java.util.concurrent.ScheduledExecutorService}
103+
* to delegate to for {@link org.springframework.scheduling.SchedulingTaskExecutor}
104+
* as well as {@link TaskScheduler} invocations
105105
*/
106106
public ConcurrentTaskScheduler(ScheduledExecutorService scheduledExecutor) {
107107
super(scheduledExecutor);
108108
setScheduledExecutor(scheduledExecutor);
109109
}
110110

111111
/**
112-
* Create a new ConcurrentTaskScheduler,
113-
* using the given JDK 1.5 executors as delegates.
112+
* Create a new ConcurrentTaskScheduler, using the given {@link java.util.concurrent.Executor}
113+
* and {@link java.util.concurrent.ScheduledExecutorService} as delegates.
114114
* <p>Autodetects a JSR-236 {@link javax.enterprise.concurrent.ManagedScheduledExecutorService}
115115
* in order to use it for trigger-based scheduling if possible,
116116
* instead of Spring's local trigger management.
117-
* @param concurrentExecutor the JDK 1.5 concurrent executor to delegate to
117+
* @param concurrentExecutor the {@link java.util.concurrent.Executor} to delegate to
118118
* for {@link org.springframework.scheduling.SchedulingTaskExecutor} invocations
119-
* @param scheduledExecutor the JDK 1.5 scheduled executor to delegate to
120-
* for {@link TaskScheduler} invocations
119+
* @param scheduledExecutor the {@link java.util.concurrent.ScheduledExecutorService}
120+
* to delegate to for {@link TaskScheduler} invocations
121121
*/
122122
public ConcurrentTaskScheduler(Executor concurrentExecutor, ScheduledExecutorService scheduledExecutor) {
123123
super(concurrentExecutor);
@@ -126,7 +126,7 @@ public ConcurrentTaskScheduler(Executor concurrentExecutor, ScheduledExecutorSer
126126

127127

128128
/**
129-
* Specify the JDK 1.5 scheduled executor to delegate to.
129+
* Specify the {@link java.util.concurrent.ScheduledExecutorService} to delegate to.
130130
* <p>Autodetects a JSR-236 {@link javax.enterprise.concurrent.ManagedScheduledExecutorService}
131131
* in order to use it for trigger-based scheduling if possible,
132132
* instead of Spring's local trigger management.

spring-context/src/main/java/org/springframework/scheduling/concurrent/CustomizableThreadFactory.java

Lines changed: 3 additions & 3 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-2013 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.
@@ -21,8 +21,8 @@
2121
import org.springframework.util.CustomizableThreadCreator;
2222

2323
/**
24-
* Implementation of the JDK 1.5 {@link java.util.concurrent.ThreadFactory}
25-
* interface, allowing for customizing the created threads (name, priority, etc).
24+
* Implementation of the {@link java.util.concurrent.ThreadFactory} interface,
25+
* allowing for customizing the created threads (name, priority, etc).
2626
*
2727
* <p>See the base class {@link org.springframework.util.CustomizableThreadCreator}
2828
* for details on the available configuration options.

spring-context/src/main/java/org/springframework/scheduling/concurrent/ScheduledExecutorFactoryBean.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131

3232
/**
3333
* {@link org.springframework.beans.factory.FactoryBean} that sets up
34-
* a JDK 1.5 {@link java.util.concurrent.ScheduledExecutorService}
34+
* a {@link java.util.concurrent.ScheduledExecutorService}
3535
* (by default: a {@link java.util.concurrent.ScheduledThreadPoolExecutor})
3636
* and exposes it for bean references.
3737
*

spring-context/src/main/java/org/springframework/scheduling/concurrent/ScheduledExecutorTask.java

Lines changed: 4 additions & 4 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-2013 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.
@@ -23,9 +23,9 @@
2323
* {@link Runnable} and a delay plus period. The period needs to be specified;
2424
* there is no point in a default for it.
2525
*
26-
* <p>The JDK 1.5 {@link java.util.concurrent.ScheduledExecutorService} does
27-
* not offer more sophisticated scheduling options such as cron expressions.
28-
* Consider using Quartz for such advanced needs.
26+
* <p>The {@link java.util.concurrent.ScheduledExecutorService} does not offer
27+
* more sophisticated scheduling options such as cron expressions.
28+
* Consider using {@link ThreadPoolTaskScheduler} for such needs.
2929
*
3030
* <p>Note that the {@link java.util.concurrent.ScheduledExecutorService} mechanism
3131
* uses a {@link Runnable} instance that is shared between repeated executions,

spring-context/src/main/java/org/springframework/scheduling/concurrent/ThreadPoolExecutorFactoryBean.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@
3131
import org.springframework.beans.factory.InitializingBean;
3232

3333
/**
34-
* JavaBean that allows for configuring a JDK 1.5 {@link java.util.concurrent.ThreadPoolExecutor}
34+
* JavaBean that allows for configuring a {@link java.util.concurrent.ThreadPoolExecutor}
3535
* in bean style (through its "corePoolSize", "maxPoolSize", "keepAliveSeconds",
3636
* "queueCapacity" properties) and exposing it as a bean reference of its native
3737
* {@link java.util.concurrent.ExecutorService} type.
3838
*
3939
* <p>For an alternative, you may set up a ThreadPoolExecutor instance directly using
40-
* constructor injection, or use a factory method definition that points to the JDK 1.5
40+
* constructor injection, or use a factory method definition that points to the
4141
* {@link java.util.concurrent.Executors} class.
4242
*
4343
* <p><b>If you need a timing-based {@link java.util.concurrent.ScheduledExecutorService}

spring-context/src/main/java/org/springframework/scheduling/concurrent/ThreadPoolTaskExecutor.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,21 +34,21 @@
3434
import org.springframework.util.Assert;
3535

3636
/**
37-
* JavaBean that allows for configuring a JDK 1.5 {@link java.util.concurrent.ThreadPoolExecutor}
37+
* JavaBean that allows for configuring a {@link java.util.concurrent.ThreadPoolExecutor}
3838
* in bean style (through its "corePoolSize", "maxPoolSize", "keepAliveSeconds", "queueCapacity"
3939
* properties) and exposing it as a Spring {@link org.springframework.core.task.TaskExecutor}.
4040
* This class is also well suited for management and monitoring (e.g. through JMX),
4141
* providing several useful attributes: "corePoolSize", "maxPoolSize", "keepAliveSeconds"
4242
* (all supporting updates at runtime); "poolSize", "activeCount" (for introspection only).
4343
*
4444
* <p>For an alternative, you may set up a ThreadPoolExecutor instance directly using
45-
* constructor injection, or use a factory method definition that points to the JDK 1.5
45+
* constructor injection, or use a factory method definition that points to the
4646
* {@link java.util.concurrent.Executors} class. To expose such a raw Executor as a
4747
* Spring {@link org.springframework.core.task.TaskExecutor}, simply wrap it with a
4848
* {@link org.springframework.scheduling.concurrent.ConcurrentTaskExecutor} adapter.
4949
*
5050
* <p><b>NOTE:</b> This class implements Spring's
51-
* {@link org.springframework.core.task.TaskExecutor} interface as well as the JDK 1.5
51+
* {@link org.springframework.core.task.TaskExecutor} interface as well as the
5252
* {@link java.util.concurrent.Executor} interface, with the former being the primary
5353
* interface, the other just serving as secondary convenience. For this reason, the
5454
* exception handling follows the TaskExecutor contract rather than the Executor contract,

spring-context/src/main/java/org/springframework/scheduling/concurrent/package-info.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
*
3-
* Scheduling convenience classes for the JDK 1.5+ Executor mechanism
4-
* in the {@code java.util.concurrent} package, allowing to set up a
3+
* Scheduling convenience classes for the {@code java.util.concurrent}
4+
* and {@code javax.enterprise.concurrent} packages, allowing to set up a
55
* ThreadPoolExecutor or ScheduledThreadPoolExecutor as a bean in a Spring
66
* context. Provides support for the native {@code java.util.concurrent}
77
* interfaces as well as the Spring {@code TaskExecutor} mechanism.

spring-core/src/main/java/org/springframework/util/ConcurrentReferenceHashMap.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
* references at any time, so it may appear that an unknown thread is silently removing
4949
* entries.
5050
*
51-
* <p>If not explicitly specified this implementation will use
51+
* <p>If not explicitly specified, this implementation will use
5252
* {@linkplain SoftReference soft entry references}.
5353
*
5454
* @param <K> The key type
@@ -425,7 +425,6 @@ public Segment(int initialCapacity) {
425425
setReferences(createReferenceArray(this.initialSize));
426426
}
427427

428-
429428
public Reference<K, V> getReference(Object key, int hash, Restructure restructure) {
430429
if (restructure == Restructure.WHEN_NECESSARY) {
431430
restructureIfNecessary(false);
@@ -895,6 +894,7 @@ public void remove() {
895894
* The types of restructuring that can be performed.
896895
*/
897896
protected static enum Restructure {
897+
898898
WHEN_NECESSARY, NEVER
899899
}
900900

0 commit comments

Comments
 (0)