Browse Source

Polish JavaDoc for JCache support

Issue: SPR-17208
pull/1940/merge
Sam Brannen 7 years ago
parent
commit
35c847a708
  1. 4
      spring-context-support/src/main/java/org/springframework/cache/jcache/JCacheCache.java
  2. 13
      spring-context-support/src/main/java/org/springframework/cache/jcache/JCacheCacheManager.java
  3. 16
      spring-context-support/src/main/java/org/springframework/cache/jcache/JCacheManagerFactoryBean.java

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

@ -42,7 +42,7 @@ public class JCacheCache extends AbstractValueAdaptingCache {
/** /**
* Create a {@link org.springframework.cache.jcache.JCacheCache} instance. * Create a {@code JCacheCache} instance.
* @param jcache backing JCache Cache instance * @param jcache backing JCache Cache instance
*/ */
public JCacheCache(Cache<Object, Object> jcache) { public JCacheCache(Cache<Object, Object> jcache) {
@ -50,7 +50,7 @@ public class JCacheCache extends AbstractValueAdaptingCache {
} }
/** /**
* Create a {@link org.springframework.cache.jcache.JCacheCache} instance. * Create a {@code JCacheCache} instance.
* @param jcache backing JCache Cache instance * @param jcache backing JCache Cache instance
* @param allowNullValues whether to accept and convert null values for this cache * @param allowNullValues whether to accept and convert null values for this cache
*/ */

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

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2017 the original author or authors. * Copyright 2002-2018 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -45,15 +45,18 @@ public class JCacheCacheManager extends AbstractTransactionSupportingCacheManage
/** /**
* Create a new JCacheCacheManager, setting the target JCache CacheManager * Create a new {@code JCacheCacheManager} without a backing JCache
* through the {@link #setCacheManager} bean property. * {@link CacheManager javax.cache.CacheManager}.
* <p>The backing JCache {@code javax.cache.CacheManager} can be set via the
* {@link #setCacheManager} bean property.
*/ */
public JCacheCacheManager() { public JCacheCacheManager() {
} }
/** /**
* Create a new JCacheCacheManager for the given backing JCache. * Create a new {@code JCacheCacheManager} for the given backing JCache
* @param cacheManager the backing JCache {@link CacheManager javax.cache.CacheManager} * {@link CacheManager javax.cache.CacheManager}.
* @param cacheManager the backing JCache {@code javax.cache.CacheManager}
*/ */
public JCacheCacheManager(CacheManager cacheManager) { public JCacheCacheManager(CacheManager cacheManager) {
this.cacheManager = cacheManager; this.cacheManager = cacheManager;

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

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2017 the original author or authors. * Copyright 2002-2018 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -28,9 +28,9 @@ import org.springframework.beans.factory.InitializingBean;
import org.springframework.lang.Nullable; import org.springframework.lang.Nullable;
/** /**
* {@link FactoryBean} for a JCache {@link javax.cache.CacheManager}, * {@link FactoryBean} for a JCache {@link CacheManager javax.cache.CacheManager},
* obtaining a pre-defined CacheManager by name through the standard * obtaining a pre-defined {@code CacheManager} by name through the standard
* JCache {@link javax.cache.Caching} class. * JCache {@link Caching javax.cache.Caching} class.
* *
* <p>Note: This class has been updated for JCache 1.0, as of Spring 4.0. * <p>Note: This class has been updated for JCache 1.0, as of Spring 4.0.
* *
@ -56,16 +56,16 @@ public class JCacheManagerFactoryBean
/** /**
* Specify the URI for the desired CacheManager. * Specify the URI for the desired {@code CacheManager}.
* Default is {@code null} (i.e. JCache's default). * <p>Default is {@code null} (i.e. JCache's default).
*/ */
public void setCacheManagerUri(@Nullable URI cacheManagerUri) { public void setCacheManagerUri(@Nullable URI cacheManagerUri) {
this.cacheManagerUri = cacheManagerUri; this.cacheManagerUri = cacheManagerUri;
} }
/** /**
* Specify properties for the to-be-created CacheManager. * Specify properties for the to-be-created {@code CacheManager}.
* Default is {@code null} (i.e. no special properties to apply). * <p>Default is {@code null} (i.e. no special properties to apply).
* @see javax.cache.spi.CachingProvider#getCacheManager(URI, ClassLoader, Properties) * @see javax.cache.spi.CachingProvider#getCacheManager(URI, ClassLoader, Properties)
*/ */
public void setCacheManagerProperties(@Nullable Properties cacheManagerProperties) { public void setCacheManagerProperties(@Nullable Properties cacheManagerProperties) {

Loading…
Cancel
Save