org.restheart.cache.Cache Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of restheart-commons Show documentation

RESTHeart Commons - Common classes for core components and plugins.

There is a newer version: 8.1.7

/*-
 * ========================LICENSE_START=================================
 * restheart-commons
 * %%
 * Copyright (C) 2019 - 2024 SoftInstigate
 * %%
 * 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.
 * =========================LICENSE_END==================================
 */
package org.restheart.cache;

import java.util.Map;
import java.util.Optional;

/**
 *
 * @author Andrea Di Cesare {@literal }
 * @param  the class of the keys
 * @param  the class of the values
 */
public interface Cache {
    public enum EXPIRE_POLICY {
        NEVER, AFTER_WRITE, AFTER_READ
    }

    public Optional get(K key);

    public Optional remove(K key);

    public void put(K key, V value);

    /**
     * Performs any pending maintenance operations needed by the cache.
     */
    public void cleanUp();

    public void invalidate(K key);

    public void invalidateAll();

    public Map> asMap();
}