Enum ClusteringPrefix.Kind

    • Field Detail

      • comparedToClustering

        public final int comparedToClustering
        Return the comparison of this kind to CLUSTERING. For bounds/boundaries, this basically tells us if we sort before or after our clustering values.
    • Method Detail

      • values

        public static ClusteringPrefix.Kind[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (ClusteringPrefix.Kind c : ClusteringPrefix.Kind.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ClusteringPrefix.Kind valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • compare

        public static int compare​(ClusteringPrefix.Kind k1,
                                  ClusteringPrefix.Kind k2)
        Compares the 2 provided kind.

        Note: this should be used instead of Enum.compareTo(E) when comparing clustering prefixes. We do not override that latter method because it is final for an enum.

      • invert

        public ClusteringPrefix.Kind invert()
        Returns the inverse of the current kind.

        This invert both start into end (and vice-versa) and inclusive into exclusive (and vice-versa).

        Returns:
        the invert of this kind. For instance, if this kind is an exlusive start, this return an inclusive end.
      • isBound

        public boolean isBound()
      • isBoundary

        public boolean isBoundary()
      • isStart

        public boolean isStart()
      • isEnd

        public boolean isEnd()
      • isOpen

        public boolean isOpen​(boolean reversed)
      • isClose

        public boolean isClose​(boolean reversed)