root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 15 Packages Projects Releases Wiki Activity

Merge pull request #14969 from dreis2211 

* pr/14969:
  Polish javadoc of CachesEndpoint
This commit is contained in:
Stephane Nicoll 2018-10-26 07:33:43 +09:00
parent 5a4220c773 5b6e94d78a
commit a43728d9d8
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/cache/CachesEndpoint.java vendored
View File

@ -74,10 +74,10 @@ public class CachesEndpoint {
/** /**
* Return a {@link CacheDescriptor} for the specified cache. * Return a {@link CacheDescriptor} for the specified cache.
* @param cache then name of the cache * @param cache the name of the cache
* @param cacheManager the name of the cacheManager (can be {@code null} * @param cacheManager the name of the cacheManager (can be {@code null}
* @return the descriptor of the cache or {@code null} if no such cache exists * @return the descriptor of the cache or {@code null} if no such cache exists
* @throws NonUniqueCacheException if more than one cache with that name exist and no * @throws NonUniqueCacheException if more than one cache with that name exists and no
* {@code cacheManager} was provided to identify a unique candidate * {@code cacheManager} was provided to identify a unique candidate
*/ */
@ReadOperation @ReadOperation
@ -96,11 +96,12 @@ public class CachesEndpoint {
/** /**
* Clear the specific {@link Cache}. * Clear the specific {@link Cache}.
* @param cache then name of the cache * @param cache the name of the cache
* @param cacheManager the name of the cacheManager (can be {@code null} to match all) * @param cacheManager the name of the cacheManager (can be {@code null} to match all)
* @return {@code true} if the cache was cleared or {@code false} if no such cache * @return {@code true} if the cache was cleared or {@code false} if no such cache
* exists * exists
* @throws NonUniqueCacheException if more than one cache with that name exist and no * @throws NonUniqueCacheException if more than one cache with that name exists and no
* {@code cacheManager} was provided to identify a unique candidate
*/ */
@DeleteOperation @DeleteOperation
public boolean clearCache(@Selector String cache, @Nullable String cacheManager) { public boolean clearCache(@Selector String cache, @Nullable String cacheManager) {