org.macroing.cit.messaging

Class Messaging

java.lang.Object

org.macroing.cit.messaging.Messaging

public abstract class Messaging
extends java.lang.Object

A Messaging is an abstract base class for defining a messaging system.

Since:

1.0.0

Author:

Jörgen Lundgren

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Messaging() Constructs a new Messaging instance.

Method Summary

Modifier and Type	Method and Description
void	addMessagingObserver(MessagingObserver messagingObserver) Adds a MessagingObserver to this Messaging.
java.util.List<MessagingObserver>	getMessagingObservers() Returns a List containing all currently added MessagingObservers.
java.lang.String	getName() Returns the name of this Messaging instance.
boolean	hasStarted() Returns true if, and only if, this Messaging has started, false otherwise.
protected void	onStart() Override this method to handle start logic for this Messaging.
protected void	onStop() Override this method to handle stop logic for this Messaging.
void	removeMessagingObserver(MessagingObserver messagingObserver) Removes a MessagingObserver from this Messaging.
void	setName(java.lang.String name) Sets a new name for this Messaging instance.
void	start() Call this method when you want to start this Messaging.
void	stop() Call this method when you want to stop this Messaging.

Methods inherited from class java.lang.Object

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

Constructor Detail

Messaging

protected Messaging()

Constructs a new Messaging instance.

Method Detail

hasStarted

public final boolean hasStarted()

Returns true if, and only if, this Messaging has started, false otherwise.

Returns:

true if, and only if, this Messaging has started, false otherwise

getMessagingObservers

public final java.util.List<MessagingObserver> getMessagingObservers()

Returns a List containing all currently added MessagingObservers.

If no MessagingObservers have been added, an empty List will be returned, not null.

Modifying the returned List will not affect this Messaging instance.

Returns:

a List containing all currently added MessagingObservers

getName

public final java.lang.String getName()

Returns the name of this Messaging instance.

By default the name will be equal to getClass().getName().

Returns:

the name of this Messaging instance

addMessagingObserver

public final void addMessagingObserver(MessagingObserver messagingObserver)

Adds a MessagingObserver to this Messaging.

If it has already been added, nothing will happen.

If messagingObserver is null, a NullPointerException will be thrown.

Parameters:

messagingObserver - the MessagingObserver to add

Throws:

java.lang.NullPointerException - thrown if, and only if, messagingObserver is null

onStart

protected void onStart()

Override this method to handle start logic for this Messaging.

This method will be called as soon as the start() method is called. This will happen prior to the notification of all currently added MessagingObservers.

By default this method does nothing.

onStop

protected void onStop()

Override this method to handle stop logic for this Messaging.

This method will be called as soon as the stop() method is called. This will happen prior to the notification of all currently added MessagingObservers.

By default this method does nothing.

removeMessagingObserver

public final void removeMessagingObserver(MessagingObserver messagingObserver)

Removes a MessagingObserver from this Messaging.

If it has not already been added, nothing will happen.

If messagingObserver is null, a NullPointerException will be thrown.

Parameters:

messagingObserver - the MessagingObserver to remove

Throws:

java.lang.NullPointerException - thrown if, and only if, messagingObserver is null

setName

public final void setName(java.lang.String name)

Sets a new name for this Messaging instance.

If name is null, a NullPointerException will be thrown.

By default the name will be equal to getClass().getName().

Parameters:

name - the new name for this Messaging instance

Throws:

java.lang.NullPointerException - thrown if, and only if, name is null

start

public final void start()

Call this method when you want to start this Messaging.

This method will first make a call to the onStart() method. Then all currently added MessagingObservers will be notified.

If it has already started, nothing will happen.

stop

public final void stop()

Call this method when you want to stop this Messaging.

This method will first make a call to the onStop() method. Then all currently added MessagingObservers will be notified.

If it has already stopped or it has never started, nothing will happen.