A G H I M N O R S T

A

addMessageChannelObserver(MessageChannelObserver) - Method in class org.macroing.cit.messaging.MessageChannel

Adds messageChannelObserver to this MessageChannel, if absent.

addMessageFilter(MessageFilter) - Method in class org.macroing.cit.messaging.MessageChannel

Adds messageFilter to this MessageChannel, if absent.

addMessageHandler(MessageHandler) - Method in class org.macroing.cit.messaging.MessageChannel

Adds messageHandler to this MessageChannel, if absent.

addMessageTranslator(MessageTranslator) - Method in class org.macroing.cit.messaging.MessageChannel

Adds messageTranslator to this MessageChannel, if absent.

addMessagingObserver(MessagingObserver) - Method in class org.macroing.cit.messaging.Messaging

Adds a MessagingObserver to this Messaging.

G

getMessageChannelObservers() - Method in class org.macroing.cit.messaging.MessageChannel

Returns a List containing all MessageChannelObservers currently added to this MessageChannel.

getMessageFilters() - Method in class org.macroing.cit.messaging.MessageChannel

Returns a List containing all MessageFilters currently added to this MessageChannel.

getMessageHandlers() - Method in class org.macroing.cit.messaging.MessageChannel

Returns a List containing all MessageHandlers currently added to this MessageChannel.

getMessageTranslators() - Method in class org.macroing.cit.messaging.MessageChannel

Returns a List containing all MessageTranslators currently added to this MessageChannel.

getMessagingObservers() - Method in class org.macroing.cit.messaging.Messaging

Returns a List containing all currently added MessagingObservers.

getName() - Method in class org.macroing.cit.messaging.Messaging

Returns the name of this Messaging instance.

H

handle(Message) - Method in interface org.macroing.cit.messaging.MessageHandler

Called when a MessageChannels sendMessage(Message) method is called.

hasStarted() - Method in class org.macroing.cit.messaging.Messaging

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

I

isAccepted(Message) - Method in interface org.macroing.cit.messaging.MessageFilter

Returns true if, and only if, the Message is accepted, false otherwise.

isActive() - Method in class org.macroing.cit.messaging.MessageChannel

Returns true if, and only if, this MessageChannel is active, false otherwise.

M

Message - Interface in org.macroing.cit.messaging

A Message that can be sent to a MessageChannel.

MessageChannel - Class in org.macroing.cit.messaging

A MessageChannel is a channel in which you can send Messages.

MessageChannel() - Constructor for class org.macroing.cit.messaging.MessageChannel

Constructs a new empty MessageChannel instance.

MessageChannel(AtomicBoolean) - Constructor for class org.macroing.cit.messaging.MessageChannel

Constructs a new empty MessageChannel instance.

MessageChannelObserver - Interface in org.macroing.cit.messaging

A MessageChannelObserver observes changes made to a MessageChannel instance.

MessageChannelObservers - Class in org.macroing.cit.messaging

A class that consists exclusively of static methods that operates on or returns MessageChannelObservers.

MessageFilter - Interface in org.macroing.cit.messaging

A MessageFilter filters what Messages a MessageChannel should process.

MessageHandler - Interface in org.macroing.cit.messaging

A MessageHandler handles a Message sent to a MessageChannel instance.

Messages - Class in org.macroing.cit.messaging

A class that consists exclusively of static methods that operates on or returns Messages.

messageSent(MessageChannel, Message) - Method in interface org.macroing.cit.messaging.MessageChannelObserver

Called by a MessageChannel when its sendMessage(Message) method has been called.

MessageTranslator - Interface in org.macroing.cit.messaging

A MessageTranslator is used to translate one Message being processed by a MessageChannel instance, into a possibly different one.

Messaging - Class in org.macroing.cit.messaging

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

Messaging() - Constructor for class org.macroing.cit.messaging.Messaging

Constructs a new Messaging instance.

MessagingObserver - Interface in org.macroing.cit.messaging

A MessagingObserver observes changes made to a Messaging instance.

messagingStarted(Messaging) - Method in interface org.macroing.cit.messaging.MessagingObserver

Called when a Messaging is started.

messagingStopped(Messaging) - Method in interface org.macroing.cit.messaging.MessagingObserver

Called when a Messaging is stopped.

N

newConsoleLoggingMessageChannelObserver() - Static method in class org.macroing.cit.messaging.MessageChannelObservers

Returns a new MessageChannelObserver instance that prints all incoming Messages to System.out.

newInstance() - Static method in class org.macroing.cit.messaging.MessageChannel

Returns a new MessageChannel instance.

newInstance(AtomicBoolean) - Static method in class org.macroing.cit.messaging.MessageChannel

Returns a new MessageChannel instance.

newStringMessage(String) - Static method in class org.macroing.cit.messaging.Messages

Returns a new Message that has a toString() method that returns toString.

O

onStart() - Method in class org.macroing.cit.messaging.Messaging

Override this method to handle start logic for this Messaging.

onStop() - Method in class org.macroing.cit.messaging.Messaging

Override this method to handle stop logic for this Messaging.

org.macroing.cit.messaging - package org.macroing.cit.messaging

Provides the API for CIT Messaging.

R

removeAllMessageChannelObservers() - Method in class org.macroing.cit.messaging.MessageChannel

Removes all currently added MessageChannelObservers from this MessageChannel.

removeAllMessageFilters() - Method in class org.macroing.cit.messaging.MessageChannel

Removes all currently added MessageFilters from this MessageChannel.

removeAllMessageHandlers() - Method in class org.macroing.cit.messaging.MessageChannel

Removes all currently added MessageHandlers from this MessageChannel.

removeAllMessageTranslators() - Method in class org.macroing.cit.messaging.MessageChannel

Removes all currently added MessageTranslators from this MessageChannel.

removeMessageChannelObserver(MessageChannelObserver) - Method in class org.macroing.cit.messaging.MessageChannel

Removes messageChannelObserver from this MessageChannel, if present.

removeMessageFilter(MessageFilter) - Method in class org.macroing.cit.messaging.MessageChannel

Removes messageFilter from this MessageChannel, if present.

removeMessageHandler(MessageHandler) - Method in class org.macroing.cit.messaging.MessageChannel

Removes messageHandler from this MessageChannel, if present.

removeMessageTranslator(MessageTranslator) - Method in class org.macroing.cit.messaging.MessageChannel

Removes messageTranslator from this MessageChannel, if present.

removeMessagingObserver(MessagingObserver) - Method in class org.macroing.cit.messaging.Messaging

Removes a MessagingObserver from this Messaging.

S

sendMessage(Message) - Method in class org.macroing.cit.messaging.MessageChannel

Sends a Message.

setName(String) - Method in class org.macroing.cit.messaging.Messaging

Sets a new name for this Messaging instance.

start() - Method in class org.macroing.cit.messaging.Messaging

Call this method when you want to start this Messaging.

stop() - Method in class org.macroing.cit.messaging.Messaging

Call this method when you want to stop this Messaging.

T

translate(Message) - Method in interface org.macroing.cit.messaging.MessageTranslator

Returns a Message that represents a potentially translated version of message.

A G H I M N O R S T