io.micronaut.cache.CacheManager Maven / Gradle / Ivy
/*
* Copyright 2017-2019 original 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
*
* http://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 io.micronaut.cache;
import javax.annotation.Nonnull;
import java.util.Set;
/**
* Simple CacheManager interface for managing caches.
*
* @param The native cache implementation
*
* @author Graeme Rocher
* @since 1.0
*/
public interface CacheManager {
/**
* @return The names of the active caches
*/
@Nonnull
Set getCacheNames();
/**
* Retrieve a cache for the given name.
*
* @param name The name of the cache
* @return The {@link SyncCache} instance
* @throws io.micronaut.context.exceptions.ConfigurationException If no cache is found for the given name
*/
@Nonnull SyncCache getCache(String name);
}