org.redisson.api.map.MapLoaderAsync Maven / Gradle / Ivy

Go to download

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

Easy Redis Java client and Real-Time Data Platform. Valkey compatible. Sync/Async/RxJava3/Reactive API. Client side caching. Over 50 Redis based Java objects and services: JCache API, Apache Tomcat, Hibernate, Spring, Set, Multimap, SortedSet, Map, List, Queue, Deque, Semaphore, Lock, AtomicLong, Map Reduce, Bloom filter, Scheduler, RPC

There is a newer version: 3.40.2

Show newest version

/**
 * Copyright (c) 2013-2024 Nikita Koksharov
 *
 * 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.redisson.api.map;

import org.redisson.api.AsyncIterator;
import org.redisson.api.RMap;

import java.util.concurrent.CompletionStage;

/**
 * Map loader used for read-through operations or during {@link RMap#loadAll} execution.
 * 
 * @author Nikita Koksharov
 *
 * @param  key type
 * @param  value type
 */
public interface MapLoaderAsync {

    /**
     * Loads map value by key.
     * 
     * @param key - map key
     * @return value or null if value doesn't exists
     */
    CompletionStage load(K key);
    
    /**
     * Loads all keys.
     * 
     * @return Iterable object. It's helpful if all keys don't fit in memory.
     */
    AsyncIterator loadAllKeys();
    
}