Interface SortedBidiMap

  • All Superinterfaces:
    BidiMap, IterableMap, java.util.Map, OrderedBidiMap, OrderedMap, java.util.SortedMap
    All Known Implementing Classes:
    AbstractSortedBidiMapDecorator, DualTreeBidiMap, UnmodifiableSortedBidiMap

    @Deprecated(since="2021-04-30")
    public interface SortedBidiMap
    extends OrderedBidiMap, java.util.SortedMap
    Deprecated.
    Commons Collections 3 is in maintenance mode. Commons Collections 4 should be used instead.
    Defines a map that allows bidirectional lookup between key and values and retains both keys and values in sorted order.

    Implementations should allow a value to be looked up from a key and a key to be looked up from a value with equal performance.

    Since:
    Commons Collections 3.0
    • Nested Class Summary

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>
    • Method Detail

      • inverseBidiMap

        BidiMap inverseBidiMap()
        Deprecated.
        Gets a view of this map where the keys and values are reversed.

        Changes to one map will be visible in the other and vice versa. This enables both directions of the map to be accessed equally.

        Implementations should seek to avoid creating a new object every time this method is called. See AbstractMap.values() etc. Calling this method on the inverse map should return the original.

        Implementations must return a SortedBidiMap instance, usually by forwarding to inverseSortedBidiMap().

        Specified by:
        inverseBidiMap in interface BidiMap
        Specified by:
        inverseBidiMap in interface OrderedBidiMap
        Returns:
        an inverted bidirectional map
      • inverseSortedBidiMap

        SortedBidiMap inverseSortedBidiMap()
        Deprecated.
        Gets a view of this map where the keys and values are reversed.

        Changes to one map will be visible in the other and vice versa. This enables both directions of the map to be accessed as a SortedMap.

        Implementations should seek to avoid creating a new object every time this method is called. See AbstractMap.values() etc. Calling this method on the inverse map should return the original.

        The inverse map returned by inverseBidiMap() should be the same object as returned by this method.

        Returns:
        an inverted bidirectional map