li.cil.tis3d.common.machine

Enum PipeImpl.State

java.lang.Object

java.lang.Enum<PipeImpl.State>

li.cil.tis3d.common.machine.PipeImpl.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PipeImpl.State>

Enclosing class:

PipeImpl

public static enum PipeImpl.State
extends java.lang.Enum<PipeImpl.State>

Current state of the pipe, to enforce synchronization, i.e. make sure each read/write combination always takes the same amount of steps regardless of whether reader or writer ran first (when they start in the same step).

Enum Constant Summary

Enum Constants

Enum Constant and Description
BUSY Reader registered in this update.
COMPLETE Data was read from the pipe this update.
FLUSHING Data can be read from the pipe this update.
IDLE Waiting for a reader.
READY Reader has registered and is ready to receive.

Method Summary

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

IDLE

public static final PipeImpl.State IDLE

Waiting for a reader.

BUSY

public static final PipeImpl.State BUSY

Reader registered in this update.

READY

public static final PipeImpl.State READY

Reader has registered and is ready to receive.

FLUSHING

public static final PipeImpl.State FLUSHING

Data can be read from the pipe this update.

COMPLETE

public static final PipeImpl.State COMPLETE

Data was read from the pipe this update.

Method Detail

values

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

Returns:

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

valueOf

public static PipeImpl.State valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null