org.bushe.swing.event.annotation.AnnotationProcessor Maven / Gradle / Ivy

Go to download
package org.bushe.swing.event.annotation;

import java.lang.reflect.Method;
import java.lang.reflect.AccessibleObject;
import java.util.regex.Pattern;

import org.bushe.swing.event.EventService;
import org.bushe.swing.event.EventServiceExistsException;
import org.bushe.swing.event.EventServiceLocator;

/**
 * Enhances classes that use EventService Annotations.
 * 
 * This class makes the EventService annotations "come alive."  This can be used in code like so:
 * 
 * 
 * public class MyAppController {
 *   public MyAppController {
 *       AnnotationProcessor.process(this);//this line can be avoided with a compile-time tool or an Aspect
 *   }
 *   @EventSubscriber
 *   public void onAppStartingEvent(AppStartingEvent appStartingEvent) {
 *      //do something
 *   }
 *   @EventSubscriber
 *   public void onAppClosingEvent(AppClosingEvent appClosingEvent) {
 *      //do something
 *   }
 * }
 * 
 * 
 * 
 * This class can be leveraged in outside of source code in other ways in which Annoations are used: 
 In an
 * Aspect-Oriented tool 
In a Swing Framework classloader that wants to load and understand events. 
In other
 * Inversion of Control containers, such as Spring or PicoContainer. 
In the apt tool, though this does not generate
 * code. 
In a Annotation Processing Tool plugin, when it becomes available.  Support for these other methods
 * are not yet implemented.
 */
public class AnnotationProcessor {
   public static void process(Object obj) {
      if (obj == null) {
         return;
      }
      Class cl = obj.getClass();
      Method[] methods = cl.getMethods();
      for (int i = 0; i < methods.length; i++) {
         Method method = methods[i];
         EventSubscriber classAnnotation = method.getAnnotation(EventSubscriber.class);
         if (classAnnotation != null) {
            process(classAnnotation, obj, method);
         }
         EventTopicSubscriber topicAnnotation = method.getAnnotation(EventTopicSubscriber.class);
         if (topicAnnotation != null) {
            process(topicAnnotation, obj, method);
         }
         EventTopicPatternSubscriber topicPatternAnnotation = method.getAnnotation(EventTopicPatternSubscriber.class);
         if (topicPatternAnnotation != null) {
            process(topicPatternAnnotation, obj, method);
         }
//         Publisher publisherAnnotation = (Publisher) method.getAnnotation(Publisher.class);
//         if (publisherAnnotation != null) {
//            process(publisherAnnotation, obj);
//         }
      }
   }

//   private static void process(Publisher publisherAnnotation, Object obj) {
//      Class cl = obj.getClass();
//      if (JComboBox.class.equals(cl)) {
//         JComboBox combo = (JComboBox)obj;
//         combo.addActionListener(new ActionListener() {
//            public void actionPerformed(ActionEvent e) {
//               EventBus.publish(e);
//            }
//         });
//      }
   //JCheckBoxMeuItem
   //addMenuDragMouseListener, addMenuKeyListener
   //JButton, JCheckBox
   //addActionListener, addChangeListener, addItemListener,
   //JComponent
   //addAncestorListener, addVetoableChangeListener
   //Container
   //addContainerListener, addPropertyChangeListener, addPropertyChangeListener,
   //Component
   //addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener,
   //addInputMethodListener, addKeyListener,
   //addMouseListener, addMouseMotionListener,
   //addMouseWheelListener

   // HierarchyBounds + Hierarchy both use Hierarchy event
   // addMouseListener, addMouseMotionListener both use MouseEvent
   // addPropertyChangeListener, addVetoableChangeListener addChangeListener all use PropertyChangeEvent

   //JEditorPane
   //addHyperlinkListener
//   }

   private static void process(EventTopicPatternSubscriber topicPatternAnnotation, Object obj, Method method) {
      //Check args
      String topicPattern = topicPatternAnnotation.topicPattern();
      if (topicPattern == null) {
         throw new IllegalArgumentException("Topic pattern cannot be null for EventTopicPatternSubscriber annotation");
      }

      //Get event service
      Class eventServiceClass = topicPatternAnnotation.autoCreateEventServiceClass();
      String eventServiceName = topicPatternAnnotation.eventServiceName();
      EventService eventService = getEventServiceFromAnnotation(eventServiceName, eventServiceClass);
      int priority = topicPatternAnnotation.priority();

      //Create proxy and subscribe
      Pattern pattern = Pattern.compile(topicPattern);
      ProxyTopicPatternSubscriber subscriber = new ProxyTopicPatternSubscriber(obj, method, topicPatternAnnotation.referenceStrength(),
              priority, eventService, topicPattern, pattern);

      //See Issue #18
      //Also note that this post is wrong: https://eventbus.dev.java.net/servlets/ProjectForumMessageView?messageID=19499&forumID=1834
      //Since two WeakReferences are not treated as one.  So this always has to be strong and we'll have to clean up occasionally.
      eventService.subscribeStrongly(pattern, subscriber);
   }

