Package org.onosproject.store.service

Interface AsyncConsistentTreeMap<V>

    • Method Detail

      • firstKey

        java.util.concurrent.CompletableFuture<java.lang.String> firstKey()
        Return the lowest key in the map.
        Returns:
        the key or null if none exist

      • lastKey

        java.util.concurrent.CompletableFuture<java.lang.String> lastKey()
        Return the highest key in the map.
        Returns:
        the key or null if none exist

      • ceilingEntry

        java.util.concurrent.CompletableFuture<java.util.Map.Entry<java.lang.String,​Versioned<V>>> ceilingEntry​(java.lang.String key)
        Returns the entry associated with the least key greater than or equal to the key.
        Parameters:
        key - the key
        Returns:
        the entry or null if no suitable key exists

      • floorEntry

        java.util.concurrent.CompletableFuture<java.util.Map.Entry<java.lang.String,​Versioned<V>>> floorEntry​(java.lang.String key)
        Returns the entry associated with the greatest key less than or equal to key.
        Parameters:
        key - the key
        Returns:
        the entry or null if no suitable key exists

      • higherEntry

        java.util.concurrent.CompletableFuture<java.util.Map.Entry<java.lang.String,​Versioned<V>>> higherEntry​(java.lang.String key)
        Returns the entry associated with the least key greater than key.
        Parameters:
        key - the key
        Returns:
        the entry or null if no suitable key exists

      • lowerEntry

        java.util.concurrent.CompletableFuture<java.util.Map.Entry<java.lang.String,​Versioned<V>>> lowerEntry​(java.lang.String key)
        Returns the entry associated with the largest key less than key.
        Parameters:
        key - the key
        Returns:
        the entry or null if no suitable key exists

      • firstEntry

        java.util.concurrent.CompletableFuture<java.util.Map.Entry<java.lang.String,​Versioned<V>>> firstEntry()
        Return the entry associated with the lowest key in the map.
        Returns:
        the entry or null if none exist

      • lastEntry

        java.util.concurrent.CompletableFuture<java.util.Map.Entry<java.lang.String,​Versioned<V>>> lastEntry()
        Return the entry associated with the highest key in the map.
        Returns:
        the entry or null if none exist

      • pollFirstEntry

        java.util.concurrent.CompletableFuture<java.util.Map.Entry<java.lang.String,​Versioned<V>>> pollFirstEntry()
        Return and remove the entry associated with the lowest key.
        Returns:
        the entry or null if none exist

      • pollLastEntry

        java.util.concurrent.CompletableFuture<java.util.Map.Entry<java.lang.String,​Versioned<V>>> pollLastEntry()
        Return and remove the entry associated with the highest key.
        Returns:
        the entry or null if none exist

      • lowerKey

        java.util.concurrent.CompletableFuture<java.lang.String> lowerKey​(java.lang.String key)
        Return the entry associated with the greatest key less than key.
        Parameters:
        key - the key
        Returns:
        the entry or null if no suitable key exists

      • floorKey

        java.util.concurrent.CompletableFuture<java.lang.String> floorKey​(java.lang.String key)
        Return the highest key less than or equal to key.
        Parameters:
        key - the key
        Returns:
        the entry or null if no suitable key exists

      • ceilingKey

        java.util.concurrent.CompletableFuture<java.lang.String> ceilingKey​(java.lang.String key)
        Return the lowest key greater than or equal to key.
        Parameters:
        key - the key
        Returns:
        the entry or null if no suitable key exists

      • higherKey

        java.util.concurrent.CompletableFuture<java.lang.String> higherKey​(java.lang.String key)
        Return the lowest key greater than key.
        Parameters:
        key - the key
        Returns:
        the entry or null if no suitable key exists

      • navigableKeySet

        java.util.concurrent.CompletableFuture<java.util.NavigableSet<java.lang.String>> navigableKeySet()
        Returns a navigable set of the keys in this map.
        Returns:
        a navigable key set (this may be empty)

      • subMap

        java.util.concurrent.CompletableFuture<java.util.NavigableMap<java.lang.String,​V>> subMap​(java.lang.String upperKey,
                                                                                                java.lang.String lowerKey,
                                                                                                boolean inclusiveUpper,
                                                                                                boolean inclusiveLower)
        Returns a navigable map containing the entries from the original map which are larger than (or if specified equal to) lowerKey AND less than (or if specified equal to) upperKey.
        Parameters:
        upperKey - the upper bound for the keys in this map
        lowerKey - the lower bound for the keys in this map
        inclusiveUpper - whether keys equal to the upperKey should be included
        inclusiveLower - whether keys equal to the lowerKey should be included
        Returns:
        a navigable map containing entries in the specified range (this may be empty)