Package nz.org.riskscape.engine

Enum Class Tuple.CoerceOptions

java.lang.Object
java.lang.Enum<Tuple.CoerceOptions>
nz.org.riskscape.engine.Tuple.CoerceOptions
All Implemented Interfaces:
Serializable, Comparable<Tuple.CoerceOptions>, Constable
Enclosing class:
Tuple
public static enum Tuple.CoerceOptions extends Enum<Tuple.CoerceOptions>

Options for error suppression/checking when using the Tuple.coerce(Struct, Map) method

  • Enum Constant Details

    • SURPLUS_IGNORED

      public static final Tuple.CoerceOptions SURPLUS_IGNORED

      Any extra keys in the map will be ignored and not included in the resulting tuple

    • MISSING_IGNORED

      public static final Tuple.CoerceOptions MISSING_IGNORED
      Suppresses an error for when Tuple.hasNulls() returns true after building the tuple from the map

  • Method Details

    • values

      public static Tuple.CoerceOptions[] 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 Tuple.CoerceOptions 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