Project Report: fawkez

Packagesummary org.jcoderz.guidelines.snippets

org.jcoderz.guidelines.snippets.ReferringSample

LineHitsNoteSource
1  /*
2   * $Id: ReferringSample.java 1011 2008-06-16 17:57:36Z amandel $
3   *
4   * Copyright 2006, The jCoderZ.org Project. All rights reserved.
5   *
6   * Redistribution and use in source and binary forms, with or without
7   * modification, are permitted provided that the following conditions are
8   * met:
9   *
10   *    * Redistributions of source code must retain the above copyright
11   *      notice, this list of conditions and the following disclaimer.
12   *    * Redistributions in binary form must reproduce the above
13   *      copyright notice, this list of conditions and the following
14   *      disclaimer in the documentation and/or other materials
15   *      provided with the distribution.
16   *    * Neither the name of the jCoderZ.org Project nor the names of
17   *      its contributors may be used to endorse or promote products
18   *      derived from this software without specific prior written
19   *      permission.
20   *
21   * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND
22   * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24   * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS
25   * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
28   * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29   * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
30   * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
31   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32   */
33  package org.jcoderz.guidelines.snippets;
34  
35  
36  /**
37   * An example class.
38   * @author mrumpf
39   */
400(1)public class ReferringSample
41  {
42      private static void classMethod ()
43      {
44          // ...
450     }
46  
47 (2)    public static void xyz ()
48      {
490(3)        final ReferringSample anObject = new ReferringSample();
50          // BEGIN SNIPPET: ReferringSample.xml
510         classMethod();
520         ReferringSample.classMethod();
530(4)        anObject.classMethod(); // DON'T
54          // END SNIPPET
550     }
56  }

Findings in this File

c (1) 40 : 1 Utility classes should not have a public or default constructor.
c (2) 47 : 5 Missing a Javadoc comment.
i (3) 49 : 0 Method org.jcoderz.guidelines.snippets.ReferringSample.xyz() needlessly instantiates a class that only supplies static methods
w (4) 53 : 0 method org.jcoderz.guidelines.snippets.ReferringSample.xyz() calls static method on instance reference