Package org.rocksdb.util

Class IntComparator

  • All Implemented Interfaces:
    java.lang.AutoCloseable
    public final class IntComparator
extends AbstractComparator
    This is a Java implementation of a Comparator for Java int keys. This comparator assumes keys are (at least) four bytes, so the caller must guarantee that in accessing other APIs in combination with this comparator. The performance of Comparators implemented in Java is always less than their C++ counterparts due to the bridging overhead, as such you likely don't want to use this apart from benchmarking or testing.

    • Method Detail

      • name

        public java.lang.String name()
        Description copied from class: AbstractComparator
        The name of the comparator. Used to check for comparator mismatches (i.e., a DB created with one comparator is accessed using a different comparator). A new name should be used whenever the comparator implementation changes in a way that will cause the relative ordering of any two keys to change. Names starting with "rocksdb." are reserved and should not be used.
        Specified by:
        name in class AbstractComparator
        Returns:
        The name of this comparator implementation

      • compare

        public int compare​(java.nio.ByteBuffer a,
                   java.nio.ByteBuffer b)
        Description copied from class: AbstractComparator
        Three-way key comparison. Implementations should provide a total order on keys that might be passed to it. The implementation may modify the ByteBuffers passed in, though it would be unconventional to modify the "limit" or any of the underlying bytes. As a callback, RocksJava will ensure that a is a different instance from b.
        Specified by:
        compare in class AbstractComparator
        Parameters:
        a - buffer containing the first key in its "remaining" elements
        b - buffer containing the second key in its "remaining" elements
        Returns:
        Should return either: 1) < 0 if "a" < "b" 2) == 0 if "a" == "b" 3) > 0 if "a" > "b"