app.framework

Class Model

java.lang.Object

app.framework.Model

Direct Known Subclasses:

TodoModel

public abstract class Model
extends java.lang.Object

The Model class describes all the basic functionality of a model within the MVC architecture.

From Wikipedia:

A model notifies its associated views and controllers when there has been a change in its state. This notification allows the views to produce updated output, and the controllers to change the available set of commands.

See Also:

http://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller

Constructor Summary

Constructors

Constructor and Description
Model(Application application) Initialize a new Model instance for the specified Application.

Method Summary

Modifier and Type	Method and Description
protected Application	application() Access the Application that the Model is associated with.
protected boolean	emit(java.lang.String event) Emit an event with the specified name.
protected <T> boolean	emit(java.lang.String event, T data) Emit an event with the specified name and data.
<T> boolean	off(java.lang.String event, java.util.function.Consumer<T> consumer) Detach a Consumer from the specified event.
<T> 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

Model

public Model(Application application)

Initialize a new Model instance for the specified Application.

Parameters:

application - The Application that the Model is associated with.

Method Detail

application

protected final Application application()

Access the Application that the Model is associated with.

Returns:

The Application that the Model is associated with.

emit

protected 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

protected final <T> boolean emit(java.lang.String event,
                                 T data)

Emit an event with the specified name and data.

Type Parameters:

T - The type of data to utilize in Consumers.

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 <T> boolean on(java.lang.String event,
                            java.util.function.Consumer<T> consumer)

Attach a Consumer to the specified event.

Type Parameters:

T - The type of data to utilize in Consumers.

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 <T> boolean off(java.lang.String event,
                             java.util.function.Consumer<T> consumer)

Detach a Consumer from the specified event.

Type Parameters:

T - The type of data to utilize in Consumers.

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.