io.elevator.components

Class Indicator.DataAndChime<D,C>

java.lang.Object

io.elevator.components.Indicator.DataAndChime<D,C>

Type Parameters:

D - The type of data to be displayed in the indicator, replacing @see#Indicator T

C - The type of the chime to be played

Enclosing class:

Indicator<T>

public static class Indicator.DataAndChime<D,C>
extends java.lang.Object

Used as a way to enable storage of both data and audio in an @see#Indicator

Author:

Kage Weiss

Constructor Summary

Constructors

Constructor and Description
DataAndChime(D display, C chime) Sets up a data holder to have data and a single chime.
DataAndChime(D display, java.util.List<C> chimes) Sets up a data holder to have data and a List of chimes

Method Summary

Modifier and Type	Method and Description
C	getChime() Gets the stored chime.
C	getChime(int index) Gets a specific chime.
D	getDisplay()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DataAndChime

public DataAndChime(D display,
                    java.util.List<C> chimes)

Sets up a data holder to have data and a List of chimes

Parameters:

display - the data

chimes - the list of chimes

DataAndChime

public DataAndChime(D display,
                    C chime)

Sets up a data holder to have data and a single chime.

Parameters:

display - the data

chime - the chime

Method Detail

getDisplay

public final D getDisplay()

Returns:

the display

getChime

public C getChime(int index)

Gets a specific chime. If there is only one chime, returns that chime.

Parameters:

index - the index, in the List of chimes, of the chime

Returns:

The requested chime

getChime

public C getChime()

Gets the stored chime. If there are multiple chimes, returns the first.

Returns:

The requested chime

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object