app.framework

Class Radio<T>

java.lang.Object

app.framework.Radio<T>

Type Parameters:

T - The type of data to utilize in Consumers.

public class Radio<T>
extends java.lang.Object

The Radio class describes an event emitter that can be used for emitting and listening to events.

See Also:

https://en.wikipedia.org/wiki/Event-driven_programming

Constructor Summary

Constructors

Constructor and Description
Radio()

Method Summary

Modifier and Type	Method and Description
boolean	clear(java.lang.String event) Detach all attached Consumers from the specified event.
boolean	emit(java.lang.String event) Emit an event with the specified name.
boolean	emit(java.lang.String event, T data) Emit an event with the specified name and data.
boolean	off(java.lang.String event, java.util.function.Consumer<T> consumer) Detach a Consumer from the specified event.
boolean	on(java.lang.String event, java.util.function.Consumer<T> consumer) Attach a Consumer to the specified event.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Radio

public Radio()

Method Detail

emit

public final boolean emit(java.lang.String event)

Emit an event with the specified name.

Parameters:

event - The name of the event to emit.

Returns:

A boolean indicating whether or not the event was picked up by a Consumer.

emit

public final boolean emit(java.lang.String event,
                          T data)

Emit an event with the specified name and data.

Parameters:

event - The name of the event to emit.

data - The data to pass on to Consumers.

Returns:

A boolean indicating whether or not the event was picked up by a Consumer.

on

public final boolean on(java.lang.String event,
                        java.util.function.Consumer<T> consumer)

Attach a Consumer to the specified event.

Parameters:

event - The name of the event to attach the Consumer to.

consumer - The Consumer to attach to the specified event.

Returns:

A boolean indicating whether or not the operation affected the set of Consumers attached to the specified event.

off

public final boolean off(java.lang.String event,
                         java.util.function.Consumer<T> consumer)

Detach a Consumer from the specified event.

Parameters:

event - The name of the event to detach the Consumer from.

consumer - The Consumer to detach from the specified event.

Returns:

A boolean indicating whether or not the operation affected the set of Consumers attached to the specified event.

clear

public final boolean clear(java.lang.String event)

Detach all attached Consumers from the specified event.

Parameters:

event - The name of the event to detach all attached Consumers from.

Returns:

A boolean indicating whether or not the operation affected the set of Consumers attached to the specified event.