io.fluxcapacitor.common.caching.Cache Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) Flux Capacitor IP B.V. or its affiliates. All Rights Reserved.
 *
 * 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.fluxcapacitor.common.caching;

import io.fluxcapacitor.common.Registration;

import java.util.Optional;
import java.util.function.BiFunction;
import java.util.function.Consumer;
import java.util.function.Function;

public interface Cache {
    Object put(Object id, Object value);

    Object putIfAbsent(Object id, Object value);

     T computeIfAbsent(Object id, Function mappingFunction);

     T computeIfPresent(Object id, BiFunction mappingFunction);

     T compute(Object id, BiFunction mappingFunction);

     void modifyEach(BiFunction modifierFunction);

     T get(Object id);

    default  T getOrDefault(Object id, T defaultValue) {
        return Optional.ofNullable(get(id)).orElse(defaultValue);
    }

    boolean containsKey(Object id);

     T remove(Object id);

    void clear();

    int size();

    default boolean isEmpty() {
        return size() < 1;
    }

    Registration registerEvictionListener(Consumer listener);

    void close();

}