Package org.spongepowered.api.data

Enum KeyValueMatcher.Operator

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      EQUAL
      Matches when the key and the matcher values are equal.
      EXCLUDES
      Matches when the key is excluded from the matcher value.
      GREATER
      Matches when the key value is greater compared to the matcher value.
      GREATER_OR_EQUAL
      Matches when the key value is greater or equal compared to the matcher value.
      INCLUDES
      Matches when the key value is included in the matcher value.
      LESS
      Matches when the key value is less compared to the matcher value.
      LESS_OR_EQUAL
      Matches when the key value is less or equal compared to the matcher value.
      NOT_EQUAL
      Matches when the key and the matcher values are equal.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static KeyValueMatcher.Operator valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static KeyValueMatcher.Operator[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • NOT_EQUAL

        public static final KeyValueMatcher.Operator NOT_EQUAL
        Matches when the key and the matcher values are equal.

      • GREATER

        public static final KeyValueMatcher.Operator GREATER
        Matches when the key value is greater compared to the matcher value.

      • GREATER_OR_EQUAL

        public static final KeyValueMatcher.Operator GREATER_OR_EQUAL
        Matches when the key value is greater or equal compared to the matcher value.

      • LESS

        public static final KeyValueMatcher.Operator LESS
        Matches when the key value is less compared to the matcher value.

      • LESS_OR_EQUAL

        public static final KeyValueMatcher.Operator LESS_OR_EQUAL
        Matches when the key value is less or equal compared to the matcher value.

      • INCLUDES

        public static final KeyValueMatcher.Operator INCLUDES
        Matches when the key value is included in the matcher value. For example, when a collection has a subset of elements of another collection.

      • EXCLUDES

        public static final KeyValueMatcher.Operator EXCLUDES
        Matches when the key is excluded from the matcher value. This is the inverted operator of INCLUDES.

    • Method Detail

      • values

        public static KeyValueMatcher.Operator[] 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 (KeyValueMatcher.Operator c : KeyValueMatcher.Operator.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static KeyValueMatcher.Operator 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