Module org.neo4j.cypherdsl.core
Package org.neo4j.cypherdsl.core

Enum Class Operator

java.lang.Object
java.lang.Enum<Operator>
org.neo4j.cypherdsl.core.Operator
All Implemented Interfaces:
Serializable, Comparable<Operator>, Constable, Visitable
@API(status=STABLE, since="1.0") public enum Operator extends Enum<Operator> implements Visitable
An operator. See Operators.
Since:
1.0
Author:
Michael J. Simons

  • Enum Constant Details

    • ADDITION

      public static final Operator ADDITION
      Standard addition operator.

    • SUBTRACTION

      public static final Operator SUBTRACTION
      Standard subtraction operator.

    • UNARY_MINUS

      public static final Operator UNARY_MINUS
      Unary minus operator.

    • UNARY_PLUS

      public static final Operator UNARY_PLUS
      Unary plus 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 Details

    • values

      public static 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 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

    • getRepresentation

      @API(status=INTERNAL) public String getRepresentation()
      Returns:
      The operators textual representation.

    • getType

      @API(status=INTERNAL) public Operator.Type getType()
      Returns:
      The type of this operator.

    • toString

      public String toString()
      Description copied from interface: Visitable
      Most visitables will render themselves into a Cypher fragment preceded with the actual classname. The representation however is not cached - in contrast to the ones for full statements. Using toString is recommended for debugging purposes mainly, and not for production use.

      The concrete classname has been prepended to help debugging and actually to discourage using fragments to build queries without explicitly rendering them, either as statement or going through the renderer on purpose.

      Specified by:
      toString in interface Visitable
      Overrides:
      toString in class Enum<Operator>
      Returns:
      A string representation of this visitable formatted as Classname{cypher=value}