001/*
002 * Copyright 2002-2018 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.cache.interceptor;
018
019import java.util.Collection;
020
021import org.springframework.cache.Cache;
022import org.springframework.cache.CacheManager;
023import org.springframework.lang.Nullable;
024
025/**
026 * A simple {@link CacheResolver} that resolves the {@link Cache} instance(s)
027 * based on a configurable {@link CacheManager} and the name of the
028 * cache(s) as provided by {@link BasicOperation#getCacheNames() getCacheNames()}.
029 *
030 * @author Stephane Nicoll
031 * @author Juergen Hoeller
032 * @since 4.1
033 * @see BasicOperation#getCacheNames()
034 */
035public class SimpleCacheResolver extends AbstractCacheResolver {
036
037        /**
038         * Construct a new {@code SimpleCacheResolver}.
039         * @see #setCacheManager
040         */
041        public SimpleCacheResolver() {
042        }
043
044        /**
045         * Construct a new {@code SimpleCacheResolver} for the given {@link CacheManager}.
046         * @param cacheManager the CacheManager to use
047         */
048        public SimpleCacheResolver(CacheManager cacheManager) {
049                super(cacheManager);
050        }
051
052
053        @Override
054        protected Collection<String> getCacheNames(CacheOperationInvocationContext<?> context) {
055                return context.getOperation().getCacheNames();
056        }
057
058
059        /**
060         * Return a {@code SimpleCacheResolver} for the given {@link CacheManager}.
061         * @param cacheManager the CacheManager (potentially {@code null})
062         * @return the SimpleCacheResolver ({@code null} if the CacheManager was {@code null})
063         * @since 5.1
064         */
065        @Nullable
066        static SimpleCacheResolver of(@Nullable CacheManager cacheManager) {
067                return (cacheManager != null ? new SimpleCacheResolver(cacheManager) : null);
068        }
069
070}