crunch-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Sean Owen (JIRA)" <>
Subject [jira] [Commented] (CRUNCH-276) Apply static analysis fixes, improvements
Date Mon, 07 Oct 2013 15:46:45 GMT


Sean Owen commented on CRUNCH-276:

No problem, I will not change classes to final. 

Right now I'm using IntelliJ's inspections, which are quite good. FindBugs has some value.
I know how to set up FindBugs as a report at least, so that it can generate something like
these results on demand but not go so far as to fail the build. If that's of interest I can
put that in the mix too.

> Apply static analysis fixes, improvements
> -----------------------------------------
>                 Key: CRUNCH-276
>                 URL:
>             Project: Crunch
>          Issue Type: Task
>    Affects Versions: 0.7.0
>            Reporter: Sean Owen
>            Priority: Minor
> Browsing through the Crunch code with a static analyzer, I see a number of minor issues
that can be cleaned up, even automatically, by the same tools. 
> Most are likely completely non-controversial since they do not affect the functionality
of the code:
> - Remove unused imports
> - Fix bad javadoc
> - Typos
> - Unnecessary casts
> - Redundant modifiers on interface methods
> - Access modifiers that have no effect (public constructor in private class)
> - Missing @Override, @ Deprecated
> - Bad literals like 0d
> Others are also likely uncontroversial although might be termed a matter of style, although
the changes would be towards standard Sun style; for example:
> - Braces around all blocks
> - No unnecessarily final on locals
> - Unnecessarily inverted conditions
> Some are signature changes, although only for entirely private elements:
> - Making methods static
> - Type weakening
> - Remove use of old classes like Hashtable
> - Declare collections by interface
> - Raw use of generic types
> And finally, there are a few which could conceivably break a caller, but only if doing
something unintended. I want to avoid these unless the likelihood of an issue is very remote:
> - Making utility classes final and non-instantiable -- should not be subclassed or instantiated
> Before I get way into this -- it will likely touch 200+ files -- thoughts? I believe
Josh was broadly supportive but here are the specifics.

This message was sent by Atlassian JIRA

View raw message