hazelcast-master/hazelcast/src/main/java/com/hazelcast/internal/eviction/EvictionChecker.java
/*
 * Copyright (c) 2008-2023, Hazelcast, Inc. 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 com.hazelcast.internal.eviction;

import com.hazelcast.config.MaxSizePolicy;

/**
 * Checks whether a specific max size threshold is exceeded or not
 * according to configured {@link MaxSizePolicy}
 * and indicates whether eviction is required.
 */
public interface EvictionChecker {

    EvictionChecker EVICT_ALWAYS = () -> true;

    /**
     * Checks the state to see if it has reached its maximum configured size
     * {@link MaxSizePolicy}
     *
     * @return <code>true</code> if maximum size has been reached, <code>false</code> otherwise
     */
    boolean isEvictionRequired();

}
