Project Report: fawkez

Packagesummary org.jcoderz.commons.statistics

org.jcoderz.commons.statistics.TimedCounter

LineHitsNoteSource
1  /*
2   * $Id: TimedCounter.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.commons.statistics;
34  
35  import java.text.DecimalFormat;
36  
37  import org.jcoderz.commons.types.Date;
38  
39  
40  
41  /**
42 (1) * TODO Write javadoc!
43   *
44   * @author Albrecht Messner
45   */
46  public class TimedCounter
47        extends Counter
48  {
49     private long mStartTime;
50     private long mStopTime;
51  
52     /**
53      * Constructor.
54      * @param name the name of this counter
55      */
56     public TimedCounter (String name)
57     {
580       super(name);
590       mStartTime = 0;
600       mStopTime = 0;
610    }
62  
63     /**
64      * Start this counter's timer.
65      */
66     public synchronized void start ()
67     {
680       mStartTime = System.currentTimeMillis();
690    }
70  
71     /**
72      * Stop this counter's timer.
73      */
74     public synchronized void stop ()
75     {
760       mStopTime = System.currentTimeMillis();
770    }
78  
79     /** {@inheritDoc} */
80     public synchronized void reset ()
81     {
820       super.reset();
830       mStopTime = 0;
840       start();
850    }
86  
87     /**
88      * Returns the amount of time this Counter was running.
89      * @return the amount of time this Counter was running
90      */
91     public synchronized long getDuration ()
92     {
93        final long duration;
940       if (mStopTime != 0)
95        {
960          duration = mStopTime - mStartTime;
97        }
98        else
99        {
1000          duration = System.currentTimeMillis() - mStartTime;
101        }
1020       return duration;
103     }
104  
105     /**
106      * Returns the frequency of this counter, i.e. getCount() / duration.
107      * @return the frequency of this counter, i.e. getCount() / duration.
108      */
109     public synchronized double getFrequency ()
110     {
1110       final long duration = getDuration();
1120       double result = 0;
1130       final double durationInSec = duration / (double) Date.MILLIS_PER_SECOND;
114  
1150       if (durationInSec > 0)
116        {
1170          result = getCount() / durationInSec;
118        }
1190       return result;
120     }
121  
122     /** {@inheritDoc} */
123     public String toString ()
124     {
1250       final DecimalFormat df = new DecimalFormat("0.000");
126  
1270(2)      final StringBuffer sbuf = new StringBuffer();
1280       sbuf.append("[TimedCounter name=").append(getName());
1290       sbuf.append(", duration=").append(getDuration());
1300       sbuf.append(", count=").append(getCount());
1310       sbuf.append(", freq=").append(df.format(getFrequency()));
1320       sbuf.append(']');
1330       return sbuf.toString();
134     }
135  }

Findings in this File

i (1) 42 : 0 Comment matches to-do format '(TODO|FIXME|CHECKME)'.
i (2) 127 : 26 StringBuffer constructor is initialized with size 16, but has at least 46 characters appended.