Cache.java

/*
 * Copyright 2014 Red Hat, Inc. and/or its affiliates.
 *
 * 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 org.guvnor.common.services.backend.cache;

/**
 * Define operations of a cache
 */
public interface Cache<K, V> {

    /**
     * Retrieve the cache entry for the specified key.
     * @param key The cache entry key
     * @return V The cache entry
     */
    V getEntry( final K key );

    /**
     * Set the cache entry for the specified path.
     * @param key The cache entry key
     * @param value The cache entry
     */
    void setEntry( final K key,
                   final V value );

    /**
     * Invalidate the entire cache
     */
    void invalidateCache();

    /**
     * Invalidate the cache for a specific key.
     * @param key The cache entry key
     */
    void invalidateCache( final K key );
}