Enum Filter.Operator

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Filter.Operator>
    Enclosing class:
    Filter

    public static enum Filter.Operator
    extends java.lang.Enum<Filter.Operator>
    Represents all of the possible Operators that can be used to perform a filter.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      EQUALS
      The field value is identical to an expected value.
      GREATER_THAN
      The field value is greater than a specified value.
      GREATER_THAN_OR_EQUAL_TO
      The field value is greater than or equal to a specified value.
      LESS_THAN
      The field value is less than a specified value.
      LESS_THAN_OR_EQUAL_TO
      The field value is less than or equal to a specified value.
      REGEX
      The field value matches the provided regular expression.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Filter.Operator fromString​(java.lang.String symbol)
      Returns the Operator for it's specified symbol.
      java.lang.String getSymbol()
      Returns the symbol for the operator, for example EQUALS would return ==
      static Filter.Operator valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Filter.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

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • EQUALS

        public static final Filter.Operator EQUALS
        The field value is identical to an expected value.
      • GREATER_THAN

        public static final Filter.Operator GREATER_THAN
        The field value is greater than a specified value.
      • LESS_THAN

        public static final Filter.Operator LESS_THAN
        The field value is less than a specified value.
      • GREATER_THAN_OR_EQUAL_TO

        public static final Filter.Operator GREATER_THAN_OR_EQUAL_TO
        The field value is greater than or equal to a specified value.
      • LESS_THAN_OR_EQUAL_TO

        public static final Filter.Operator LESS_THAN_OR_EQUAL_TO
        The field value is less than or equal to a specified value.
      • REGEX

        public static final Filter.Operator REGEX
        The field value matches the provided regular expression.
    • Method Detail

      • values

        public static Filter.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 (Filter.Operator c : Filter.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 Filter.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
      • fromString

        public static Filter.Operator fromString​(java.lang.String symbol)
        Returns the Operator for it's specified symbol.
        Parameters:
        symbol -
        Returns:
        The Operator.
      • getSymbol

        public java.lang.String getSymbol()
        Returns the symbol for the operator, for example EQUALS would return ==
        Returns:
        The symbol of the operator.