io.elevator.building

Class Building

java.lang.Object

io.elevator.building.Building

public class Building
extends java.lang.Object

A wrapper comprising all components required to run an elevator

Author:

Kage

Constructor Summary

Constructors

Constructor and Description
Building(int numberOfFloors) Creates a building component wrapper based on the number of floors

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Object>	everythingButMaintenance()
java.util.List<java.lang.Object>	flatten() Flattens this object's components into a single list
ControlPanel.CabinControlPanel	getCabin() The CabinControlPanel contains all components contained in the elevator cabin
java.util.List<java.lang.Object>	getComponents() The stored list of components of this Component wrapper
java.util.List<ControlPanel.FloorControlPanel>	getFloors() The floors contains each floor of the building in a list, from floor 1 to floor n.
Hoistway	getHoistway() The Hoistway contains all components contained in the elevator hoistway
ControlPanel.MaintenanceControlPanel	getMaintenance() The MaintenanceControlPanel contains all components contained on the elevator maintenance control panel
java.util.List<java.lang.Object>	getObjectByType(java.lang.Class<?> type, java.util.List<java.lang.Object> list) A method for unpacking all objects of a specific type from inside the building by passing a Class argument
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

Building

public Building(int numberOfFloors)

Creates a building component wrapper based on the number of floors

Parameters:

numberOfFloors - the number of floors in the building

Method Detail

getFloors

public final java.util.List<ControlPanel.FloorControlPanel> getFloors()

The floors contains each floor of the building in a list, from floor 1 to floor n. The list is padded with a null value so that floor 1 is at list index 1 and floor n is at index n

Returns:

the floors

getCabin

public final ControlPanel.CabinControlPanel getCabin()

The CabinControlPanel contains all components contained in the elevator cabin

Returns:

the cabin

getHoistway

public final Hoistway getHoistway()

The Hoistway contains all components contained in the elevator hoistway

Returns:

the hoistway

getMaintenance

public final ControlPanel.MaintenanceControlPanel getMaintenance()

The MaintenanceControlPanel contains all components contained on the elevator maintenance control panel

Returns:

the maintenance

getObjectByType

public java.util.List<java.lang.Object> getObjectByType(java.lang.Class<?> type,
                                                        java.util.List<java.lang.Object> list)

A method for unpacking all objects of a specific type from inside the building by passing a Class argument

Parameters:

type - the class (e.g. Button.class) of sensor to unpack

list - the list to unpack from

Returns:

A list of all EnvironmentSensors, of the type requested, from the building

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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

everythingButMaintenance

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

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