ix.ip2
Class SyncState.SyncStateHandler

java.lang.Object
  ix.ip2.ItemHandler
      ix.ip2.ActivityHandler
          ix.ip2.SyncState.SyncStateHandler

Direct Known Subclasses:

SyncStateClient.SyncStateClientHandler, SyncStateServer.SyncStateServerHandler

Enclosing class:

SyncState

public abstract static class SyncState.SyncStateHandler
extends ActivityHandler

Field Summary

protected Ip2

ip2

Fields inherited from class ix.ip2.ItemHandler

actionDescription

Constructor Summary

SyncState.SyncStateHandler(Ip2 ip2, java.lang.String description)

Method Summary

void	addHandlerActions(AgendaItem item) Called to add any HandlerActions that this handler regards as appropriate for the specified AgendaItem.
boolean	appliesTo(AgendaItem item) Gives this handler a say in whether it should add actions to an item.
protected SyncState.Operation	getOperation(AgendaItem item)
java.util.List	getSyntaxList() Returns a list of patterns representing the item pattern syntaxes this handler can process, or null if no particular syntax is required.
abstract void	handle(AgendaItem item) Called to perform the action implemented by this handler, if the selected HandlerAction so desires.
boolean	isAutomatic() Indicates whether this handler has the authority to handle items automatically rather than only when explicitly invoked.

Methods inherited from class ix.ip2.ActivityHandler

toString

Methods inherited from class ix.ip2.ItemHandler

getActionDescription, makeHandler, reviseHandlerActions

Methods inherited from class java.lang.Object

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

Field Detail

ip2

protected Ip2 ip2

Constructor Detail

SyncState.SyncStateHandler

public SyncState.SyncStateHandler(Ip2 ip2,
                                  java.lang.String description)

Method Detail

getSyntaxList

public java.util.List getSyntaxList()

Description copied from class: ItemHandler

Returns a list of patterns representing the item pattern syntaxes this handler can process, or null if no particular syntax is required. Note that this information is not automatically used when determining whether this handler should add actions to an agenda item. Instead, this handler's contribution to that decision is supplied by the ItemHandler.appliesTo(AgendaItem) method.

Overrides:

getSyntaxList in class ItemHandler

See Also:

AgendaItem.getPattern()

appliesTo

public boolean appliesTo(AgendaItem item)

Description copied from class: ItemHandler

Gives this handler a say in whether it should add actions to an item. If this method returns false for an AgendaItem, or the item's wantsActionsFrom method returns false for this handler, this handler will not be asked to add actions to that item.

Overrides:

appliesTo in class ItemHandler

See Also:

AgendaItem.wantsActionsFrom(ItemHandler handler)

getOperation

protected SyncState.Operation getOperation(AgendaItem item)

isAutomatic

public boolean isAutomatic()

Description copied from class: ItemHandler

Indicates whether this handler has the authority to handle items automatically rather than only when explicitly invoked.

Overrides:

isAutomatic in class ItemHandler

addHandlerActions

public void addHandlerActions(AgendaItem item)

Description copied from class: ItemHandler

Called to add any HandlerActions that this handler regards as appropriate for the specified AgendaItem.

This method is called only if both this handler's ItemHandler.appliesTo(AgendaItem) and the specified item's AgendaItem.wantsActionsFrom(ItemHandler) methods return true.

The method provided by the ItemHandler class just adds an action that calls this handler's ItemHandler.handle(AgendaItem) method. This allows suitably simple handlers to avoid working directly with HandlerActions.

Note that actions are added by calling an item's AgendaItem.addAction(HandlerAction) method.

Overrides:

addHandlerActions in class ItemHandler

handle

public abstract void handle(AgendaItem item)

Description copied from class: ItemHandler

Called to perform the action implemented by this handler, if the selected HandlerAction so desires.

Overrides:

handle in class ItemHandler

See Also:

ItemHandler.addHandlerActions(AgendaItem)