Skip to content

Commit 35c847a

Browse files
committed
Polish JavaDoc for JCache support
Issue: SPR-17208
1 parent 253ffd7 commit 35c847a

File tree

3 files changed

+18
-15
lines changed

3 files changed

+18
-15
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,15 @@ public class JCacheCache extends AbstractValueAdaptingCache {
4242

4343

4444
/**
45-
* Create a {@link org.springframework.cache.jcache.JCacheCache} instance.
45+
* Create a {@code JCacheCache} instance.
4646
* @param jcache backing JCache Cache instance
4747
*/
4848
public JCacheCache(Cache<Object, Object> jcache) {
4949
this(jcache, true);
5050
}
5151

5252
/**
53-
* Create a {@link org.springframework.cache.jcache.JCacheCache} instance.
53+
* Create a {@code JCacheCache} instance.
5454
* @param jcache backing JCache Cache instance
5555
* @param allowNullValues whether to accept and convert null values for this cache
5656
*/

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

Lines changed: 8 additions & 5 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-2018 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,15 +45,18 @@ public class JCacheCacheManager extends AbstractTransactionSupportingCacheManage
4545

4646

4747
/**
48-
* Create a new JCacheCacheManager, setting the target JCache CacheManager
49-
* through the {@link #setCacheManager} bean property.
48+
* Create a new {@code JCacheCacheManager} without a backing JCache
49+
* {@link CacheManager javax.cache.CacheManager}.
50+
* <p>The backing JCache {@code javax.cache.CacheManager} can be set via the
51+
* {@link #setCacheManager} bean property.
5052
*/
5153
public JCacheCacheManager() {
5254
}
5355

5456
/**
55-
* Create a new JCacheCacheManager for the given backing JCache.
56-
* @param cacheManager the backing JCache {@link CacheManager javax.cache.CacheManager}
57+
* Create a new {@code JCacheCacheManager} for the given backing JCache
58+
* {@link CacheManager javax.cache.CacheManager}.
59+
* @param cacheManager the backing JCache {@code javax.cache.CacheManager}
5760
*/
5861
public JCacheCacheManager(CacheManager cacheManager) {
5962
this.cacheManager = cacheManager;

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

Lines changed: 8 additions & 8 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-2018 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,9 +28,9 @@
2828
import org.springframework.lang.Nullable;
2929

3030
/**
31-
* {@link FactoryBean} for a JCache {@link javax.cache.CacheManager},
32-
* obtaining a pre-defined CacheManager by name through the standard
33-
* JCache {@link javax.cache.Caching} class.
31+
* {@link FactoryBean} for a JCache {@link CacheManager javax.cache.CacheManager},
32+
* obtaining a pre-defined {@code CacheManager} by name through the standard
33+
* JCache {@link Caching javax.cache.Caching} class.
3434
*
3535
* <p>Note: This class has been updated for JCache 1.0, as of Spring 4.0.
3636
*
@@ -56,16 +56,16 @@ public class JCacheManagerFactoryBean
5656

5757

5858
/**
59-
* Specify the URI for the desired CacheManager.
60-
* Default is {@code null} (i.e. JCache's default).
59+
* Specify the URI for the desired {@code CacheManager}.
60+
* <p>Default is {@code null} (i.e. JCache's default).
6161
*/
6262
public void setCacheManagerUri(@Nullable URI cacheManagerUri) {
6363
this.cacheManagerUri = cacheManagerUri;
6464
}
6565

6666
/**
67-
* Specify properties for the to-be-created CacheManager.
68-
* Default is {@code null} (i.e. no special properties to apply).
67+
* Specify properties for the to-be-created {@code CacheManager}.
68+
* <p>Default is {@code null} (i.e. no special properties to apply).
6969
* @see javax.cache.spi.CachingProvider#getCacheManager(URI, ClassLoader, Properties)
7070
*/
7171
public void setCacheManagerProperties(@Nullable Properties cacheManagerProperties) {

0 commit comments

Comments
 (0)