Package com.esri.arcgisruntime.arcade

Enum ArcadeExpressionReturnType

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ANY
      The return type is expected to be any of the other ArcadeExpressionReturnType types.
      AUTOMATIC
      The return type of the expression will be automatically determined based on the script calculation.
      BOOLEAN
      The return type is expected to be a boolean value of true or false.
      DICTIONARY
      The return type is expected to be a dictionary of key/value pairs.
      NUMBER
      The return type is expected to be a floating-point number.
      STRING
      The return type is expected to be a string.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static ArcadeExpressionReturnType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ArcadeExpressionReturnType[] 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

      • AUTOMATIC

        public static final ArcadeExpressionReturnType AUTOMATIC
        The return type of the expression will be automatically determined based on the script calculation.

        The return type is determined by the return value of the script. Different paths through the script might result in different result types. For example, depending on input values, it might return a number, a string, a date, or an array.

        Since:
        100.11.0

      • NUMBER

        public static final ArcadeExpressionReturnType NUMBER
        The return type is expected to be a floating-point number.
        Since:
        100.11.0

      • DICTIONARY

        public static final ArcadeExpressionReturnType DICTIONARY
        The return type is expected to be a dictionary of key/value pairs.
        Since:
        100.12.0

      • ANY

        public static final ArcadeExpressionReturnType ANY
        The return type is expected to be any of the other ArcadeExpressionReturnType types.

        'any' implies that the application evaluating the expression will need to check the result for its type and use the value appropriately.

        Since:
        100.13.0

      • BOOLEAN

        public static final ArcadeExpressionReturnType BOOLEAN
        The return type is expected to be a boolean value of true or false.
        Since:
        100.13.0

    • Method Detail

      • values

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

      • valueOf

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