org.dimx
Class CustEventProcessor

java.lang.Object
  org.dimx.CustEventProcessor

All Implemented Interfaces:

IEventProcessor

Direct Known Subclasses:

CSIEventProcessor

public class CustEventProcessor
extends java.lang.Object
implements IEventProcessor

A simple implementation of IEventProcessor intended to be subclassed. This implementation simply returns the defaultResult for each interface method. If mustExist is true for any call then an appropriate DimxException is thrown.

Most subclasses will override desired methods and only call the super.method if they have not implemented support for the eventId provided.

Field Summary

protected World

_world

Constructor Summary

CustEventProcessor()

Method Summary

Token	execute(java.lang.String eventId, DimxObject owner, AdvObject agent, DictSorted actualpar, Token defaultResult, boolean mustExist) Override as desired in subclasses.
Token	fireEvent_t(java.lang.String eventId, DimxObject owner, java.lang.String agent, java.lang.String target, DictSorted params, Token defaultResult, boolean mustExist) Override as desired in subclasses.
boolean	fireEvent(java.lang.String eventId, DimxObject owner, java.lang.String agent, java.lang.String target, DictSorted input, boolean defaultResult, boolean mustExist) Override as desired in subclasses.
void	setWorld(World world) Called immediately after instantiation.

Methods inherited from class java.lang.Object

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

Field Detail

_world

protected World _world

Constructor Detail

CustEventProcessor

public CustEventProcessor()

Method Detail

setWorld

public void setWorld(World world)
              throws DimxException

Called immediately after instantiation.

Specified by:

setWorld in interface IEventProcessor

Parameters:

world -

Throws:

DimxException

execute

public Token execute(java.lang.String eventId,
                     DimxObject owner,
                     AdvObject agent,
                     DictSorted actualpar,
                     Token defaultResult,
                     boolean mustExist)
              throws DimxException

Override as desired in subclasses. Call super.execute(...) when the eventId provided is not supported by the subclass.

Specified by:

execute in interface IEventProcessor

Parameters:

eventId -

owner -

agent -

actualpar -

defaultResult -

mustExist -

Returns:

defaultResult or throws DimxException if mustExist is true.

Throws:

DimxException

See Also:

World.execute(String,DimxObject,AdvObject,DictSorted,Token,boolean)

fireEvent

public boolean fireEvent(java.lang.String eventId,
                         DimxObject owner,
                         java.lang.String agent,
                         java.lang.String target,
                         DictSorted input,
                         boolean defaultResult,
                         boolean mustExist)
                  throws DimxException

Override as desired in subclasses. Call super.fireEvent(...) when the eventId provided is not supported by the subclass.

Specified by:

fireEvent in interface IEventProcessor

Parameters:

eventId -

owner -

agent -

target -

input -

defaultResult -

mustExist -

Returns:

defaultResult or throws DimxException if mustExist is true.

Throws:

DimxException

See Also:

World.fireEvent(String,DimxObject,String,String,DictSorted,boolean,boolean)

fireEvent_t

public Token fireEvent_t(java.lang.String eventId,
                         DimxObject owner,
                         java.lang.String agent,
                         java.lang.String target,
                         DictSorted params,
                         Token defaultResult,
                         boolean mustExist)
                  throws DimxException

Override as desired in subclasses. Call super.fireEvent_t(...) when the eventId provided is not supported by the subclass.

Specified by:

fireEvent_t in interface IEventProcessor

Parameters:

eventId -

owner -

agent -

target -

params -

defaultResult -

mustExist -

Returns:

defaultResult or throws DimxException if mustExist is true.

Throws:

DimxException

See Also:

World.fireEvent_t(String,DimxObject,String,String,DictSorted,Token,boolean)