Uploaded image for project: 'Log Tool'
  1. Log Tool
  2. LOGTOOL-81

Log Tool generates class names that violate FindBugs standard rules

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Obsolete
    • Icon: Major Major
    • None
    • None
    • None

      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 (i.e. "$Logger" and "$Bundle" .

            jperkins-rhn James Perkins
            tcunning@redhat.com Thomas Cunningham
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: