Bug 33268 - Dynamic Annotations Framework
Dynamic Annotations Framework
Status: RESOLVED WONTFIX
Product: contrib
Classification: Unclassified
Component: Code
5.x
All All
: P4 with 1 vote (vote)
: 6.x
Assigned To: Jaroslav Tulach
issues@contrib
: API
Depends on:
Blocks: 29192 29239 32101
  Show dependency treegraph
 
Reported: 2003-04-27 18:56 UTC by Jaroslav Tulach
Modified: 2010-04-12 16:16 UTC (History)
4 users (show)

See Also:
Issue Type: TASK
:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Jaroslav Tulach 2003-04-27 18:56:35 UTC
The goal of this task is to separate the API and
SPI in looks. There currently is some kind of
separation, but it still requires clients to deal
with Look class - call into it, and we want module
to subclass Look as well. We have long history of
problems like this and it would be better to
separate the API from SPI.

Another (side) goal is to make looks a bit
generic. To act as lookup provider for any kind of
object.
Comment 1 Jaroslav Tulach 2003-04-27 19:05:16 UTC
Created branch for openidex/looks named aspect_33268 rooted at
aspect_33268_base.
Comment 2 Jaroslav Tulach 2003-04-27 21:00:06 UTC
Initial part of the rewrite is availabe under the tag 

aspect_33268_phase1

it contains rewrite of the LookNode that is not calling directly to
Look, but is using a wrapper called LookLookup (implementation of
Lookup) to query various values. For a communication between the node
and the lookup a set of interfaces Aspect.Hierarchy, Aspect.Image,
Aspect.Identity, Aspect.Description has been introduced. The
LookLookup implements them and delegates to methods in Look.

So we have reached the separation of API and SPI. Look is pure SPI and
the API is a set of interfaces that can be obtained from the thru a
Lookup available for any Object.
Comment 3 Jaroslav Tulach 2003-04-27 21:07:06 UTC
Hrebejk, I have a better implementation of Lookup based on
getLookupItems than is in your branch. Consider merging
LookLookup.java ideas rev. 

Merging differences between 1.1.2.2 and 1.1.2.3 into LookLookup.java
Comment 4 Jaroslav Tulach 2003-04-27 21:19:10 UTC
Listening on changes implement and tagged as

aspect_33268_phase2

now the LookNode listen to changes generated by the LookLookup and
correctly refires the changes to the best possible extent. That means
not all test passes, but they which do not - cannot - they are
restricted by the new design that joins together for example icon
change and openedIcon change. Then it is impossible to distinguish
such events, but that does not seem to be big problem as the reaction
to those events is the same in both cases anyway... 
Comment 5 Jaroslav Tulach 2003-04-27 23:35:16 UTC
The pre-final stage has been hit. Marked by a tag

aspect_33268_phase3

it comes with greater API changes. LookDescritor has been renamed to
Aspect and it provides the basics for defining Lookup for an Object.
So it contains the getLookupItems () method. In future one could
provide just Aspect to provide information about the object. Look is
just convinient SPI that simplifies writing of common aspects like
Aspect.Description - instead of writing an interface, we can just
overwrite a method.
Comment 6 Jaroslav Tulach 2003-04-28 00:28:26 UTC
Event API simplification phase finished. Tagged as

aspect_33268_phase4

it brings major improvements to the complexity of API (LookListener
and LookEvent deleted) while preserving the functionality and SPI
(methods Look.fire* still implemented in the same way). The only thing
missing now is a pluggable API<->SPI mapper, but that is an open
solution for future.

The last step (before merge - if the merge is ever going to happen) is
to move all Look* classes from API to SPI packages. Now they are pure SPI.
Comment 7 Jesse Glick 2003-04-28 14:30:50 UTC
I do not think addAspectListener, removeAspectListener, and
fireLookupItemsChange should be final in Aspect. That prevents anyone
from ever implementing them more efficiently. Better, they should be
abstract in Aspect (i.e. make it essentially an interface), and
defined as final only in Look (or in some intermediate SPI class, e.g.
AbstractAspect).
Comment 8 Jesse Glick 2003-04-28 14:42:31 UTC
I don't understand the purpose of Aspect.getLookup - it will not work
unless the arg is instanceof Look. Probably it should use one impl if
instanceof Look and another impl otherwise. Also LookLookup should
probably be using Proxy to handle interfaces not represented in
Aspect.*, right? Or is this already handled some other way?

I don't think all these Aspect.* interfaces should be nested classes.
They are public and quite visible in the API. Better IMHO to make them
top-level, e.g. DataTransferAspect.
Comment 9 Jesse Glick 2003-04-28 15:57:02 UTC
"I don't understand the purpose of Aspect.getLookup - it will not work
unless the arg is instanceof Look." - I now see that non-Look
subclasses of Aspect cannot be constructed at all! This is a temporary
hack I hope?
Comment 10 Jaroslav Tulach 2003-04-28 15:59:47 UTC
Right now the Look is the only allowed subclass, I'll work on it in
future.
Comment 11 Jesse Glick 2003-04-28 16:27:45 UTC
OK.

Maybe AspectProvider should be an interface; don't see any particular
reason for it to be a class.

I see that aspects are now named e.g. "Help". Might be better to name
them e.g. "HelpAspect" - much clearer what is going on when you are
importing a lot of packages. Compare e.g. "OpenCookie".
Comment 12 Jesse Glick 2003-04-28 16:36:14 UTC
There are some problems with excluding org.netbeans.api.aspects from
the public packages.

1. Look now extends an inaccessible class. This may cause linkage
errors for SPI users. Also, addAspectListener takes an inaccessible
parameter, so you cannot use it to listen to looks from outside the
module.

2. fireLookupItemsChange now requires a Class parameter that you
cannot create as an SPI extender. Could be worked around by making
that private and re-adding e.g. fireDisplayNameChanged, etc.

BTW the event method name should probably be "lookupItemsChanged" not
"lookupItemsChange" for consistency with ChangeListener and
LookupListener and many other listener interfaces (tho not
PropertyChangeListener, alas).
Comment 13 Petr Hrebejk 2003-05-06 09:59:19 UTC
In openide/looks the looks are an SPI. The aspect API is not used.
Comment 14 Jaroslav Tulach 2003-05-06 16:45:33 UTC
Let's leave this issue to track the work on the branch.
Comment 15 Jaroslav Tulach 2006-04-23 19:21:59 UTC
Most of the work is in modules under contrib/aspects:
http://www.netbeans.org/source/browse/contrib/aspects/
Comment 16 Jaroslav Tulach 2010-04-12 16:16:45 UTC
No time to work on that right now.


By use of this website, you agree to the NetBeans Policies and Terms of Use. © 2012, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo