Skip to content

Fix issue-2852 : Improve javadoc for getCacheManager() methods in Ehc… #3090

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jhouserizer merged 2 commits into from
Dec 7, 2022
+27 −10
Merged

Fix issue-2852 : Improve javadoc for getCacheManager() methods in Ehc… #3090

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
75fcd73
Fix issue-2852 : Improve javadoc for getCacheManager() methods in Ehc…
Nov 29, 2022
ed16ce1
Fix issue-2852, : Review comments are addressed
Dec 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 38 additions & 3 deletions ehcache-107/src/main/java/org/ehcache/jsr107/EhcacheCachingProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,24 @@ public CacheManager getCacheManager(URI uri, ClassLoader classLoader, Properties
}

/**
* Enables to create a JSR-107 {@link CacheManager} based on the provided Ehcache {@link Configuration}.

@chrisdennis chrisdennis Dec 1, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

/**
 * 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}
 */

* <p>
* This method behaves exactly like {@link #getCacheManager(URI, ClassLoader, Properties)}.
* </p><p>
* Requests a JSR-107 {@link CacheManager} is configured according to the specification,
* specific {@link URI} be made available that uses provided {@link ClassLoader} and
* {@link ClassLoader} is specified in the {@link Configuration}.
* </p><p>
* Multiple calls to this method with the same {@link URI} and {@link ClassLoader} will return
* the same {@link CacheManager} instance.
* If a previously returned {@link CacheManager} has been closed
* then a new {@link CacheManager} instance would be return.
* </p><p>
* {@link Configuration} is used in construction of a {@link CacheManager}
* and to form identity of the CacheManager.
* </p><p>
* If a second call is made with the same {@link URI} and {@link ClassLoader} with different properties,
* the {@link CacheManager} that was created in the first call would be returned.
* </p>
*
* @param uri the URI identifying this cache manager
* @param config the Ehcache configuration to use
Expand All @@ -98,8 +115,26 @@ public CacheManager getCacheManager(URI uri, Configuration config) {
}

/**

@chrisdennis chrisdennis Dec 1, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

/**
 * 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} with the
* provided {@link Properties}.
* <p>
* This method behaves exactly like {@link #getCacheManager(URI, ClassLoader, Properties)}.
* </p><p>
* Requests a JSR-107 {@link CacheManager} is configured according to the specification,
* specific {@link URI} be made available that uses provided {@link ClassLoader} and
* {@link ClassLoader} is specified in the {@link Configuration}.
* </p><p>
* Multiple calls to this method with the same {@link URI} and {@link ClassLoader} will return
* the same {@link CacheManager} instance.
* If a previously returned {@link CacheManager} has been closed
* then a new {@link CacheManager} instance would be return.
* </p><p>
* {@link Configuration} is used in construction of a {@link CacheManager}
* and to form identity of the CacheManager.
* </p><p>
* {@link Properties} is used in construction of a new {@link CacheManager} instance when it does not exists.
* </p><p>
* If a second call is made with the same {@link URI} and {@link ClassLoader} with different properties,
* the {@link CacheManager} that was created in the first call would be returned.
* </p>
*
* @param uri the URI identifying this cache manager
* @param config the Ehcache configuration to use
Expand Down