org.apache.beehive.controls.runtime.generator
Class ControlEventSet

Object
  extended by ControlEventSet
Direct Known Subclasses:
AptEventSet

public abstract class ControlEventSet
extends Object

The ControlEventSet class is an abstract base class that represents an EventSet on the interface of a ControlBean type.


Constructor Summary
protected ControlEventSet(ControlInterface controlIntf)
          Base constructor, protected so only a custom subclass can invoke
 
Method Summary
 String getAddListenerMethod()
          Returns the name of the method used to register a new EventSet listener
 ArrayList<ControlEvent> getEvents()
          Returns the list of ControlEvents associated with this ControlEventSet
abstract  String getName()
          Returns the fully qualified EventSet name
 String getNotifierClass()
          Returns the name of the generated notifier class for this ControlEventSet
 String getNotifierExtends()
          Returns any 'extends' clause that should be placed on the generated notifier class
 String getRemoveListenerMethod()
          Returns the name of the method used to register a new EventSet listener
 String getShortName()
          Returns the unqualified class name for this event set
protected  void init()
          Initializes the ControlEventSet instance.
protected abstract  ArrayList<ControlEvent> initEvents()
          Initializes the list of ControlEvents associated with this ControlEventSet
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ControlEventSet

protected ControlEventSet(ControlInterface controlIntf)
Base constructor, protected so only a custom subclass can invoke

Parameters:
controlIntf - the declaring ControlInterface
Method Detail

init

protected void init()
Initializes the ControlEventSet instance. This will be called by custom subclasses to drive the initialization process.


initEvents

protected abstract ArrayList<ControlEvent> initEvents()
Initializes the list of ControlEvents associated with this ControlEventSet


getEvents

public ArrayList<ControlEvent> getEvents()
Returns the list of ControlEvents associated with this ControlEventSet


getName

public abstract String getName()
Returns the fully qualified EventSet name


getShortName

public String getShortName()
Returns the unqualified class name for this event set


getNotifierClass

public String getNotifierClass()
Returns the name of the generated notifier class for this ControlEventSet


getNotifierExtends

public String getNotifierExtends()
Returns any 'extends' clause that should be placed on the generated notifier class


getAddListenerMethod

public String getAddListenerMethod()
Returns the name of the method used to register a new EventSet listener


getRemoveListenerMethod

public String getRemoveListenerMethod()
Returns the name of the method used to register a new EventSet listener