[jboss-dev-forums] [Design of OSGi Integration] - Javadocs and OO design

[alesj]

John, I don't want to bother you, but I will. ;-)
Code needs javadocs, even as trivial as a simple getter.
I might have missed some of it in the osgi-int code, but the rest of MC is well javadocumentized. :-)
Simple things require very simple javadocs, something more abstract should get some more effort.

You can create as much as util classes as you like, in order to make things proper OO.
I don't mind if you have many helpers, as long as they make sense. And have proper package location.
But the N of ifs/else ifs is not good OO design. :-)
For example BundleHeaders could be split into many small util classes, that just take metadata and do a single method check, if that's not-null, put it into previously provided map.
I know it's 20 classes for a single task, but they can all be private classes inside the same BundleHeaders class, and it's a lot easier to not make a mistake while maintaining it.
The same (as I already posted) applies with BundleImpl.

View the original post : http://www.jboss.com/index.html?module=bb&op=viewtopic&p=4131878#4131878

Reply to the post : http://www.jboss.com/index.html?module=bb&op=posting&mode=reply&p=4131878