This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 156540

Summary:	Expose public API
Product:	xml	Reporter:	Samaresh Panda <samaresh>
Component:	Code	Assignee:	Samaresh Panda <samaresh>
Status:	RESOLVED WONTFIX
Severity:	blocker	CC:	apireviews
Priority:	P1	Keywords:	API_REVIEW_FAST
Version:	6.x
Hardware:	All
OS:	All
Issue Type:	TASK	Exception Reporter:
Bug Depends on:
Bug Blocks:	147669

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.

Comment 8 Jaroslav Tulach 2014-11-05 09:23:03 UTC

Long time open. No progress.