Enum Operator

    • Enum Constant Detail

      • LTEQ

        public static final Operator LTEQ
      • GTEQ

        public static final Operator GTEQ
      • LIKE

        public static final Operator LIKE
      • NOTLIKE

        public static final Operator NOTLIKE
      • IN

        public static final Operator IN
        Since:
        2.6
      • NOTIN

        public static final Operator NOTIN
        Since:
        2.6
      • LIKE_IN

        public static final Operator LIKE_IN
        Since:
        2.6
      • NOTLIKE_IN

        public static final Operator NOTLIKE_IN
        Since:
        2.6
      • RLIKE

        public static final Operator RLIKE
        Since:
        2.8
      • BETWEEN

        public static final Operator BETWEEN
        Since:
        3.0
    • Field Detail

      • value

        private final int value
      • symbol

        private final String symbol
      • sqlSymbol

        private final String sqlSymbol
      • expressionOperator

        private final boolean expressionOperator
      • isListOperator

        private final boolean isListOperator
      • isNegationOperator

        private final boolean isNegationOperator
    • Constructor Detail

      • Operator

        private Operator​(int value,
                         String symbol,
                         String sqlSymbol,
                         boolean expressionOperator,
                         boolean isListOperator,
                         boolean isNegationOperator)
    • Method Detail

      • values

        public static 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 (Operator c : 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 Operator valueOf​(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:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • getValue

        public int getValue()
        Get the integer value that is used when storing an operator in the database.
        Returns:
        an Integer
      • getSymbol

        public String getSymbol()
        Get the symbol for this operator, useful for display in client applications.
        Returns:
        a String object
      • getSqlSymbol

        public String getSqlSymbol()
        Get the SQL symbol for this operator. This can be used when creating SQL/HQL queries.
        Returns:
        A String object
      • isExpressionOperator

        public boolean isExpressionOperator()
      • isNegationOperator

        public boolean isNegationOperator()
        Negation operators typically need to handle 'null' checks a bit differently.
        Since:
        3.5
      • fromValue

        public static Operator fromValue​(int value)
        Get the Operator object when you know the integer code.
        Parameters:
        value - The integer code
        Returns:
        an Operator object.
      • isListOperator

        public boolean isListOperator()
        Gets if the operator should be used with a list or not. The list items should be separated with '|'.
        Returns:
        TRUE if it should, FALSE otherwise.
        Since:
        2,6