org.scijava
Enum ItemVisibility

java.lang.Object
  java.lang.Enum<ItemVisibility>
      org.scijava.ItemVisibility

All Implemented Interfaces:

Serializable, Comparable<ItemVisibility>

public enum ItemVisibility
extends Enum<ItemVisibility>

Defines the "visibility" of a parameter.

Author:

Curtis Rueden

Enum Constant Summary

INVISIBLE
Item is excluded from the history for the purposes of data provenance, and also excluded as a parameter when recording scripts.

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.

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

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

Method Summary

static ItemVisibility	valueOf(String name) Returns the enum constant of this type with the specified name.
static ItemVisibility[]	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

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