Module org.scijava.struct

Package org.scijava.struct

Enum ItemIO

java.lang.Object

java.lang.Enum<ItemIO>

org.scijava.struct.ItemIO

All Implemented Interfaces:

Serializable, Comparable<ItemIO>

public enum ItemIO
extends Enum<ItemIO>

Defines the input/output type of a struct Member.

Author:

Curtis Rueden, David Kolb

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTO	The type of the item should be inferred automatically during structification.
CONTAINER	The item is a hybrid input/output for the operation, whose structure is fixed but whose content will be populated during execution of the operation.
INPUT	The item is an input for the operation.
MUTABLE	The item is a hybrid input/output for the operation, whose current value will be used as input to the computation, but subsequently overwritten with a result.
NONE	The type of the item is none of the above.
OUTPUT	The item is an output for the operation.

Method Summary

Modifier and Type	Method	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

The item is an input for the operation.

OUTPUT

public static final ItemIO OUTPUT

The item is an output for the operation.

CONTAINER

public static final ItemIO CONTAINER

The item is a hybrid input/output for the operation, whose structure is fixed but whose content will be populated during execution of the operation.

MUTABLE

public static final ItemIO MUTABLE

The item is a hybrid input/output for the operation, whose current value will be used as input to the computation, but subsequently overwritten with a result.

AUTO

public static final ItemIO AUTO

The type of the item should be inferred automatically during structification. For instance, for methods of functional interfaces, the types can be inferred as follows: the return type (if not void) is ItemIO.OUTPUT and method parameters are typically ItemIO.INPUT, although method parameters could be annotated to indicate they should be treated as ItemIO.CONTAINER or ItemIO.MUTABLE type instead.

NONE

public static final ItemIO NONE

The type of the item is none of the above.

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