org.scijava

Enum ItemIO

java.lang.Object

java.lang.Enum<ItemIO>

org.scijava.ItemIO

All Implemented Interfaces:

Serializable, Comparable<ItemIO>

public enum ItemIO
extends Enum<ItemIO>

Defines the input/output type of a module.

Choices are:

• INPUT: item is an input for the module.
• OUTPUT: item is an output for the module.
• BOTH: item is both an input and an output for the module. This type is used to indicate an object that is mutated somehow during execution.

Author:

Curtis Rueden

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH
INPUT
OUTPUT

Method Summary

Methods

Modifier and Type	Method and Description
static ItemIO	valueOf(String name) Returns the enum constant of this type with the specified name.
static ItemIO[]	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

INPUT

public static final ItemIO INPUT

OUTPUT

public static final ItemIO OUTPUT

BOTH

public static final ItemIO BOTH

Method Detail

values

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

Returns:

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

valueOf

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