   private static void process(EventTopicSubscriber topicAnnotation, Object obj, Method method) {
      //Check args
      String topic = topicAnnotation.topic();
      if (topic == null) {
         throw new IllegalArgumentException("Topic cannot be null for EventTopicSubscriber annotation");
      }

      //Get event service
      Class eventServiceClass = topicAnnotation.autoCreateEventServiceClass();
      String eventServiceName = topicAnnotation.eventServiceName();
      EventService eventService = getEventServiceFromAnnotation(eventServiceName, eventServiceClass);

      int priority = topicAnnotation.priority();

      //Create proxy and subscribe
      ProxyTopicSubscriber subscriber = new ProxyTopicSubscriber(obj, method, topicAnnotation.referenceStrength(), priority, eventService, topic);

      //See Issue #18
      //Also note that this post is wrong: https://eventbus.dev.java.net/servlets/ProjectForumMessageView?messageID=19499&forumID=1834
      //Since two WeakReferences are not treated as one.  So this always has to be strong and we'll have to clean up occasionally.
      eventService.subscribeStrongly(topic, subscriber);
   }

   private static void process(EventSubscriber annotation, Object obj, Method method) {
      //Check args
      Class eventClass = annotation.eventClass();
      if (eventClass == null) {
         throw new IllegalArgumentException("Event class cannot be null for EventSubscriber annotation");
      } else if (UseTheClassOfTheAnnotatedMethodsParameter.class.equals(eventClass)) {
         Class[] params = method.getParameterTypes();
         if (params.length < 1) {
            throw new RuntimeException("Expected annotated method to have one parameter.");
         } else {
            eventClass = params[0];
         }
      }

      //Get event service
      Class eventServiceClass = annotation.autoCreateEventServiceClass();
      String eventServiceName = annotation.eventServiceName();
      EventService eventService = getEventServiceFromAnnotation(eventServiceName, eventServiceClass);

      int priority = annotation.priority();

      //Create proxy and subscribe
      //See https://eventbus.dev.java.net/servlets/ProjectForumMessageView?messageID=19499&forumID=1834
      BaseProxySubscriber subscriber = new BaseProxySubscriber(obj, method, annotation.referenceStrength(), 
              priority, eventService, eventClass);
      if (annotation.exact()) {
         //See Issue #18
         //Also note that this post is wrong: https://eventbus.dev.java.net/servlets/ProjectForumMessageView?messageID=19499&forumID=1834
         //Since two WeakReferences are not treated as one.  So this always has to be strong and we'll have to clean up occasionally.
         eventService.subscribeExactlyStrongly(eventClass, subscriber);
      } else {
         //See Issue #18
         //Also note that this post is wrong: https://eventbus.dev.java.net/servlets/ProjectForumMessageView?messageID=19499&forumID=1834
         //Since two WeakReferences are not treated as one.  So this always has to be strong and we'll have to clean up occasionally.
         eventService.subscribeStrongly(eventClass, subscriber);
      }
   }

   private static EventService getEventServiceFromAnnotation(String eventServiceName,
           Class eventServiceClass) {
      EventService eventService = EventServiceLocator.getEventService(eventServiceName);
      if (eventService == null) {
         if (EventServiceLocator.SERVICE_NAME_EVENT_BUS.equals(eventServiceName)) {
            //This may be the first time the EventBus is accessed.
            eventService = EventServiceLocator.getSwingEventService();
         } else {
            //The event service does not yet exist, create it
            try {
               eventService = eventServiceClass.newInstance();
            } catch (InstantiationException e) {
               throw new RuntimeException("Could not instance of create EventService class " + eventServiceClass, e);
            } catch (IllegalAccessException e) {
               throw new RuntimeException("Could not instance of create EventService class " + eventServiceClass, e);
            }
            try {
               EventServiceLocator.setEventService(eventServiceName, eventService);
            } catch (EventServiceExistsException e) {
               //ignore it, it's OK
               eventService = EventServiceLocator.getEventService(eventServiceName);
            }
         }
      }
      return eventService;
   }
}