org.arl.fjage

Class MessageBehavior

java.lang.Object

org.arl.fjage.Behavior

org.arl.fjage.MessageBehavior

All Implemented Interfaces:

java.lang.Comparable<Behavior>

Direct Known Subclasses:

ParameterMessageBehavior

public class MessageBehavior
extends Behavior

A behavior that continuously monitors the incoming message queue. The onReceive(Message) method of this behavior is called for every incoming message that matches the input filter defined for the behavior.

Field Summary

Fields inherited from class org.arl.fjage.Behavior

action, agent, log

Constructor Summary

Constructors

Constructor and Description
MessageBehavior() Creates a MessageBehavior that accepts all incoming messages.
MessageBehavior(java.lang.Class<?> cls) Creates a MessageBehavior that accepts all incoming messages of a given class.
MessageBehavior(java.lang.Class<?> cls, java.util.function.Consumer<Message> consumer) Creates a MessageBehavior that accepts all incoming messages of a given class.
MessageBehavior(java.util.function.Consumer<Message> consumer) Creates a MessageBehavior that accepts all incoming messages.
MessageBehavior(MessageFilter filter) Creates a MessageBehavior that accepts all incoming messages that meet a given MessageFilter criteria.
MessageBehavior(MessageFilter filter, java.util.function.Consumer<Message> consumer) Creates a MessageBehavior that accepts all incoming messages that meet a given MessageFilter criteria.

Method Summary

Modifier and Type	Method and Description
boolean	accepts(Message msg) Check if this MessageBehavior accepts a specific message.
void	action() This method calls onReceive(Message) for every message received that meets the acceptance criteria.
static MessageBehavior	create(java.lang.Class<? extends Message> messageClass, java.util.function.Consumer<Message> consumer) Creates a new MessageBehavior which runs the specified Consumer on each incoming message that matches the message filter.
static MessageBehavior	create(java.util.function.Consumer<Message> consumer) Creates a new MessageBehavior which runs the specified Consumer on each incoming message.
static MessageBehavior	create(MessageFilter messageFilter, java.util.function.Consumer<Message> consumer) Creates a new MessageBehavior which runs the specified Consumer on each incoming message that matches the message filter.
boolean	done() This method always returns false, since this behavior never terminates.
int	getPriority() Message behaviors with filters return a priority value of -100 to allow them to be executed before general message behaviors (no filters, priority value of 0).
void	onReceive(Message msg) This method is called for each message meeting the acceptance criteria of this behavior.

Methods inherited from class org.arl.fjage.Behavior

agent, agentForService, agentForService, agentsForService, agentsForService, block, block, compareTo, isBlocked, onEnd, onStart, println, reset, restart

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageBehavior

public MessageBehavior()

Creates a MessageBehavior that accepts all incoming messages.

MessageBehavior

public MessageBehavior(java.lang.Class<?> cls)

Creates a MessageBehavior that accepts all incoming messages of a given class.

Parameters:

cls - message class of interest.

MessageBehavior

public MessageBehavior(MessageFilter filter)

Creates a MessageBehavior that accepts all incoming messages that meet a given MessageFilter criteria.

Parameters:

filter - message filter.

MessageBehavior

public MessageBehavior(java.util.function.Consumer<Message> consumer)

Creates a MessageBehavior that accepts all incoming messages.

Parameters:

consumer - Message consumer.

MessageBehavior

public MessageBehavior(java.lang.Class<?> cls,
                       java.util.function.Consumer<Message> consumer)

Creates a MessageBehavior that accepts all incoming messages of a given class.

Parameters:

cls - message class of interest.

consumer - Message consumer.

MessageBehavior

public MessageBehavior(MessageFilter filter,
                       java.util.function.Consumer<Message> consumer)

Creates a MessageBehavior that accepts all incoming messages that meet a given MessageFilter criteria.

Parameters:

filter - message filter.

consumer - Message consumer.

Method Detail

accepts

public boolean accepts(Message msg)

Check if this MessageBehavior accepts a specific message.

Parameters:

msg - message to check.

Returns:

true if it accepts, false otherwise.

onReceive

public void onReceive(Message msg)

This method is called for each message meeting the acceptance criteria of this behavior. A behavior must override this.

Parameters:

msg - received message.

action

public final void action()

This method calls onReceive(Message) for every message received that meets the acceptance criteria. The method causes the behavior to be blocked until appropriate message becomes available.

Overrides:

action in class Behavior

See Also:

Behavior.action()

done

public final boolean done()

This method always returns false, since this behavior never terminates.

Overrides:

done in class Behavior

Returns:

false.

See Also:

Behavior.done()

getPriority

public int getPriority()

Message behaviors with filters return a priority value of -100 to allow them to be executed before general message behaviors (no filters, priority value of 0).

Overrides:

getPriority in class Behavior

Returns:

priority value

create

public static MessageBehavior create(java.util.function.Consumer<Message> consumer)

Creates a new MessageBehavior which runs the specified Consumer on each incoming message.

Parameters:

consumer - Consumer to run.

Returns:

MessageBehavior

create

public static MessageBehavior create(java.lang.Class<? extends Message> messageClass,
                                     java.util.function.Consumer<Message> consumer)

Creates a new MessageBehavior which runs the specified Consumer on each incoming message that matches the message filter.

Parameters:

messageClass - Message class of interest.

consumer - Consumer to run.

Returns:

MessageBehavior

create

public static MessageBehavior create(MessageFilter messageFilter,
                                     java.util.function.Consumer<Message> consumer)

Creates a new MessageBehavior which runs the specified Consumer on each incoming message that matches the message filter.

Parameters:

messageFilter - Message filter.

consumer - Consumer to run.

Returns:

MessageBehavior