planet.commonapi.behaviours
Interface BehavioursFactory

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
BehavioursFactoryImpl

public interface BehavioursFactory
extends java.io.Serializable

This interface provides a method to get an instance of any component required in an overlay behaviours based implementation. When the current overlay don't use behaviours, all these factory methods throws an InitializationException.

Any future implementation must contain the no argument constructor.

Author:
Jordi Pujol, Marc Sanchez 07-jul-2005

Method Summary
 BehavioursFilter buildBehavioursFilter()
          Builds an instance of the current BehavioursFilter implementation.
 BehavioursInvoker buildBehavioursInvoker()
          Builds an instance of the current BehavioursInvoker implementation.
 BehavioursPattern buildBehavioursPattern()
          Builds an instance of the current BehavioursPattern implementation.
 BehavioursPool buildBehavioursPool()
          Builds an instance of the current BehavioursPool implementation.
 BehavioursRoleSelector buildBehavioursRoleSelector()
          Builds an instance of the current BehavioursRoleSelector implementation.
 BehavioursFactory setValues(java.lang.Class pool, java.lang.Class filter, java.lang.Class invoker, java.lang.Class pattern, java.lang.Class roleSelector)
          Sets the initial values for this BehavioursFactory.
 

Method Detail

setValues

public BehavioursFactory setValues(java.lang.Class pool,
                                   java.lang.Class filter,
                                   java.lang.Class invoker,
                                   java.lang.Class pattern,
                                   java.lang.Class roleSelector)
                            throws InitializationException
Sets the initial values for this BehavioursFactory.

Parameters:
pool - BehavioursPool class reference.
filter - BehavioursFilter class reference.
invoker - BehavioursInvoker class reference.
pattern - BehavioursPattern class reference.
roleSelector - BehavioursRoleSelector class reference.
Returns:
The same instance once it has been updated.
Throws:
InitializationException - if some error occurs during the initialization process.

buildBehavioursFilter

public BehavioursFilter buildBehavioursFilter()
                                       throws InitializationException
Builds an instance of the current BehavioursFilter implementation.

Returns:
An instance of the current BehavioursFilter implementation.
Throws:
InitializationException - when an error occurs during the initialization or when this factory method is non applicable.

buildBehavioursInvoker

public BehavioursInvoker buildBehavioursInvoker()
                                         throws InitializationException
Builds an instance of the current BehavioursInvoker implementation.

Returns:
An instance of the current BehavioursInvoker implementation.
Throws:
InitializationException - when an error occurs during the initialization or when this factory method is non applicable.

buildBehavioursPattern

public BehavioursPattern buildBehavioursPattern()
                                         throws InitializationException
Builds an instance of the current BehavioursPattern implementation.

Returns:
An instance of the current BehavioursPattern implementation.
Throws:
InitializationException - when an error occurs during the initialization or when this factory method is non applicable.

buildBehavioursPool

public BehavioursPool buildBehavioursPool()
                                   throws InitializationException
Builds an instance of the current BehavioursPool implementation.

Returns:
An instance of the current BehavioursPool implementation.
Throws:
InitializationException - when an error occurs during the initialization or when this factory method is non applicable.

buildBehavioursRoleSelector

public BehavioursRoleSelector buildBehavioursRoleSelector()
                                                   throws InitializationException
Builds an instance of the current BehavioursRoleSelector implementation.

Returns:
An instance of the current BehavioursRoleSelector implementation.
Throws:
InitializationException - when an error occurs during the initialization or when this factory method is non applicable.