/*
 * Copyright 2002-2019 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.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.cache;

import java.util.Collection;

import org.springframework.lang.Nullable;

Spring's central cache manager SPI.

Allows for retrieving named Cache regions.

Author:Costin Leau, Sam Brannen
Since:3.1
/** * Spring's central cache manager SPI. * * <p>Allows for retrieving named {@link Cache} regions. * * @author Costin Leau * @author Sam Brannen * @since 3.1 */
public interface CacheManager {
Get the cache associated with the given name.

Note that the cache may be lazily created at runtime if the native provider supports it.

Params:
  • name – the cache identifier (must not be null)
Returns:the associated cache, or null if such a cache does not exist or could be not created
/** * Get the cache associated with the given name. * <p>Note that the cache may be lazily created at runtime if the * native provider supports it. * @param name the cache identifier (must not be {@code null}) * @return the associated cache, or {@code null} if such a cache * does not exist or could be not created */
@Nullable Cache getCache(String name);
Get a collection of the cache names known by this manager.
Returns:the names of all caches known by the cache manager
/** * Get a collection of the cache names known by this manager. * @return the names of all caches known by the cache manager */
Collection<String> getCacheNames(); }