Package org.neo4j.procedure

Enum Class Mode

java.lang.Object
java.lang.Enum<Mode>
org.neo4j.procedure.Mode
All Implemented Interfaces:
Serializable, Comparable<Mode>, Constable
public enum Mode extends Enum<Mode>
The procedure mode affects how the procedure will execute, and which capabilities it requires.

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    DBMS
    This procedure will perform system operations - i.e.
    DEFAULT
    This procedure will only perform read operations against the graph
    READ
    This procedure will only perform read operations against the graph
    SCHEMA
    This procedure will perform operations against the schema
    WRITE
    This procedure may perform both read and write operations against the graph

  • Method Summary

    Modifier and Type
    Method
    Description
    static Mode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static Mode[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

  • Enum Constant Details

    • READ

      public static final Mode READ
      This procedure will only perform read operations against the graph

    • WRITE

      public static final Mode WRITE
      This procedure may perform both read and write operations against the graph

    • SCHEMA

      public static final Mode SCHEMA
      This procedure will perform operations against the schema

    • DBMS

      public static final Mode DBMS
      This procedure will perform system operations - i.e. not against the graph

    • DEFAULT

      public static final Mode DEFAULT
      This procedure will only perform read operations against the graph

  • Method Details

    • values

      public static Mode[] 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 Mode 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