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

Object
  extended by AptType
      extended by AptEventSet

public class AptEventSet
extends AptType

The AptEventSet class represents a control EventSet where the events are derived using APT metadata.


Constructor Summary
AptEventSet(AptControlInterface controlIntf, InterfaceDeclaration eventSet, TwoPhaseAnnotationProcessor ap)
          Constructs a new AptEventSet instance from APT metadata
 
Method Summary
 String getAddListenerMethod()
          Returns the name of the method used to register a new EventSet listener
 InterfaceDeclaration getDeclaration()
          Returns the underlying APT InterfaceDeclaration associated with this event set
 String getDescriptorName()
          Returns the programmatic descriptor name to be returned by the EventDescriptor for the event set.
 int getEventCount()
          Returns the number of Events for this EventSet and any super event set
 Collection<AptEvent> getEvents()
          Returns the list of Events associated with this EventSet
 EventSetInfo getEventSetInfo()
          Returns any EventSetInfo associated with the event set (or null if none)
 String getGetListenersMethod()
          Returns the name of the method used to retrieve the (unicast) EventSet listener
 String getInfoInitializer()
          Returns the name of a custom-generated method to initialize MethodDescriptor bean info for the events in this EventSet
 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 getNotifierExtendsShortName()
          Returns the short name for this notifier's base class.
 String getRemoveListenerMethod()
          Returns the name of the method used to register a new EventSet listener
 AptEventSet getSuperEventSet()
          Returns any EventSet from which this event set derives (or null if none)
protected  AptMethodSet<AptEvent> initEvents()
          Initializes the list of Events associated with this EventSet
 AptEventSet initSuperEventSet()
          Checks to see if this EventSet extends an EventSet declared on a parent control interface.
 boolean isExtendsNotifierBase()
          Return true if this notifier extends the UnicastEventNotifier or EventNotifier base class.
 boolean isUnicast()
          Returns 'true' if the event set support only unicast (single listener) events, false otherwise.
 
Methods inherited from class AptType
getClassName, getFormalClassName, getFormalShortName, getFormalTypeParameterNames, getFormalTypeParameters, getPackage, getShortName, getTypeDeclaration, isPrivateMethod, setDeclaration
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AptEventSet

public AptEventSet(AptControlInterface controlIntf,
                   InterfaceDeclaration eventSet,
                   TwoPhaseAnnotationProcessor ap)
Constructs a new AptEventSet instance from APT metadata

Parameters:
controlIntf - the declaring control interface
eventSet - the EventSet class
ap - the associated AnnotationProcessor
Method Detail

initSuperEventSet

public AptEventSet initSuperEventSet()
Checks to see if this EventSet extends an EventSet declared on a parent control interface. If found it will return the parent EventSet, or return null if not found.


getSuperEventSet

public AptEventSet getSuperEventSet()
Returns any EventSet from which this event set derives (or null if none)


initEvents

protected AptMethodSet<AptEvent> initEvents()
Initializes the list of Events associated with this EventSet


getEvents

public Collection<AptEvent> getEvents()
Returns the list of Events associated with this EventSet


isUnicast

public boolean isUnicast()
Returns 'true' if the event set support only unicast (single listener) events, false otherwise.


getEventCount

public int getEventCount()
Returns the number of Events for this EventSet and any super event set


getDescriptorName

public String getDescriptorName()
Returns the programmatic descriptor name to be returned by the EventDescriptor for the 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


getNotifierExtendsShortName

public String getNotifierExtendsShortName()
Returns the short name for this notifier's base class.


isExtendsNotifierBase

public boolean isExtendsNotifierBase()
Return true if this notifier extends the UnicastEventNotifier or EventNotifier base 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


getGetListenersMethod

public String getGetListenersMethod()
Returns the name of the method used to retrieve the (unicast) EventSet listener


getInfoInitializer

public String getInfoInitializer()
Returns the name of a custom-generated method to initialize MethodDescriptor bean info for the events in this EventSet


getEventSetInfo

public EventSetInfo getEventSetInfo()
Returns any EventSetInfo associated with the event set (or null if none)


getDeclaration

public InterfaceDeclaration getDeclaration()
Returns the underlying APT InterfaceDeclaration associated with this event set