| By Warren MacEvoy | Article Rating: |
|
| August 7, 2007 09:00 AM EDT | Reads: |
22,937 |
With the generic implementation, you can think about the actual messages and what they do, rather than the details of the mechanism for every new message type.
For those who are required to be compatible with a pre 1.5 JDK, it can be a lot of error-prone typing to write the boiler-plate code for every Event type you happen to need. In the resources, there is a tool for writing this code (built using the BeanShell Preprocessor, but you don't need BPP or BeanShell to use it).
What's Been Said...
So - generators are poorly or
incorrectly implemented all the time. Using these generators result in
solutions that are less stable, slower, and consume more memory. For
older (pre 1.5) JDKs, this can be solved by adopting the fast generator
pattern. These patterns can be built automatically using
meta.GenerateListeners. For new (post 1.5) JDKs, this can be solved
using generic classes. These tools are given in the resources.
That's it - happy listening in a dynamic world!
Resources
• Online version of this paper: www.mesastate.edu/%7Ewmacevoy/listen/paper.html
• JavaDOCs for meta package: www.mesastate.edu/%7Ewmacevoy/listen/meta/doc/index.html
• JavaDOCs for classes generated by meta package: www.mesastate.edu/%7Ewmacevoy/listen/usemeta/doc/index.html
• JavaDOCs for events package: www.mesastate.edu/%7Ewmacevoy/listen/generic/doc/index.html
• Source/binary/doc zip file: www.mesastate.edu/%7Ewmacevoy/listen.zip
• Writing Event Listeners: http://java.sun.com/docs/books/tutorial/uiswing/events/index.html
SIDEBAR
"almost always"
I stated that, almost always, if
(listening()) send(new Event()) will create and send an event only when
there are listeners to receive it. But notice that there is no
synchronization between the listening() and the send(new Event()), and
so the listeners list may change arbitrarily between the check for
listeners and the send. First, realize this is a very subtle timing
issue and so, almost always, the listening() call will correctly
determine if there is anyone listening. Second, realize this does not
effect the correctness of the generators, because only two things will
(very rarely) happen:
• listening() returns true, but the last listener is removed before the send(Event).
The Event is created and unused. This has no impact on correctness, and negligible effect on efficiency.
• listening() returns false, which skips a send(Event), because a listener is added just before the send would have occurred.
This same argument could be made in the send(Event) method since we
copy the reference to the listeners array before notifying listeners.
At some point (shortly before the sending) you have to decide if you
will or won't actually send. Since it is convenient to decide if you
will send before constructing the event, this has no impact on
correctness, but a significant positive impact on efficiency.
Published August 7, 2007 Reads 22,937
Copyright © 2007 SYS-CON Media, Inc. — All Rights Reserved.
Syndicated stories and blog feeds, all rights reserved by the author.
More Stories By Warren MacEvoy
Warren D. MacEvoy is Asst Professor of Comp Science in the department of Computer Science, Mathematics & Statistics at Mesa State College, Grand Junction, Colorado.
![]() |
Greg K 01/14/08 06:04:16 PM EST | |||
I have to agree with Daniel. Perhaps a decent approach on catching exceptions during the send() might be: protected final void send(Event event) { for (int i = tmp.length - 1; i >= 0; --i) { if (ueh != null) |
||||
![]() |
Daniel Blaukopf 09/06/07 10:55:44 AM EDT | |||
Hi Warren, Looking at it again, the behavior of your implementation matches the AWT's understanding of what it means to add or remove a Listener that overrides equals(). AWT classes use == comparison instead of the equals() method in this case. I had incorrectly assumed that the semantics of add(..) and remove(..) for listeners would be the same as for collections, in which equals(..) has to be used for correct comparison. So your implementation has the same interpretation of Listener equality as the JDK and I retract my objection. BTW, I'm not sure if I was clear, but my main point about exceptions is that a runtime exception in a listener should not kill the event delivery thread. Thanks, |
||||
![]() |
Warren MacEvoy 08/25/07 12:06:23 PM EDT | |||
Additional response to Daniel B. It was late and I was hasty writing my last response, and so apologize for the poor writing. I managed to skip your point 3 completely, so: 3. I am confused about your statement. The Generators only use the == operator on Listeners. This is because redefining equals() for some class that happened to implement Listener is probably more of coincidence than something the designer had planned to take advantage of. Am I missing something here? |
||||
![]() |
Warren MacEvoy 08/22/07 09:57:42 PM EDT | |||
Response to Daniel B. Thanks for liking the article! 1. Since addListener and removeListener is very rarely called) efficiency isn't really an issue here. Still, there is no reason to waste time, and so the version written are efficient. arraycopy would be equivalent (but arguably slower as you pointed out) in one case, but it is only appropriate for one of the loops (in addListener). The removeListner case is more subtle because it has to skip an element during the copy. 2. I agree about the exception propagation. I see no way to handle this from a general framework, so the specific listeners need to handle this. Thanks for this point. Response to Roberto L. ArrayList is great in general, but bad (less efficeint) in this case. Since we are trying to solve the problem for everyone we need to just have the efficient solution in this case. Think about the System.arraycopy mentioned by Daniel B.: you don't care that it is a nasty system specific implementation instead of a pretty for loop, but instead that it is correct, efficient, and easy to use. (Which incidentally is less efficient than the for loop for this very special case). The goal here is to provide a system tool analogous to arraycopy, but for Generators, so correctness, efficiency and usability. Not convinced? Look over the swing implementation for event generators --- it's pretty ugly stuff (and I think a version of the swing classes based on the proposed framework would be faster). So far as the generics, I have to agree that type erasure is a huge pain in the neck. If you automatically generate code using the meta classes, they generate javadocs which point out the pitfalls and how to work around them. As far as solving the problem without type erasure, you can use the pre 1.5 meta tools in a 1.5 setting. ...And figure out who to write to to *erase* type erasure from the JDK! (My version would be to make the "erased" type and a cheap interface type for each of the specific types brought to life through a generic instantiation. This is a much better trade off between code size and usability compared to C++'s template mechanism). This discussion belongs elsewhere --- I can only work in the context of the framework provided :oP |
||||
![]() |
Daniel Blaukopf 08/07/07 07:08:45 AM EDT | |||
I have a few comments on your otherwise excellent article: 1. System.arraycopy is often more clear than a copying loop. Of course, it would be slower than the loop with the presumably small array sizes you're dealing with. 2. Correct handling of exceptions is a crucial factor in a correct event generator. Listeners often contain code that is beyond the control of the author of the listening class. The code in the listeners can throw a RuntimeException. In your examples, this exception would be passed up to the caller of the event generator and other listeners would not receive the event. This is probably not the desired behavior. 3. In the unlikely event that your generator were to encounter a listener which overrode equals(), it would not work as expected. I would suggest i) Catching all exceptions in listeners and logging stack traces. In the absence of a log, they can go to the console. After an exception is caught, event delivery should continue. ii) in the add and remove methods, convert the array to an ArrayList, perform the add/remove, then convert the ArrayList back to an array. It's not efficient, but it doesn't have to be and you gain correctness and clarity. You are, of course, spot on in observing that an array is the best way to get both thread safety and minimum heap usage. |
||||
![]() |
Roberto Leibman 07/27/07 01:16:30 PM EDT | |||
OK, so I like your pattern for the generator a lot, although I think I'd rather use an ArrayList instead of the Array... array handling can be much more error prone. But that really is a minor consideration. The bigger problem, is in the generics. And it's not a gripe with your article but with erasure in general. The last time I coded something like this I had issues because the hierarchy I chose was such that a class could not implement two Listeners where the only difference was the parametrized type. I'm not sure I can think of an easy answer though. Thanks again for the article. |
||||
- Kindle 2 vs Nook
- Cloud Computing on Gartner's Top 10 List and SYS-CON Events' 2010 Calendar
- Confessions of a Ulitzer Addict
- IBM Hardware Chief, Intel VC Exec Arrested in Insider Trading Scam
- Tactical Cloud Computing Panel at 1st Annual GovIT Expo
- Ulitzer.com Named Exclusive "New Media" Sponsor of Cloud Computing Conference & Expo
- Moving Your RIA Apps into the Cloud: Seven Challenges
- Adobe’s Aiming ColdFusion at Multiple Clouds
- Windows 7 – Microsoft’s First Step to the Cloud
- Ulitzer Provides a Powerful Social Journalism Platform
- Jill Tummler Singer, Deputy CIO of CIA, Keynotes at GovIT Expo
- Open Source Mobile Cloud Sync and Push Email
- Kindle 2 vs Nook
- The Difference Between Web Hosting and Cloud Computing
- Cloud Computing on Gartner's Top 10 List and SYS-CON Events' 2010 Calendar
- Ajax in RichFaces 3.3, JSF 2 and RichFaces 4
- Confessions of a Ulitzer Addict
- IBM Hardware Chief, Intel VC Exec Arrested in Insider Trading Scam
- My Thoughts on Ulitzer
- Tactical Cloud Computing Panel at 1st Annual GovIT Expo
- Ulitzer.com Named Exclusive "New Media" Sponsor of Cloud Computing Conference & Expo
- US Post Office Hops a Ride on NetSuite’s Cloud
- Moving Your RIA Apps into the Cloud: Seven Challenges
- Adobe’s Aiming ColdFusion at Multiple Clouds
- Building a Drag-and-Drop Shopping Cart with AJAX
- What Is AJAX?
- Google Maps! AJAX-Style Web Development Using ASP.NET
- Flashback to January 2006: Exclusive SYS-CON.TV Interviews on "OpenAjax Alliance" Announcement
- AJAXWorld Conference & Expo to Take Place October 2-4, 2006, at the Santa Clara Convention Center, California
- AJAX Sponsor Webcasts Are Now Available at AJAXWorld Website
- How and Why AJAX, Not Java, Became the Favored Technology for Rich Internet Applications
- "Real-World AJAX" One-Day Seminar Arrives in Silicon Valley
- AJAXWorld University Announces AJAX Developer Bootcamp
- AJAX Support In JadeLiquid WebRenderer v3.1
- Where Are RIA Technologies Headed in 2008?
- Struts Validations Framework Using AJAX





































