Enum Class KeyValueMatcher.Operator

java.lang.Object
java.lang.Enum<KeyValueMatcher.Operator>
org.spongepowered.api.data.KeyValueMatcher.Operator
All Implemented Interfaces:
Serializable, Comparable<KeyValueMatcher.Operator>, Constable
Enclosing interface:
KeyValueMatcher<V>

public static enum KeyValueMatcher.Operator extends Enum<KeyValueMatcher.Operator>
Represents a operator to match the values of a key query.
  • Enum Constant Details

    • EQUAL

      public static final KeyValueMatcher.Operator EQUAL
      Matches when the key and the matcher values are equal.
    • 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 Details

    • values

      public static KeyValueMatcher.Operator[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static KeyValueMatcher.Operator valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null