io.sarl.sre.internal.eventguard

Class BehaviorGuardEvaluatorRegistry

java.lang.Object

io.sarl.sre.internal.eventguard.BehaviorGuardEvaluatorRegistry

public class BehaviorGuardEvaluatorRegistry
extends Object

Registry of all BehaviorGuardEvaluator classes containing a method to evaluate the guard of a given behavior (on clause in SARL behavior).

This class is thread-safe.

Version:

0.12.0-SNAPSHOT 2020-06-30 17:45:08

Author:

Stéphane Galland

Maven Group Id:

io.janusproject

Maven Artifact Id:

io.janusproject.plugin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BehaviorGuardEvaluatorRegistry.GuardedEvaluator Description of a set of guard evaluators with a shared activation guard.

Constructor Summary

Constructors

Constructor and Description
BehaviorGuardEvaluatorRegistry() Instanciates a new registry linked with the PerceptGuardEvaluator annotation.

Method Summary

Modifier and Type	Method and Description
ConcurrentLinkedDeque<BehaviorGuardEvaluator>	getBehaviorGuardEvaluators(event : Event) Gets an iterator representing an immutable snapshot of all BehaviorGuardEvaluators to the given event at the time this method is called.
ConcurrentLinkedDeque<BehaviorGuardEvaluator>	getBehaviorGuardEvaluatorsFor(event : Event, listener : Object) Gets an iterator representing an immutable snapshot of all BehaviorGuardEvaluators of the given listener to the given event at the time this method is called.
ConcurrentHashMap<Class<? extends Event>,CopyOnWriteArraySet<BehaviorGuardEvaluatorRegistry.GuardedEvaluator>>	getInternalDataStructure() Replies the internal data structure.
<T> ConcurrentSkipListSet<T>	getRegisteredEventListeners(type : Class<T>) Extract the registered listeners with the given type.
<T> int	getRegisteredEventListeners(type : Class<T>, collection : Collection<? super T>) Deprecated. since 0.11, see BehaviorGuardEvaluatorRegistry.getRegisteredEventListeners(Class,Set).
<T> int	getRegisteredEventListeners(type : Class<T>, collection : Set<? super T>) Extract the registered listeners with the given type.
boolean	hasRegisteredEventListener(type : Class<?>) Replies if a listener with the given type is registered.
void	register(listener : Object, filter : (Event)=>Boolean, [callback : (Object)=>void]) Registers all PerceptGuardEvaluator methods on the given listener object.
void	register(listener : Object, [callback : (Object)=>void]) Registers all PerceptGuardEvaluator methods on the given listener object.
void	unregister(listenerType : Class<?>, callback : (Object)=>Boolean) Unregisters all BehaviorGuardEvaluators on the listener objects of the given type.
void	unregister(listener : Object, callback : (Object)=>void) Unregisters all BehaviorGuardEvaluators on the given listener object.
void	unregisterAll(callback : (Object)=>Boolean) Unregisters all BehaviorGuardEvaluators on all the listener objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

BehaviorGuardEvaluatorRegistry

public new()

Instanciates a new registry linked with the PerceptGuardEvaluator annotation.

The registry will use concurrent data structures.

Parameters:

internalMap - the internal map.

Method Detail

getInternalDataStructure

@Pure
public def getInternalDataStructure() : ConcurrentHashMap<Class<? extends Event>,CopyOnWriteArraySet<BehaviorGuardEvaluatorRegistry.GuardedEvaluator>> 

Description copied from class: BehaviorGuardEvaluatorRegistry

Replies the internal data structure.

Returns:

the internal data structure

register

public def register(listener : Object,
                    [callback : (Object)=>void]) : void 

Description copied from class: BehaviorGuardEvaluatorRegistry

Registers all PerceptGuardEvaluator methods on the given listener object.

Parameters:

listener - the new BehaviorGuardEvaluator to add

callback - function which is invoked just after the first registration of the object. It could be null.

Since:

0.5

register

public def register(listener : Object,
                    filter : (Event)=>Boolean,
                    [callback : (Object)=>void]) : void 

Description copied from class: BehaviorGuardEvaluatorRegistry

Registers all PerceptGuardEvaluator methods on the given listener object.

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.

Parameters:

listener - the new BehaviorGuardEvaluator to add

filter - the filter function.

