io.elevator.building

Class ControlPanel<ButtonType>

java.lang.Object

io.elevator.building.ControlPanel<ButtonType>

Type Parameters:

ButtonType - The type of data for the button to hold

Direct Known Subclasses:

ControlPanel.CabinControlPanel, ControlPanel.FloorControlPanel, ControlPanel.MaintenanceControlPanel

public class ControlPanel<ButtonType>
extends java.lang.Object

This class represents the driver for a basic control panel having only a FiremanKeyhole and some set of Button

Author:

Kage Weiss

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ControlPanel.CabinControlPanel The driver representation for an in-cabin control panel This class contains linking methods for controlling the cabin in reference to the hardware
static class	ControlPanel.FloorControlPanel The driver representation for an on-landing control panel, having 2x ArrivalIndicator, a FiremanKeyhole, and Buttons for placing calls
static class	ControlPanel.MaintenanceControlPanel The driver representation for a maintenance control panel, to keep track of everything The parent list of buttons represents the floor buttons

Constructor Summary

Constructors

Constructor and Description
ControlPanel(java.util.List<Buttons<ButtonType>> buttons, FiremanKeyhole fireKey) Creates a control panel comprising a list of buttons and a fire key

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Object>	flatten() Flattens this object's components into a single list
java.util.List<java.lang.Object>	getComponents() The stored list of components of this Component wrapper
FiremanKeyhole	getFireKey() The mandatory Fireman Keyhole
java.util.LinkedList<Buttons<ButtonType>>	getMainButtonsOnPanel() A list of all the main-purpose buttons on a control panel.
io.elevator.building.Component	setComponents(java.util.List<java.lang.Object> components) Sets the stored list of this Component wrapper's components to be the passed param
io.elevator.building.Component	setComponents(java.lang.Object... components) Sets the stored list of this Component wrapper's components to be the passed params
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ControlPanel

public ControlPanel(java.util.List<Buttons<ButtonType>> buttons,
                    FiremanKeyhole fireKey)

Creates a control panel comprising a list of buttons and a fire key

Parameters:

buttons - the list of buttons to hold

fireKey - the fire key for this panel

Method Detail

getMainButtonsOnPanel

public final java.util.LinkedList<Buttons<ButtonType>> getMainButtonsOnPanel()

A list of all the main-purpose buttons on a control panel. This list may not contain all buttons on a panel.

Returns:

the mainButtonsOnPanel

getFireKey

public final FiremanKeyhole getFireKey()

The mandatory Fireman Keyhole

Returns:

the fireKey

flatten

public java.util.List<java.lang.Object> flatten()

Flattens this object's components into a single list

Returns:

The list of this object's components

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setComponents

public io.elevator.building.Component setComponents(java.lang.Object... components)

Sets the stored list of this Component wrapper's components to be the passed params

Parameters:

components - The array of components to add

Returns:

This Component wrapper

setComponents

public io.elevator.building.Component setComponents(java.util.List<java.lang.Object> components)

Sets the stored list of this Component wrapper's components to be the passed param

Parameters:

components - The list of components to add

Returns:

This Component wrapper

getComponents

public java.util.List<java.lang.Object> getComponents()

The stored list of components of this Component wrapper

Returns:

The stored list of this object's components