Skip to content

Commit 188e58c

Browse files
committed
Fixed javadoc links
1 parent 3be190d commit 188e58c

File tree

10 files changed

+70
-53
lines changed

10 files changed

+70
-53
lines changed

spring-context-support/src/main/java/org/springframework/cache/jcache/config/JCacheConfigurer.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@
2323
* Extension of {@link CachingConfigurer} for the JSR-107 implementation.
2424
*
2525
* <p>To be implemented by classes annotated with
26-
* @{@link org.springframework.cache.annotation.EnableCaching} that wish or
27-
* need to specify explicitly how exception caches are resolved for
26+
* {@link org.springframework.cache.annotation.EnableCaching} that wish
27+
* or need to specify explicitly how exception caches are resolved for
2828
* annotation-driven cache management. Consider extending {@link JCacheConfigurerSupport},
2929
* which provides a stub implementation of all interface methods.
3030
*
31-
* <p>See @{@link org.springframework.cache.annotation.EnableCaching} for
32-
* general examples and context; see {@link #exceptionCacheResolver()} for detailed
33-
* instructions.
31+
* <p>See {@link org.springframework.cache.annotation.EnableCaching} for
32+
* general examples and context; see {@link #exceptionCacheResolver()} for
33+
* detailed instructions.
3434
*
3535
* @author Stephane Nicoll
3636
* @since 4.1

spring-context-support/src/main/java/org/springframework/cache/jcache/interceptor/JCacheAspectSupport.java

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ public class JCacheAspectSupport extends AbstractCacheInvoker implements Initial
6969

7070
private CacheRemoveAllInterceptor cacheRemoveAllInterceptor;
7171

72+
7273
public void setCacheOperationSource(JCacheOperationSource cacheOperationSource) {
7374
Assert.notNull(cacheOperationSource);
7475
this.cacheOperationSource = cacheOperationSource;
@@ -158,9 +159,8 @@ else if (operation instanceof CacheRemoveAllOperation) {
158159
/**
159160
* Execute the underlying operation (typically in case of cache miss) and return
160161
* the result of the invocation. If an exception occurs it will be wrapped in
161-
* a {@link CacheOperationInvoker.ThrowableWrapper}: the exception can be handled
162-
* or modified but it <em>must</em> be wrapped in a
163-
* {@link CacheOperationInvoker.ThrowableWrapper} as well.
162+
* a {@code ThrowableWrapper}: the exception can be handled or modified but it
163+
* <em>must</em> be wrapped in a {@code ThrowableWrapper} as well.
164164
* @param invoker the invoker handling the operation being cached
165165
* @return the result of the invocation
166166
* @see CacheOperationInvoker#invoke()
@@ -169,15 +169,18 @@ protected Object invokeOperation(CacheOperationInvoker invoker) {
169169
return invoker.invoke();
170170
}
171171

172+
172173
private class CacheOperationInvokerAdapter implements CacheOperationInvoker {
173174

174175
private final CacheOperationInvoker delegate;
175176

176-
private CacheOperationInvokerAdapter(CacheOperationInvoker delegate) {this.delegate = delegate;}
177+
public CacheOperationInvokerAdapter(CacheOperationInvoker delegate) {
178+
this.delegate = delegate;
179+
}
177180

178181
@Override
179182
public Object invoke() throws ThrowableWrapper {
180-
return invokeOperation(delegate);
183+
return invokeOperation(this.delegate);
181184
}
182185
}
183186

spring-context-support/src/main/java/org/springframework/cache/jcache/interceptor/SimpleCacheKeyGenerator.java

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
/*
2+
* Copyright 2002-2014 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
117
package org.springframework.cache.jcache.interceptor;
218

319
import java.lang.annotation.Annotation;
@@ -13,7 +29,7 @@
1329
* the {@link javax.cache.annotation.CacheValue} one.
1430
*
1531
* @author Stephane Nicoll
16-
* @see 4.1
32+
* @since 4.1
1733
* @see javax.cache.annotation.CacheKeyInvocationContext#getKeyParameters()
1834
*/
1935
public class SimpleCacheKeyGenerator implements CacheKeyGenerator {

spring-context-support/src/main/java/org/springframework/cache/jcache/model/CacheResultOperation.java

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121

2222
import org.springframework.cache.interceptor.CacheResolver;
2323
import org.springframework.cache.interceptor.KeyGenerator;
24-
import org.springframework.util.StringUtils;
2524
import org.springframework.util.ExceptionTypeFilter;
25+
import org.springframework.util.StringUtils;
2626

2727
/**
2828
* The {@link JCacheOperation} implementation for a {@link CacheResult} operation.
@@ -47,8 +47,7 @@ public CacheResultOperation(CacheMethodDetails<CacheResult> methodDetails, Cache
4747
CacheResult ann = methodDetails.getCacheAnnotation();
4848
this.exceptionTypeFilter = createExceptionTypeFilter(ann.cachedExceptions(), ann.nonCachedExceptions());
4949
this.exceptionCacheResolver = exceptionCacheResolver;
50-
String exceptionCacheNameCandidate = ann.exceptionCacheName();
51-
this.exceptionCacheName = StringUtils.hasText(exceptionCacheNameCandidate) ? exceptionCacheNameCandidate : null;
50+
this.exceptionCacheName = (StringUtils.hasText(ann.exceptionCacheName()) ? ann.exceptionCacheName() : null);
5251
}
5352

5453

@@ -58,8 +57,8 @@ public ExceptionTypeFilter getExceptionTypeFilter() {
5857
}
5958

6059
/**
61-
* Specify if the method should always be invoked regardless of a cache hit. By
62-
* default, the method is only invoked in case of a cache miss.
60+
* Specify if the method should always be invoked regardless of a cache hit.
61+
* By default, the method is only invoked in case of a cache miss.
6362
* @see javax.cache.annotation.CacheResult#skipGet()
6463
*/
6564
public boolean isAlwaysInvoked() {
@@ -75,7 +74,7 @@ public CacheResolver getExceptionCacheResolver() {
7574
}
7675

7776
/**
78-
* Return the name of the cache to cache exceptions. Return {@link null} if
77+
* Return the name of the cache to cache exceptions, or {@code null} if
7978
* caching exceptions should be disabled.
8079
* @see javax.cache.annotation.CacheResult#exceptionCacheName()
8180
*/

spring-context-support/src/main/java/org/springframework/scheduling/quartz/SchedulerFactoryBean.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ public void setNonTransactionalDataSource(DataSource nonTransactionalDataSource)
310310
* reference into the JobDataMap but rather into the SchedulerContext.
311311
* @param schedulerContextAsMap Map with String keys and any objects as
312312
* values (for example Spring-managed beans)
313-
* @see JobDetailBean#setJobDataAsMap
313+
* @see JobDetailFactoryBean#setJobDataAsMap
314314
*/
315315
public void setSchedulerContextAsMap(Map<String, ?> schedulerContextAsMap) {
316316
this.schedulerContextMap = schedulerContextAsMap;
@@ -328,8 +328,8 @@ public void setSchedulerContextAsMap(Map<String, ?> schedulerContextAsMap) {
328328
* correspond to a "setApplicationContext" method in that scenario.
329329
* <p>Note that BeanFactory callback interfaces like ApplicationContextAware
330330
* are not automatically applied to Quartz Job instances, because Quartz
331-
* itself is reponsible for the lifecycle of its Jobs.
332-
* @see JobDetailBean#setApplicationContextJobDataKey
331+
* itself is responsible for the lifecycle of its Jobs.
332+
* @see JobDetailFactoryBean#setApplicationContextJobDataKey
333333
* @see org.springframework.context.ApplicationContext
334334
*/
335335
public void setApplicationContextSchedulerContextKey(String applicationContextSchedulerContextKey) {

spring-messaging/src/main/java/org/springframework/messaging/simp/annotation/support/SubscriptionMethodReturnValueHandler.java

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818

1919
import org.apache.commons.logging.Log;
2020
import org.apache.commons.logging.LogFactory;
21+
2122
import org.springframework.core.MethodParameter;
2223
import org.springframework.messaging.Message;
2324
import org.springframework.messaging.MessageHeaders;
@@ -56,28 +57,27 @@ public class SubscriptionMethodReturnValueHandler implements HandlerMethodReturn
5657

5758

5859
/**
59-
* Class constructor.
60-
*
61-
* @param messagingTemplate a messaging template to send messages to, most
62-
* likely the "clientOutboundChannel", must not be {@link null}.
60+
* Construct a new SubscriptionMethodReturnValueHandler.
61+
* @param messagingTemplate a messaging template to send messages to,
62+
* most likely the "clientOutboundChannel" (must not be {@code null})
6363
*/
6464
public SubscriptionMethodReturnValueHandler(MessageSendingOperations<String> messagingTemplate) {
6565
Assert.notNull(messagingTemplate, "messagingTemplate must not be null");
6666
this.messagingTemplate = messagingTemplate;
6767
}
6868

69+
6970
/**
7071
* Configure a {@link MessageHeaderInitializer} to apply to the headers of all
7172
* messages sent to the client outbound channel.
72-
*
7373
* <p>By default this property is not set.
7474
*/
7575
public void setHeaderInitializer(MessageHeaderInitializer headerInitializer) {
7676
this.headerInitializer = headerInitializer;
7777
}
7878

7979
/**
80-
* @return the configured header initializer.
80+
* Return the configured header initializer.
8181
*/
8282
public MessageHeaderInitializer getHeaderInitializer() {
8383
return this.headerInitializer;
@@ -86,16 +86,17 @@ public MessageHeaderInitializer getHeaderInitializer() {
8686

8787
@Override
8888
public boolean supportsReturnType(MethodParameter returnType) {
89-
return ((returnType.getMethodAnnotation(SubscribeMapping.class) != null)
90-
&& (returnType.getMethodAnnotation(SendTo.class) == null)
91-
&& (returnType.getMethodAnnotation(SendToUser.class) == null));
89+
return (returnType.getMethodAnnotation(SubscribeMapping.class) != null &&
90+
returnType.getMethodAnnotation(SendTo.class) == null &&
91+
returnType.getMethodAnnotation(SendToUser.class) == null);
9292
}
9393

9494
@Override
9595
public void handleReturnValue(Object returnValue, MethodParameter returnType, Message<?> message) throws Exception {
9696
if (returnValue == null) {
9797
return;
9898
}
99+
99100
MessageHeaders headers = message.getHeaders();
100101
String destination = SimpMessageHeaderAccessor.getDestination(headers);
101102
String sessionId = SimpMessageHeaderAccessor.getSessionId(headers);

spring-messaging/src/main/java/org/springframework/messaging/simp/broker/AbstractBrokerMessageHandler.java

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
* @since 4.0
4040
*/
4141
public abstract class AbstractBrokerMessageHandler
42-
implements MessageHandler, SmartLifecycle, ApplicationEventPublisherAware {
42+
implements MessageHandler, ApplicationEventPublisherAware, SmartLifecycle {
4343

4444
protected final Log logger = LogFactory.getLog(getClass());
4545

@@ -56,10 +56,10 @@ public abstract class AbstractBrokerMessageHandler
5656

5757
private boolean autoStartup = true;
5858

59-
private Object lifecycleMonitor = new Object();
60-
6159
private volatile boolean running = false;
6260

61+
private final Object lifecycleMonitor = new Object();
62+
6363

6464
public AbstractBrokerMessageHandler() {
6565
this(Collections.<String>emptyList());
@@ -100,7 +100,6 @@ public int getPhase() {
100100

101101
/**
102102
* Check whether this message handler is currently running.
103-
*
104103
* <p>Note that even when this message handler is running the
105104
* {@link #isBrokerAvailable()} flag may still independently alternate between
106105
* being on and off depending on the concrete sub-class implementation.
@@ -112,23 +111,6 @@ public final boolean isRunning() {
112111
}
113112
}
114113

115-
/**
116-
* Whether the message broker is currently available and able to process messages.
117-
*
118-
* <p>Note that this is in addition to the {@link #isRunning()} flag, which
119-
* indicates whether this message handler is running. In other words the message
120-
* handler must first be running and then the {@link #isBrokerAvailable()} flag
121-
* may still independently alternate between being on and off depending on the
122-
* concrete sub-class implementation.
123-
*
124-
* <p>Application components may implement
125-
* {@link org.springframework.context.ApplicationListener<BrokerAvailabilityEvent>>}
126-
* to receive notifications when broker becomes available and unavailable.
127-
*/
128-
public boolean isBrokerAvailable() {
129-
return this.brokerAvailable.get();
130-
}
131-
132114
@Override
133115
public void start() {
134116
synchronized (this.lifecycleMonitor) {
@@ -171,6 +153,22 @@ public final void stop(Runnable callback) {
171153
}
172154
}
173155

156+
/**
157+
* Whether the message broker is currently available and able to process messages.
158+
* <p>Note that this is in addition to the {@link #isRunning()} flag, which
159+
* indicates whether this message handler is running. In other words the message
160+
* handler must first be running and then the {@code #isBrokerAvailable()} flag
161+
* may still independently alternate between being on and off depending on the
162+
* concrete sub-class implementation.
163+
* <p>Application components may implement
164+
* {@code org.springframework.context.ApplicationListener&lt;BrokerAvailabilityEvent&gt;}
165+
* to receive notifications when broker becomes available and unavailable.
166+
*/
167+
public boolean isBrokerAvailable() {
168+
return this.brokerAvailable.get();
169+
}
170+
171+
174172
@Override
175173
public void handleMessage(Message<?> message) {
176174
if (!this.running) {

spring-messaging/src/main/java/org/springframework/messaging/support/IdTimestampMessageHeaderInitializer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public class IdTimestampMessageHeaderInitializer implements MessageHeaderInitial
4040
* instances with.
4141
* <p>By default this property is set to {@code null} in which case the default
4242
* IdGenerator of {@link org.springframework.messaging.MessageHeaders} is used.
43-
* <p>To have no id's generated at all, see {@@link #setDisableIdGeneration()}.
43+
* <p>To have no id's generated at all, see {@link #setDisableIdGeneration()}.
4444
*/
4545
public void setIdGenerator(IdGenerator idGenerator) {
4646
this.idGenerator = idGenerator;

spring-web/src/main/java/org/springframework/http/converter/json/Jackson2ObjectMapperFactoryBean.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,7 @@ public void setFindModulesViaServiceLoader(boolean findModules) {
341341
/**
342342
* Specify a {@link com.fasterxml.jackson.databind.PropertyNamingStrategy} to
343343
* configure the {@link ObjectMapper} with.
344-
* @@since 4.0.2
344+
* @since 4.0.2
345345
*/
346346
public void setPropertyNamingStrategy(PropertyNamingStrategy propertyNamingStrategy) {
347347
this.propertyNamingStrategy = propertyNamingStrategy;

spring-webmvc-tiles2/src/main/java/org/springframework/web/servlet/view/tiles2/TilesConfigurer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ public void afterPropertiesSet() throws TilesException {
257257
}
258258

259259
/**
260-
* Creates a new instance of {@link SpringTilesInitializer}.
260+
* Creates a new instance of {@code SpringTilesInitializer}.
261261
* <p>Override it to use a different initializer.
262262
* @see org.apache.tiles.web.startup.AbstractTilesListener#createTilesInitializer()
263263
*/

0 commit comments

Comments
 (0)