callback - function which is invoked just after the registration of the object. It could be null.

Since:

0.5

unregisterAll

public def unregisterAll(callback : (Object)=>Boolean) : void 

Description copied from class: BehaviorGuardEvaluatorRegistry

Unregisters all BehaviorGuardEvaluators on all the listener objects.

Parameters:

callback - function which is invoked just before the object is unregistered. It could be null. The callback functions replies true if it should be called on the next removed object. If it replies false, it will be not called anymore.

Since:

0.5

unregister

public def unregister(listener : Object,
                      callback : (Object)=>void) : void 

Description copied from class: BehaviorGuardEvaluatorRegistry

Unregisters all BehaviorGuardEvaluators on the given listener object.

Parameters:

listener - the new BehaviorGuardEvaluator to remove

callback - function which is invoked just before the object is unregistered. It could be null.

Since:

0.5

unregister

public def unregister(listenerType : Class<?>,
                      callback : (Object)=>Boolean) : void 

Description copied from class: BehaviorGuardEvaluatorRegistry

Unregisters all BehaviorGuardEvaluators on the listener objects of the given type.

Parameters:

listenerType - the type of the BehaviorGuardEvaluator to remove

callback - function which is invoked just before the object is unregistered. It could be null. The callback functions replies true if it should be called on the next removed object. If it replies false, it will be not called anymore.

Since:

0.7

hasRegisteredEventListener

@Pure
public def hasRegisteredEventListener(type : Class<?>) : boolean 

Description copied from class: BehaviorGuardEvaluatorRegistry

Replies if a listener with the given type is registered.

Parameters:

type - the type of listener.

Returns:

true if a listener of the given type is registered.

Since:

0.5

getBehaviorGuardEvaluators

@Pure
public def getBehaviorGuardEvaluators(event : Event) : ConcurrentLinkedDeque<BehaviorGuardEvaluator> 

Description copied from class: BehaviorGuardEvaluatorRegistry

Gets an iterator representing an immutable snapshot of all BehaviorGuardEvaluators to the given event at the time this method is called.

Parameters:

event - -the event to process

Returns:

the set of guard evaluators associated to the specified event

getBehaviorGuardEvaluatorsFor

@Pure
public def getBehaviorGuardEvaluatorsFor(event : Event,
                                               listener : Object) : ConcurrentLinkedDeque<BehaviorGuardEvaluator> 

Description copied from class: BehaviorGuardEvaluatorRegistry

Gets an iterator representing an immutable snapshot of all BehaviorGuardEvaluators of the given listener to the given event at the time this method is called.

Caution: This function does not apply filtering function given to #register(Object, Function1, Procedure1).

Parameters:

event - -the event to process

listener - the owner of the BehaviorGuardEvaluators (never null).

Returns:

the set of guard evaluators associated to the specified event

Since:

0.5

getRegisteredEventListeners

@Pure
public def getRegisteredEventListeners(type : Class<T>,
                                             collection : Set<? super T>) : int  with <T> 

Description copied from class: BehaviorGuardEvaluatorRegistry

Extract the registered listeners with the given type.

Type Parameters:

T - the type of the listeners.

Parameters:

type - the type of the listeners.

collection - the collection of listeners that is filled by this function. This argument could be null.

Returns:

the number of listeners of the given type.

Since:

0.11

getRegisteredEventListeners

@Deprecated
 @Pure
public def getRegisteredEventListeners(type : Class<T>,
                                                          collection : Collection<? super T>) : int  with <T> 

Deprecated. since 0.11, see BehaviorGuardEvaluatorRegistry.getRegisteredEventListeners(Class,Set).

Description copied from class: BehaviorGuardEvaluatorRegistry

Extract the registered listeners with the given type.

Type Parameters:

T - the type of the listeners.

Parameters:

type - the type of the listeners.

collection - the collection of listeners that is filled by this function. This argument could be null.

Returns:

the number of listeners of the given type.

Since:

0.5

getRegisteredEventListeners

@Pure
public def getRegisteredEventListeners(type : Class<T>) : ConcurrentSkipListSet<T>  with <T> 

Description copied from class: BehaviorGuardEvaluatorRegistry

Extract the registered listeners with the given type.

Type Parameters:

T - the type of the listeners.

Parameters:

type - the type of the listeners.

Returns:

the listeners.

Since:

0.6