core/api/src/main/java/org/onosproject/store/service/AsyncConsistentTreeMap.java

/*
 * Copyright 2016-present Open Networking Laboratory
 *
 * 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.onosproject.store.service;

import org.onosproject.store.primitives.DefaultConsistentTreeMap;

import java.util.Map;
import java.util.NavigableSet;
import java.util.concurrent.CompletableFuture;

/**
 * API for a distributed tree map implementation.
 */
public interface AsyncConsistentTreeMap<K, V> extends AsyncConsistentMap<K, V> {

    /**
     * Return the lowest key in the map.
     *
     * @return the key or null if none exist
     */
    CompletableFuture<K> firstKey();

    /**
     * Return the highest key in the map.
     *
     * @return the key or null if none exist
     */
    CompletableFuture<K> lastKey();

    /**
     * Returns the entry associated with the least key greater than or equal to the key.
     *
     * @param key the key
     * @return the entry or null
     */
    CompletableFuture<Map.Entry<K, Versioned<V>>> ceilingEntry(K key);

    /**
     * Returns the entry associated with the greatest key less than or equal to key.
     *
     * @param key the key
     * @return the entry or null
     */
    CompletableFuture<Map.Entry<K, Versioned<V>>> floorEntry(K key);

    /**
     * Returns the entry associated with the lest key greater than key.
     *
     * @param key the key
     * @return the entry or null
     */
    CompletableFuture<Map.Entry<K, Versioned<V>>> higherEntry(K key);

    /**
     * Returns the entry associated with the largest key less than key.
     *
     * @param key the key
     * @return the entry or null
     */
    CompletableFuture<Map.Entry<K, Versioned<V>>> lowerEntry(K key);

    /**
     * Return the entry associated with the lowest key in the map.
     *
     * @return the entry or null
     */
    CompletableFuture<Map.Entry<K, Versioned<V>>> firstEntry();

    /**
     * Return the entry assocaited with the highest key in the map.
     *
     * @return the entry or null
     */
    CompletableFuture<Map.Entry<K, Versioned<V>>> lastEntry();

    /**
     * Return and remove the entry associated with the lowest key.
     *
     * @return the entry or null
     */
    CompletableFuture<Map.Entry<K, Versioned<V>>> pollFirstEntry();

    /**
     * Return and remove the entry associated with the highest key.
     *
     * @return the entry or null
     */
    CompletableFuture<Map.Entry<K, Versioned<V>>> pollLastEntry();

    /**
     * Return the entry associated with the greatest key less than key.
     *
     * @param key the key
     * @return the entry or null
     */
    CompletableFuture<K> lowerKey(K key);

    /**
     * Return the entry associated with the highest key less than or equal to key.
     *
     * @param key the key
     * @return the entry or null
     */
    CompletableFuture<K> floorKey(K key);

    /**
     * Return the lowest key greater than or equal to key.
     *
     * @param key the key
     * @return the key or null
     */
    CompletableFuture<K> ceilingKey(K key);

    /**
     * Return the lowest key greater than key.
     *
     * @param key the key
     * @return the key or null
     */
    CompletableFuture<K> higherKey(K key);

    /**
     * Returns a navigable set of the keys in this map.
     *
     * @return a navigable key set
     */
    CompletableFuture<NavigableSet<K>> navigableKeySet();

    default ConsistentTreeMap<K, V> asTreeMap() {
        return asTreeMap(DistributedPrimitive.DEFAULT_OPERTATION_TIMEOUT_MILLIS);
    }

    default ConsistentTreeMap<K, V> asTreeMap(long timeoutMillis) {
        return new DefaultConsistentTreeMap<>(this, timeoutMillis);
    }


}