Programming Guides › Connector Programming Guide › Connector Review Checklist › Java Development Standards Considerations

Java Development Standards Considerations

Consider the following when determining how well your connector implementation has adhered to Java development standards:

1. Have basic Java standards been adhered to?
2. Have constants been used rather than magic numbers and magic strings?
3. Does the Javadoc meet the following quality and coverage requirements?
   • Have class header comments (especially on the core classes) explaining requirements and gotchas been included?
   • Have method comments, especially important for methods that are confusing, been included?

     Note: Some leeway in documenting only one of get or set method for a property is acceptable.

   • Are package.html files on subpackages provided where required?
4. Have the following logging standards been met?
   • Are appropriate levels used?
   • Has careful attention been paid to logging error messages?
   • Have lower-level severity messages been wrapped in "if (log.isDebugEnabled()) checks for runtime efficiency?
   • When logging exceptions, has (log.debug(msg, ex) been used rather than log.debug(msg + ex))?
5. Are JDK 1.5 generics used where applicable and allowed by your chosen API?
6. Are repeatedly referenced complex expressions remembered in stack variables rather than repeated multiple times (use of basic refactoring in IDE)?
7. Has attention been paid to threading issues (for example, synchronization of activate and deactivate calls, and such)?
8. Has some testing been performed where multiple threads access the connector concurrently?
9. Has dead, commented out code been cleaned up?