RE: [Xml1-wire-devel] New Code added to repository
Status: Planning
Brought to you by:
vinculum
|
From: Byron K. A. <b.k...@ie...> - 2000-12-20 00:32:46
|
I have made changes to adhere to Sun's naming convention. I actually looked it up for the first time, and, in addition to the capitalization conventions, methods are supposed to start with verbs. Therefore, I have made various changes such as, Clusters(Reader in) is now getClusters(Reader in). If I have missed any violation of the convention, please point them out. I haven't changed TAGerrorhandler because it will be absorbed by TAGHandler. Byron > -----Original Message----- > From: Sean Kelly [mailto:ke...@ad...] > Sent: Monday, December 18, 2000 8:37 PM > To: Byron K. Appelt; 1-wire TAG list > Subject: Re: [Xml1-wire-devel] New Code added to repository > > > > I have just committed changes to the repository implementing these sorts > of > > methods. I will soon be creating some JavaDocs. Comments, as always are > > desired. > > Looking good. Thanks for committing this. > > A couple high-level comments ... the > TAGerrorhandler class isn't pulling its weight, in my > opinion. I'd go ahead and just make the TAGparser itself > implement the error handler interface and subsume its > methods. > > Moreover, I don't mind having the warning() method just > log the error, but both the error() and fatalError() > methods ought to throw back the SAXParseException they're > given. If there's an error, the user needs to know about > it and stop processing or handle the error in his/her own > way. > > Also, all error messages, in the TAGerrorhandler, > TAGhandler, and TAGparser, should go to System.err, not > System.out. > > Finally, I'd recommend we use the Sun naming convention > standards. As you know, Java's overly happy with using > the "." operator. For example, in > > a.b.c.d.e.f(); > > about the only thing you can say safely is that "f is a > method." But is it package "a.b.c" class d, field e, > method f? Or is it package "a", class b, inner class c, > field d, static inner class e, method f? Or something > else? > > The Sun naming convention helps disambiguate that: > packages are all lower case, ClassNames are like that, > methods areLikeThis, and constants are ALL_UPPER_CASE. > This would affect the DevicesByName, LevelSensors, etc., > methods. > > Thoughts? > > Thanks again. > --Sean > > |