All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.redisson.api.RMultimapReactive Maven / Gradle / Ivy

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;

import java.util.Set;

import reactor.core.publisher.Mono;

/**
 * Base Reactive interface for Multimap object
 * 
 * @author Nikita Koksharov
 *
 * @param  key type
 * @param  value type
 */
public interface RMultimapReactive extends RExpirableReactive {

    /**
     * Returns the number of key-value pairs in this multimap.
     *
     * @return size of multimap
     */
    Mono size();

    /**
     * Returns {@code true} if this multimap contains at least one key-value pair
     * with the key {@code key}.
     * 
     * @param key - map key
     * @return true if contains a key
     */
    Mono containsKey(Object key);

    /**
     * Returns {@code true} if this multimap contains at least one key-value pair
     * with the value {@code value}.
     * 
     * @param value - map value
     * @return true if contains a value
     */
    Mono containsValue(Object value);

    /**
     * Returns {@code true} if this multimap contains at least one key-value pair
     * with the key {@code key} and the value {@code value}.
     * 
     * @param key - map key
     * @param value - map value
     * @return true if contains an entry
     */
    Mono containsEntry(Object key, Object value);

    /**
     * Stores a key-value pair in this multimap.
     *
     * 

Some multimap implementations allow duplicate key-value pairs, in which * case {@code put} always adds a new key-value pair and increases the * multimap size by 1. Other implementations prohibit duplicates, and storing * a key-value pair that's already in the multimap has no effect. * * @param key - map key * @param value - map value * @return {@code true} if the method increased the size of the multimap, or * {@code false} if the multimap already contained the key-value pair and * doesn't allow duplicates */ Mono put(K key, V value); /** * Removes a single key-value pair with the key {@code key} and the value * {@code value} from this multimap, if such exists. If multiple key-value * pairs in the multimap fit this description, which one is removed is * unspecified. * * @param key - map key * @param value - map value * @return {@code true} if the multimap changed */ Mono remove(Object key, Object value); // Bulk Operations /** * Stores a key-value pair in this multimap for each of {@code values}, all * using the same key, {@code key}. Equivalent to (but expected to be more * efficient than):

   {@code
     *
     *   for (V value : values) {
     *     put(key, value);
     *   }}
* *

In particular, this is a no-op if {@code values} is empty. * * @param key - map key * @param values - map values * @return {@code true} if the multimap changed */ Mono putAll(K key, Iterable values); /** * Returns the number of key-value pairs in this multimap. * * @return keys amount */ Mono keySize(); /** * Stores a collection of values with the same key, replacing any existing * values for that key. Is faster by not returning the values. * * @param key - map key * @param values - map values */ Mono fastReplaceValues(K key, Iterable values); /** * Removes keys from map by one operation * * Works faster than RMultimap.remove but not returning * the value associated with key * * @param keys - map keys * @return the number of keys that were removed from the hash, not including specified but non existing keys */ Mono fastRemove(K... keys); /** * Removes values from map by one operation * * @param values map values * @return the number of values that were removed from the map */ Mono fastRemoveValue(V... values); /** * Read all keys at once * * @return keys */ Mono> readAllKeySet(); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy