io.elevator.components

Enum FiremanKeyhole.KeyState

java.lang.Object

java.lang.Enum<FiremanKeyhole.KeyState>

io.elevator.components.FiremanKeyhole.KeyState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FiremanKeyhole.KeyState>

Enclosing class:

FiremanKeyhole

public static enum FiremanKeyhole.KeyState
extends java.lang.Enum<FiremanKeyhole.KeyState>

Represents the three possible states a Fireman Keyhole can be placed in and whether each state is indicative of emergency operation: OFF, ON, HOLD_BYPASS

Author:

Kage Weiss

Enum Constant Summary

Enum Constants

Enum Constant and Description
HOLD_BYPASS The HOLD_BYPASS state dictates that: If installed on a landing, the elevator should operate as though it were in normal mode. If installed in a cabin, the cabin should remain at this landing.
OFF The OFF state dictates that no action need be taken in response to this state.
ON The ON state dictates that: If installed on a landing, the cabin should be called to this landing. If installed in a cabin, the operator should control the car while it is in emergency mode.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	isEmergency Declares whether this state is indicative of emergency operation

Method Summary

Modifier and Type	Method and Description
static FiremanKeyhole.KeyState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FiremanKeyhole.KeyState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OFF

public static final FiremanKeyhole.KeyState OFF

The OFF state dictates that no action need be taken in response to this state.

ON

public static final FiremanKeyhole.KeyState ON

The ON state dictates that:
If installed on a landing, the cabin should be called to this landing.
If installed in a cabin, the operator should control the car while it is in emergency mode.

HOLD_BYPASS

public static final FiremanKeyhole.KeyState HOLD_BYPASS

The HOLD_BYPASS state dictates that:
If installed on a landing, the elevator should operate as though it were in normal mode.
If installed in a cabin, the cabin should remain at this landing.

Field Detail

isEmergency

public final boolean isEmergency

Declares whether this state is indicative of emergency operation

Method Detail

values

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

Returns:

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

valueOf

public static FiremanKeyhole.KeyState 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