Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD

## org.apache.poi.ss.formula
Enum EvaluationConditionalFormatRule.OperatorEnum

    java.lang.Object
      java.lang.Enum<EvaluationConditionalFormatRule.OperatorEnum>
          org.apache.poi.ss.formula.EvaluationConditionalFormatRule.OperatorEnum

All Implemented Interfaces:
  java.io.Serializable, java.lang.Comparable<EvaluationConditionalFormatRule.OperatorEnum>

Enclosing class:
  EvaluationConditionalFormatRule

    public static enum EvaluationConditionalFormatRule.OperatorEnum

extends java.lang.Enum<EvaluationConditionalFormatRule.OperatorEnum>

Not calling it OperatorType to avoid confusion for now with other classes. Definition order matches OOXML type ID indexes. Note that this has NO_COMPARISON as the first item, unlike the similar DataValidation operator enum. Thanks, Microsoft.

Enum Constant Summary
`BETWEEN`
`EQUAL`
`GREATER_OR_EQUAL`
`GREATER_THAN`
`LESS_OR_EQUAL`
`LESS_THAN`
`NO_COMPARISON`
`NOT_BETWEEN`
`NOT_EQUAL`

Method Summary
`abstract
`<C extends java.lang.Comparable<C>> boolean`
` | `isValid(C cellValue, C v1, C v2)` Evaluates comparison using operator instance rules
`static EvaluationConditionalFormatRule.OperatorEnum` | `valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static EvaluationConditionalFormatRule.OperatorEnum[]` | `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

### NO_COMPARISON

    public static final EvaluationConditionalFormatRule.OperatorEnum NO_COMPARISON

### BETWEEN

    public static final EvaluationConditionalFormatRule.OperatorEnum BETWEEN

### NOT_BETWEEN

    public static final EvaluationConditionalFormatRule.OperatorEnum NOT_BETWEEN

### EQUAL

    public static final EvaluationConditionalFormatRule.OperatorEnum EQUAL

### NOT_EQUAL

    public static final EvaluationConditionalFormatRule.OperatorEnum NOT_EQUAL

### GREATER_THAN

    public static final EvaluationConditionalFormatRule.OperatorEnum GREATER_THAN

### LESS_THAN

    public static final EvaluationConditionalFormatRule.OperatorEnum LESS_THAN

### GREATER_OR_EQUAL

    public static final EvaluationConditionalFormatRule.OperatorEnum GREATER_OR_EQUAL

### LESS_OR_EQUAL

    public static final EvaluationConditionalFormatRule.OperatorEnum LESS_OR_EQUAL

Method Detail

### values

    public static EvaluationConditionalFormatRule.OperatorEnum[] 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 (EvaluationConditionalFormatRule.OperatorEnum c : EvaluationConditionalFormatRule.OperatorEnum.values())
          System.out.println(c);

  Returns:
    an array containing the constants of this enum type, in the order they are declared

### valueOf

    public static EvaluationConditionalFormatRule.OperatorEnum 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

### isValid

    public abstract <C extends java.lang.Comparable<C>> boolean isValid(C cellValue,
                                                                        C v1,
                                                                        C v2)

  Evaluates comparison using operator instance rules

  Parameters:
    `cellValue` - won't be null, assumption is previous checks handled that
    `v1` - if null, value assumed invalid, anything passes, per Excel behavior
    `v2` - null if not needed. If null when needed, assume anything passes, per Excel behavior
  Returns:
    true if the comparison is valid

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD

Copyright 2017 The Apache Software Foundation or its licensors, as applicable.