io.sarl.core

Capacity Behaviors

All Superinterfaces:

Capacity

public interface Behaviors
extends Capacity

Agent behaviors management.

Nested Class Summary

Nested classes/interfaces inherited from interface io.sarl.lang.core.Capacity

Capacity.ContextAwareCapacityWrapper<C extends Capacity>

Method Summary

Modifier and Type	Method and Description
EventListener	asEventListener() Replies the interface to dispatch an event to agent's Behaviors.
ConcurrentCollection<Behavior>	getRegisteredBehaviors() Replies the registered behaviors.
boolean	hasRegisteredBehavior() Replies true if at least a behavior is registered.
Behavior	registerBehavior(attitude : Behavior, [filter : (Event)=>Boolean], initializationParameters : Object*) Register a Behavior for the owner agent.
Behavior	unregisterBehavior(attitude : Behavior) Unregisters a behavior for the owner agent.
void	wake(behavior : Behavior, event : Event) Wake a specific agent's behavior reacting to the Event evt.
void	wake(event : Event, [scope : Scope<Address>]) Wake the agent's behaviors reacting to the Event evt.
void	wake(behaviors : Iterable<Behavior>, event : Event) Wake a set of specific agent's behaviors reacting to the Event evt.

Method Detail

hasRegisteredBehavior

@Pure
def hasRegisteredBehavior() : boolean 

Description copied from interface: Behaviors

Replies true if at least a behavior is registered.

A registered behavior is not necessary running. It may wait for events.

Returns:

true if a behavior is registered; otherwise false.

Since:

0.5

getRegisteredBehaviors

@Pure
def getRegisteredBehaviors() : ConcurrentCollection<Behavior> 

Description copied from interface: Behaviors

Replies the registered behaviors.

A registered behavior is not necessary running. It may wait for events.

Returns:

the unmodifiable collection of the registered behavior.

Since:

0.5

registerBehavior

def registerBehavior(attitude : Behavior,
                     [filter : (Event)=>Boolean],
                     initializationParameters : Object*) : Behavior 

Description copied from interface: Behaviors

Register a Behavior for the owner agent. The new Behavior will react to all declared events received by the agent.

If the filter is provided, it will be used for determining if the given behavior accepts a specific event. If the filter function replies true for a specific event as argument, the event is fired in the behavior context. If the filter function replies false, the event is not fired in the behavior context.

This function does nothing if one of the following conditions evaluates to true:

• the agent is not alive.

Parameters:

attitude - the behavior to add to the agent.

filter - the filter that enables to indicates if an event is accepted by a behavior.

initializationParameters - the set of parameters to pass to the behavior within the Initialize event.

Returns:

the given behavior.

Since:

0.5 for the filter parameter.

unregisterBehavior

def unregisterBehavior(attitude : Behavior) : Behavior 

Description copied from interface: Behaviors

Unregisters a behavior for the owner agent.

Parameters:

attitude - the behavior to remove to the agent.

Returns:

the given behavior.

wake

def wake(event : Event,
         [scope : Scope<Address>]) : void 

Description copied from interface: Behaviors

Wake the agent's behaviors reacting to the Event evt.

Note that the scope parameter could be used only for filtering the agents (the current receiving agent) in order to determine the ones that will receive the event. The behaviors of the current agent (registered with #registerBehavior(Behavior, Function1, Object[]) will always receive the event if the current agent is not discarded. Because the behaviors have no associated address, they cannot be filtered individually.

This function does nothing if one of the following conditions evaluates to true:

• the agent is not alive.

Parameters:

event - the event to emit to the agent's behaviors and in the internal context.

scope - the definition of the scope that will be used for selected the receivers of the events.

wake

def wake(behavior : Behavior,
         event : Event) : void 

Description copied from interface: Behaviors

Wake a specific agent's behavior reacting to the Event evt.

This function does nothing if one of the following conditions evaluates to true:

• the agent is not alive.

Parameters:

behavior - the agent's behavior to wake up.

event - the event to emit to the agent's behaviors and in the internal context.

Since:

0.12

wake

def wake(behaviors : Iterable<Behavior>,
         event : Event) : void 

Description copied from interface: Behaviors

Wake a set of specific agent's behaviors reacting to the Event evt.

This function does nothing if one of the following conditions evaluates to true:

• the agent is not alive.

Parameters:

behaviors - the agent's behaviors to wake up.

event - the event to emit to the agent's behaviors and in the internal context.

Since:

0.12

asEventListener

@Pure
def asEventListener() : EventListener 

Description copied from interface: Behaviors

Replies the interface to dispatch an event to agent's Behaviors.

Returns:

the event listener.