Any ideas how to avoid this code checker error?
in [Java Programming]
|
From: Lew on 27 Jan 2010 20:44 Lew wrote: >> Side notes: >> - 'LOG' does not follow the Java coding conventions: >> <http://java.sun.com/docs/codeconv/index.html> Daniel Pitts wrote: > I'm curios about this.. > > private static final Logger LOG = ...; > > It is private, static, and final: Which convention would you use? Why, the one referenced in my post, natch. Surely you saw the reference; you repeated it. > The names of variables declared class constants and of ANSI > constants should be all uppercase with words separated by underscores ("_") otherwise they're in camel case with a lower-case first letter. There's an apparent typo in the conventions spec, which confuses matters. > Except for variables, all instance, class, and class constants > are in mixed case with a lowercase first letter. When clearly the intent is to say: Except for class constants, all instance and class variables are in mixed case with a lowercase first letter. -- Lew
From: Daniel Pitts on 27 Jan 2010 21:48 On 1/27/2010 5:44 PM, Lew wrote: > Lew wrote: >>> Side notes: >>> - 'LOG' does not follow the Java coding conventions: >>> <http://java.sun.com/docs/codeconv/index.html> > > Daniel Pitts wrote: >> I'm curios about this.. >> >> private static final Logger LOG = ...; >> >> It is private, static, and final: Which convention would you use? > > Why, the one referenced in my post, natch. Surely you saw the reference; > you repeated it. >> The names of variables declared class constants and of ANSI constants >> should be all uppercase with words separated by underscores ("_") > > otherwise they're in camel case with a lower-case first letter. > > There's an apparent typo in the conventions spec, which confuses matters. >> Except for variables, all instance, class, and class constants are in >> mixed case with a lowercase first letter. > > When clearly the intent is to say: > Except for class constants, all instance and class variables are in > mixed case with a lowercase first letter. > And what defines a class constant? If you go by "static+final", then LOG would be correct, and "log" would be incorrect. -- Daniel Pitts' Tech Blog: <http://virtualinfinity.net/wordpress/>
From: Lew on 28 Jan 2010 04:02 Daniel Pitts wrote: > On 1/27/2010 5:44 PM, Lew wrote: >> Lew wrote: >>>> Side notes: >>>> - 'LOG' does not follow the Java coding conventions: >>>> <http://java.sun.com/docs/codeconv/index.html> >> >> Daniel Pitts wrote: >>> I'm curios about this.. >>> >>> private static final Logger LOG = ...; >>> >>> It is private, static, and final: Which convention would you use? >> >> Why, the one referenced in my post, natch. Surely you saw the reference; >> you repeated it. >>> The names of variables declared class constants and of ANSI constants >>> should be all uppercase with words separated by underscores ("_") >> >> otherwise they're in camel case with a lower-case first letter. >> >> There's an apparent typo in the conventions spec, which confuses matters. >>> Except for variables, all instance, class, and class constants are in >>> mixed case with a lowercase first letter. >> >> When clearly the intent is to say: >> Except for class constants, all instance and class variables are in >> mixed case with a lowercase first letter. >> > And what defines a class constant? If you go by "static+final", then LOG > would be correct, and "log" would be incorrect. The JLS, of course. From the same people who brought us the code conventions document. However, I see that the section of the JLS on naming conventions contradicts the conventions document. So I was wrong. I was going by <http://java.sun.com/docs/books/jls/third_edition/html/expressions.html#15.28> but brought up short by <http://java.sun.com/docs/books/jls/third_edition/html/names.html#6.8.6> -- Lew
From: laredotornado on 28 Jan 2010 09:56 On Jan 28, 2:02 am, Lew <no...(a)lewscanon.com> wrote: > Daniel Pitts wrote: > > On 1/27/2010 5:44 PM, Lew wrote: > >> Lew wrote: > >>>> Side notes: > >>>> - 'LOG' does not follow the Java coding conventions: > >>>> <http://java.sun.com/docs/codeconv/index.html> > > >> Daniel Pitts wrote: > >>> I'm curios about this.. > > >>> private static final Logger LOG = ...; > > >>> It is private, static, and final: Which convention would you use? > > >> Why, the one referenced in my post, natch. Surely you saw the reference; > >> you repeated it. > >>> The names of variables declared class constants and of ANSI constants > >>> should be all uppercase with words separated by underscores ("_") > > >> otherwise they're in camel case with a lower-case first letter. > > >> There's an apparent typo in the conventions spec, which confuses matters. > >>> Except for variables, all instance, class, and class constants are in > >>> mixed case with a lowercase first letter. > > >> When clearly the intent is to say: > >> Except for class constants, all instance and class variables are in > >> mixed case with a lowercase first letter. > > > And what defines a class constant? If you go by "static+final", then LOG > > would be correct, and "log" would be incorrect. > > The JLS, of course. From the same people who brought us the code conventions > document. However, I see that the section of the JLS on naming conventions > contradicts the conventions document. So I was wrong. > > I was going by > <http://java.sun.com/docs/books/jls/third_edition/html/expressions.htm...> > but brought up short by > <http://java.sun.com/docs/books/jls/third_edition/html/names.html#6.8.6> > > -- > Lew Hi, Per the first suggestions, I used the constructor where I wrapped the original exception and the code-checker stopped complaining. I'm catching "Exception" because certain things like "NullPointerExceptions" aren't prompted for by the compiler, and I wish to log any type of exception before this call goes back to the client calling my EJB. Thakns for the help, - Dave
From: Daniel Pitts on 28 Jan 2010 10:59
On 1/28/2010 6:56 AM, laredotornado wrote: > On Jan 28, 2:02 am, Lew<no...(a)lewscanon.com> wrote: >> Daniel Pitts wrote: >>> On 1/27/2010 5:44 PM, Lew wrote: >>>> Lew wrote: >>>>>> Side notes: >>>>>> - 'LOG' does not follow the Java coding conventions: >>>>>> <http://java.sun.com/docs/codeconv/index.html> >> >>>> Daniel Pitts wrote: >>>>> I'm curios about this.. >> >>>>> private static final Logger LOG = ...; >> >>>>> It is private, static, and final: Which convention would you use? >> >>>> Why, the one referenced in my post, natch. Surely you saw the reference; >>>> you repeated it. >>>>> The names of variables declared class constants and of ANSI constants >>>>> should be all uppercase with words separated by underscores ("_") >> >>>> otherwise they're in camel case with a lower-case first letter. >> >>>> There's an apparent typo in the conventions spec, which confuses matters. >>>>> Except for variables, all instance, class, and class constants are in >>>>> mixed case with a lowercase first letter. >> >>>> When clearly the intent is to say: >>>> Except for class constants, all instance and class variables are in >>>> mixed case with a lowercase first letter. >> >>> And what defines a class constant? If you go by "static+final", then LOG >>> would be correct, and "log" would be incorrect. >> >> The JLS, of course. From the same people who brought us the code conventions >> document. However, I see that the section of the JLS on naming conventions >> contradicts the conventions document. So I was wrong. >> >> I was going by >> <http://java.sun.com/docs/books/jls/third_edition/html/expressions.htm...> >> but brought up short by >> <http://java.sun.com/docs/books/jls/third_edition/html/names.html#6.8.6> >> >> -- >> Lew > > Hi, > > Per the first suggestions, I used the constructor where I wrapped the > original exception and the code-checker stopped complaining. > > I'm catching "Exception" because certain things like > "NullPointerExceptions" aren't prompted for by the compiler, and I > wish to log any type of exception before this call goes back to the > client calling my EJB. > > Thakns for the help, - Dave I suggest having a few catch blocks then. The first one should be for RuntimeException, where you can log it and then rethrow it directly. The rest should be for the specific checked exceptions you wish to catch. That way you can add specific error message per exception, and only wrap the ones you need. -- Daniel Pitts' Tech Blog: <http://virtualinfinity.net/wordpress/> |