Package oracle.pgx.common.types

Enum ArgumentType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ArgumentType>
    public enum ArgumentType
extends java.lang.Enum<ArgumentType>
    The type of argument

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BOOL_IN
      boolean in-argument (value)
      BOOL_OUT
      boolean out-argument (name of scalar)
      COLLECTION
      collection argument (name, in or out)
      DOUBLE_IN
      double in-argument (value)
      DOUBLE_OUT
      double out-argument (name of scalar)
      EDGE_ID_IN
      edge ID in-argument (value)
      EDGE_ID_OUT
      edge ID out-argument (name of scalar)
      EDGE_PROPERTY
      edge property argument (name, in or out)
      FLOAT_IN
      float in-argument (value)
      FLOAT_OUT
      float out-argument (name of scalar)
      GENERIC_FILTER
      a generic vertex or edge filter argument (name, in or out)
      GRAPH
      graph argument (name)
      INT_IN
      integer in-argument (value)
      INT_OUT
      integer out-argument (name of scalar)
      LONG_IN
      long in-argument (value)
      LONG_OUT
      long out-argument (name of scalar)
      MAP
      map argument (name, in or out)
      NODE_ID_IN
      node ID in-argument (value)
      NODE_ID_OUT
      node ID out-argument (name of scalar)
      NODE_PROPERTY
      node property argument (name, in or out)
      STRING_IN
      string in-argument (value)
      STRING_OUT
      string out-argument (name of scalar)

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean isPgxId()  
      static ArgumentType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ArgumentType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • BOOL_IN

        public static final ArgumentType BOOL_IN
        boolean in-argument (value)

      • INT_IN

        public static final ArgumentType INT_IN
        integer in-argument (value)

      • LONG_IN

        public static final ArgumentType LONG_IN
        long in-argument (value)

      • FLOAT_IN

        public static final ArgumentType FLOAT_IN
        float in-argument (value)

      • DOUBLE_IN

        public static final ArgumentType DOUBLE_IN
        double in-argument (value)

      • STRING_IN

        public static final ArgumentType STRING_IN
        string in-argument (value)

      • BOOL_OUT

        public static final ArgumentType BOOL_OUT
        boolean out-argument (name of scalar)

      • INT_OUT

        public static final ArgumentType INT_OUT
        integer out-argument (name of scalar)

      • LONG_OUT

        public static final ArgumentType LONG_OUT
        long out-argument (name of scalar)

      • FLOAT_OUT

        public static final ArgumentType FLOAT_OUT
        float out-argument (name of scalar)

      • DOUBLE_OUT

        public static final ArgumentType DOUBLE_OUT
        double out-argument (name of scalar)

      • STRING_OUT

        public static final ArgumentType STRING_OUT
        string out-argument (name of scalar)

      • NODE_ID_IN

        public static final ArgumentType NODE_ID_IN
        node ID in-argument (value)

      • EDGE_ID_IN

        public static final ArgumentType EDGE_ID_IN
        edge ID in-argument (value)

      • NODE_ID_OUT

        public static final ArgumentType NODE_ID_OUT
        node ID out-argument (name of scalar)

      • EDGE_ID_OUT

        public static final ArgumentType EDGE_ID_OUT
        edge ID out-argument (name of scalar)

      • GRAPH

        public static final ArgumentType GRAPH
        graph argument (name)

      • NODE_PROPERTY

        public static final ArgumentType NODE_PROPERTY
        node property argument (name, in or out)

      • EDGE_PROPERTY

        public static final ArgumentType EDGE_PROPERTY
        edge property argument (name, in or out)

      • COLLECTION

        public static final ArgumentType COLLECTION
        collection argument (name, in or out)

      • MAP

        public static final ArgumentType MAP
        map argument (name, in or out)

      • GENERIC_FILTER

        public static final ArgumentType GENERIC_FILTER
        a generic vertex or edge filter argument (name, in or out)

    • Method Detail

      • values

        public static ArgumentType[] 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 (ArgumentType c : ArgumentType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

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

      • isPgxId

        public boolean isPgxId()