Bug 156540 - Expose public API
Expose public API
Status: NEW
Product: xml
Classification: Unclassified
Component: Code
6.x
All All
: P1 (vote)
: 6.x
Assigned To: Samaresh Panda
issues@xml
: API_REVIEW_FAST
Depends on:
Blocks: 147669
  Show dependency treegraph
 
Reported: 2009-01-09 19:23 UTC by Samaresh Panda
Modified: 2009-02-19 23:31 UTC (History)
1 user (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 Samaresh Panda 2009-01-09 19:23:32 UTC
This module has been found very useful. There is a lot of modules declared as a friend and has been quite stable. The
packages that are exposed to friends can be made public. Please review.

Earlier, I requested review of this module. See issue 98420. Please let me know if anything is missing.
Comment 1 Jesse Glick 2009-01-13 02:12:31 UTC
[JG01] What package would be used? org.netbeans.modules.xml.axi.** is not appropriate for public packages.


It doesn't seem like there was any substantive review in issue #98420. (I am not personally qualified to review it.)
Have enough distinct people used this module since it was stabilized to have confidence that the API is correct?
Comment 2 Samaresh Panda 2009-01-15 01:33:55 UTC
Yes, the package name starts with "org.netbeans.modules.xml.axi". axi is an acronym for Abstract XML Instance. Do you
have any other suggestions?

More specifically the request is to make these three packages public:
org.netbeans.modules.xml.axi
org.netbeans.modules.xml.axi.datatype
org.netbeans.modules.xml.axi.visitor

These APIs are being used by a lot of modules and have been around since 2006. I have found this very stable and has a
lot of unit tests. Please see http://xml.netbeans.org/specs/axiom/axiom.html for some use-cases.
Comment 3 Jesse Glick 2009-01-15 17:16:58 UTC
JG01 - see: http://openide.netbeans.org/tutorial/api.html#restrictions
Comment 4 Samaresh Panda 2009-01-15 18:18:44 UTC
Does it mean that I have to change the package names?
Comment 5 Jesse Glick 2009-01-15 18:23:07 UTC
That would be the usual recommendation. I don't personally have a strong opinion about it.
Comment 6 Petr Hejl 2009-01-15 19:50:10 UTC
PH01: I would like to see javadoc improved. Two use cases are described as simple sentences without any link to class or
sample. There is no list of exported API. So the user of API might get feeling that this API could solve his usecase,
but he has no clue how to use it or where to start. From my point of view it would be really hard to use the API without
copy-pasting some working code.
Comment 7 Samaresh Panda 2009-01-16 14:45:25 UTC
Re: PH01: I agree with your comments. I'll have all the docs in place soon.


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