Enum Constant Detail

• NORMAL

  public static final ItemVisibility NORMAL

  Item is included in the history for purposes of data provenance, and included as a parameter when recording scripts.

• TRANSIENT

  public static final ItemVisibility TRANSIENT

  Item is excluded from the history for the purposes of data provenance, but still included as a parameter when recording scripts.

• INVISIBLE

  public static final ItemVisibility INVISIBLE

  Item is excluded from the history for the purposes of data provenance, and also excluded as a parameter when recording scripts. This option should only be used for items with no effect on the final output, such as a "verbose" flag.

• MESSAGE

  public static final ItemVisibility MESSAGE

  As INVISIBLE, and further indicating that the item's value is intended as a message to the user (e.g., in the input harvester panel) rather than an actual parameter to the module execution.

Method Detail

• values

  public static ItemVisibility[] 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 (ItemVisibility c : ItemVisibility.values())
      System.out.println(c);
  

  Returns:

  an array containing the constants of this enum type, in the order they are declared

• valueOf

  public static ItemVisibility valueOf(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:

  IllegalArgumentException - if this enum type has no constant with the specified name

  NullPointerException - if the argument is null