1 /*
2 Copyright (C) 2014 Chr. Clemens Lee <clemens@kclee.com>.
3
4 This file is part of JavaNCSS
5 (http://javancss.codehaus.org/).
6
7 This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Lesser General Public
9 License as published by the Free Software Foundation; either
10 version 2.1 of the License, or (at your option) any later version.
11
12 This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Lesser General Public License for more details.
16
17 You should have received a copy of the GNU Lesser General Public
18 License along with this library; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA*/
20
21 package javancss;
22
23 /**
24 * Base data class to store all metrics common to packages, objects and functions.
25 *
26 * @author Hervé Boutemy
27 * @version $Id$
28 */
29 public abstract class Metric
30 implements Comparable<Metric>
31 {
32 public String name = ".";
33
34 /** Non Commenting Source Statements (NCSS). */
35 public int ncss = 0;
36 public int firstLine = 0;
37 public int javadocs = 0;
38 public int javadocsLn = 0;
39 public int singleLn = 0;
40 public int multiLn = 0;
41
42 public void clear()
43 {
44 name = ".";
45 ncss = 0;
46 javadocs = 0;
47 javadocsLn = 0;
48 singleLn = 0;
49 multiLn = 0;
50 }
51
52 @Override
53 public String toString()
54 {
55 return name;
56 }
57
58 public int compareTo( Metric m )
59 {
60 return name.compareTo( m.name );
61 }
62
63 public boolean equals( Metric m )
64 {
65 return compareTo( m ) == 0;
66 }
67
68 @Override
69 public int hashCode()
70 {
71 return name.hashCode();
72 }
73 }