java.lang.Object
- java.lang.Enum<Operator>
- - org.neo4j.cypherdsl.core.Operator

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Operator>, Visitable
```
@API(status=EXPERIMENTAL,
     since="1.0")
public enum Operator
extends java.lang.Enum<Operator>
implements Visitable
```
An operator. See Operators.

Since:

1.0

Author:

Michael J. Simons

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Operator.Type
Operator type.

Enum Constant Summary

Enum Constants
Enum Constant	Description
`ADDITION`	Standard addition operator.
`AND`	The AND operator.
`ASSIGMENT`	The assigment operator (Read as in `p := (a)-->(b)`)
`CONCAT`	The string concatenating operator.
`CONTAINS`	String operator for `CONTAINS`.
`DIVISION`	Standard division operator.
`ENDS_WITH`	String operator for `ENDS WITH`.
`EQUALITY`	Comparison for equality.
`EXPONENTIATION`	Operator for exponentiation.
`GET`	Property operator for retrieving properties.
`GREATER_THAN`	> comparison.
`GREATER_THAN_OR_EQUAL_TO`	≥ comparison.
`IN`	`IN` operator.
`INEQUALITY`	Comparison for inequality.
`IS_NOT_NULL`	`IS NOT NULL` comparison.
`IS_NULL`	`IS NULL` comparison.
`LESS_THAN`	< comparison.
`LESS_THAN_OR_EQUAL_TO`	≤ comparison.
`MATCHES`	The string matching operator.
`MODULO_DIVISION`	Standard modulo operator.
`MULTIPLICATION`	Standard multiplication operator.
`MUTATE`	Property operator for modifying properties.
`NOT`	The NOT operator.
`OR`	The OR operator.
`PIPE`	The pipe operator
`REMOVE_LABEL`	The label operator removing labels.
`SET`	Property operator for assigning properties.
`SET_LABEL`	The label operator adding labels.
`STARTS_WITH`	String operator for `STARTS WITH`.
`SUBTRACTION`	Standard subtraction operator.
`XOR`	The XOR operator.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getRepresentation()`
`Operator.Type`	`getType()`
`static Operator`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static 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

Methods inherited from interface org.neo4j.cypherdsl.core.support.Visitable
accept

- Enum Constant Detail
  - ADDITION
```
public static final Operator ADDITION
```
    Standard addition operator.
  - SUBTRACTION
```
public static final Operator SUBTRACTION
```
    Standard subtraction operator.
  - MULTIPLICATION
```
public static final Operator MULTIPLICATION
```
    Standard multiplication operator.
  - DIVISION
```
public static final Operator DIVISION
```
    Standard division operator.
  - MODULO_DIVISION
```
public static final Operator MODULO_DIVISION
```
    Standard modulo operator.
  - EXPONENTIATION
```
public static final Operator EXPONENTIATION
```
    Operator for exponentiation.
  - EQUALITY
```
public static final Operator EQUALITY
```
    Comparison for equality.
  - INEQUALITY
```
public static final Operator INEQUALITY
```
    Comparison for inequality.
  - LESS_THAN
```
public static final Operator LESS_THAN
```
    < comparison.
  - GREATER_THAN
```
public static final Operator GREATER_THAN
```
    > comparison.
  - LESS_THAN_OR_EQUAL_TO
```
public static final Operator LESS_THAN_OR_EQUAL_TO
```
    ≤ comparison.
  - GREATER_THAN_OR_EQUAL_TO
```
public static final Operator GREATER_THAN_OR_EQUAL_TO
```
    ≥ comparison.
  - IS_NULL
```
public static final Operator IS_NULL
```
    IS NULL comparison.
  - IS_NOT_NULL
```
public static final Operator IS_NOT_NULL
```
    IS NOT NULL comparison.
  - STARTS_WITH
```
public static final Operator STARTS_WITH
```
    String operator for STARTS WITH.
  - ENDS_WITH
```
public static final Operator ENDS_WITH
```
    String operator for ENDS WITH.
  - CONTAINS
```
public static final Operator CONTAINS
```
    String operator for CONTAINS.
  - AND
```
public static final Operator AND
```
    The AND operator.
  - OR
```
public static final Operator OR
```
    The OR operator.
  - XOR
```
public static final Operator XOR
```
    The XOR operator.
  - NOT
```
public static final Operator NOT
```
    The NOT operator.
  - CONCAT
```
public static final Operator CONCAT
```
    The string concatenating operator.
  - MATCHES
```
public static final Operator MATCHES
```
    The string matching operator.
  - IN
```
public static final Operator IN
```
    IN operator.
  - SET
```
public static final Operator SET
```
    Property operator for assigning properties.
  - GET
```
public static final Operator GET
```
    Property operator for retrieving properties.
  - MUTATE
```
public static final Operator MUTATE
```
    Property operator for modifying properties.
  - SET_LABEL
```
public static final Operator SET_LABEL
```
    The label operator adding labels.
  - REMOVE_LABEL
```
public static final Operator REMOVE_LABEL
```
    The label operator removing labels.
  - ASSIGMENT
```
public static final Operator ASSIGMENT
```
    The assigment operator (Read as in `p := (a)-->(b)`)
  - PIPE
```
public static final Operator PIPE
```
    The pipe operator
- 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(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
  - getRepresentation
```
@API(status=INTERNAL)
public java.lang.String getRepresentation()
```
    Returns:
    
    The operators textual representation.
  - getType
```
@API(status=INTERNAL)
public Operator.Type getType()
```
    Returns:
    
    The type of this operator.

Enum Operator

Nested Class Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface org.neo4j.cypherdsl.core.support.Visitable

Enum Constant Detail

ADDITION

SUBTRACTION

MULTIPLICATION

DIVISION

MODULO_DIVISION

EXPONENTIATION

EQUALITY

INEQUALITY

LESS_THAN

GREATER_THAN

LESS_THAN_OR_EQUAL_TO

GREATER_THAN_OR_EQUAL_TO

IS_NULL

IS_NOT_NULL

STARTS_WITH

ENDS_WITH

CONTAINS

AND

OR

XOR

NOT

CONCAT

MATCHES

IN

SET

GET

MUTATE

SET_LABEL

REMOVE_LABEL

ASSIGMENT

PIPE

Method Detail

values

valueOf

getRepresentation

getType