[jboss-jira] [JBoss JIRA] (LOGTOOL-81) Log Tool generates class names that violate FindBugs standard rules

[Tom Cunningham (JIRA)]

Tom Cunningham created LOGTOOL-81:
-------------------------------------

             Summary: Log Tool generates class names that violate FindBugs standard rules
                 Key: LOGTOOL-81
                 URL: https://issues.jboss.org/browse/LOGTOOL-81
             Project: Log Tool
          Issue Type: Bug
      Security Level: Public (Everyone can see)
         Environment: OS X Mavericks, Java 1.7
            Reporter: Tom Cunningham
            Assignee: James Perkins


Log Tool generates class names like : 

./api/target/generated-sources/annotations/org/switchyard/APILogger_$logger.java

./validate/target/generated-sources/annotations/org/switchyard/validate/ValidateMessages_$bundle.java

When I run findbugs, my project isn't clean anymore because of these generated classes - findbugs complains that these classes do not start with a capital letter.     It looks like this violates the NM_CLASS_NAMING_CONVENTION rule.    

>From Findbugs website : 

Class names should be nouns, in mixed case with the first letter of each internal word capitalized. Try to keep your class names simple and descriptive. Use whole words-avoid acronyms and abbreviations (unless the abbreviation is much more widely used than the long form, such as URL or HTML).

http://findbugs.sourceforge.net/bugDescriptions.html

I can probably work around this by providing FindBugs exceptions for "_$logger" and "_$bundle", but it might be good practice if the first letter were upper cased in the generated class.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira