Skip to content

Commit

Permalink
Polish JavaDoc for JCache support
Browse files Browse the repository at this point in the history
Issue: SPR-17208
  • Loading branch information
sbrannen committed Aug 23, 2018
1 parent 253ffd7 commit 35c847a
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,15 @@ 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
*/
public JCacheCache(Cache<Object, Object> jcache) {
this(jcache, true);
}

/**
* Create a {@link org.springframework.cache.jcache.JCacheCache} instance.
* Create a {@code JCacheCache} instance.
* @param jcache backing JCache Cache instance
* @param allowNullValues whether to accept and convert null values for this cache
*/
Expand Down
Original file line number Diff line number Diff line change
@@ -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");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -45,15 +45,18 @@ public class JCacheCacheManager extends AbstractTransactionSupportingCacheManage


/**
* Create a new JCacheCacheManager, setting the target JCache CacheManager
* through the {@link #setCacheManager} bean property.
* Create a new {@code JCacheCacheManager} without a backing JCache
* {@link CacheManager javax.cache.CacheManager}.
* <p>The backing JCache {@code javax.cache.CacheManager} can be set via the
* {@link #setCacheManager} bean property.
*/
public JCacheCacheManager() {
}

/**
* Create a new JCacheCacheManager for the given backing JCache.
* @param cacheManager the backing JCache {@link CacheManager javax.cache.CacheManager}
* Create a new {@code JCacheCacheManager} for the given backing JCache
* {@link CacheManager javax.cache.CacheManager}.
* @param cacheManager the backing JCache {@code javax.cache.CacheManager}
*/
public JCacheCacheManager(CacheManager cacheManager) {
this.cacheManager = cacheManager;
Expand Down
Original file line number Diff line number Diff line change
@@ -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");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -28,9 +28,9 @@
import org.springframework.lang.Nullable;

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


/**
* Specify the URI for the desired CacheManager.
* Default is {@code null} (i.e. JCache's default).
* Specify the URI for the desired {@code CacheManager}.
* <p>Default is {@code null} (i.e. JCache's default).
*/
public void setCacheManagerUri(@Nullable URI cacheManagerUri) {
this.cacheManagerUri = cacheManagerUri;
}

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

0 comments on commit 35c847a

Please sign in to comment.