Fix issue-2852 : Improve javadoc for getCacheManager() methods in Ehc…#3090
Merged
jhouserizer merged 2 commits intoehcache:masterfrom Dec 7, 2022
Merged
Fix issue-2852 : Improve javadoc for getCacheManager() methods in Ehc…#3090jhouserizer merged 2 commits intoehcache:masterfrom
jhouserizer merged 2 commits intoehcache:masterfrom
Conversation
…acheCachingProvider
chrisdennis
requested changes
Dec 1, 2022
Member
chrisdennis
left a comment
There was a problem hiding this comment.
Rather than attempting to migrate your Javadoc to where I think it needs to be with incremental changes I decided it was easier for all parties to provide the Javadoc as I think it should be. Please review, modify to your tastes, and then push the result. Feel free to ask questions if anything is unclear.
| @@ -98,8 +115,26 @@ public CacheManager getCacheManager(URI uri, Configuration config) { | |||
| } | |||
|
|
|||
| /** | |||
Member
There was a problem hiding this comment.
/**
* Requests a {@link CacheManager} configured according to the provided
* configuration be made available.
* <p>
* Multiple calls to this method with the same {@link URI} and configured
* {@link Configuration#getClassLoader() config.getClassLoader()}
* must return the same {@code CacheManager} instance,
* except if a previously returned {@code CacheManager} has been closed.
* <p>
* Properties are passed through and can be retrieved via {@link CacheManager#getProperties()}.
*
* @param uri the URI identifying the cache manager
* @param config the configuration for the cache manager
* @param properties the {@code Properties} for the cache manager
*
* @throws CacheException if a cache manager for the specified arguments could not be produced
* @throws NullPointerException if {@code uri} or {@code config} is {@code null}
*/| } | ||
|
|
||
| /** | ||
| * Enables to create a JSR-107 {@link CacheManager} based on the provided Ehcache {@link Configuration}. |
Member
There was a problem hiding this comment.
/**
* Requests a {@link CacheManager} configured according to the provided
* configuration be made available.
* <p>
* This method is shorthand for {@code getCacheManager(uri, config, new Properties())}
*
* @param uri the URI identifying the cache manager
* @param config the configuration for the cache manager
*
* @throws CacheException if a cache manager for the specified arguments could not be produced
* @throws NullPointerException if either {@code uri} or {@code config} is {@code null}
*/
chrisdennis
approved these changes
Dec 5, 2022
Member
|
@jhouserizer @AbfrmBlr can one of you guys review this since it's had too much of my hand in it for my review to be independent. |
jhouserizer
approved these changes
Dec 7, 2022
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Clarify javadoc for getCacheManager() methods in EhcacheCachingProvider.