Metric.java

biz/hammurapi/metrics/Metric.java

Violations

Inspector Message Severity Location
Java Inspector 048 Copyrights information should be present in each file. 1
Java Inspector 089 Type is not documented 2 31:1
Java Inspector 089 Non-private, non-local types shall be documented 2 32:9
Java Inspector 047 No need to provide (public, abstract, ) modifiers for interface methods 3 32:9

Source code

1/*
2 * hgcommons 9
3 * Hammurapi Group Common Library
4 * Copyright (C) 2003 Hammurapi Group
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 *
20 * URL: http://www.hammurapi.biz/hammurapi-biz/ef/xmenu/hammurapi-group/products/products/hgcommons/index.html
21 * e-Mail: support@hammurapi.biz
22 */
23package biz.hammurapi.metrics;
24
25import java.util.Collection;
26
27/**
28 * @author Pavel Vlasov
29 * @version $Revision: 1.5 $
30 */
31public interface Metric {
32 public interface Measurement {
33 double getValue();
34 long getTime();
35 }
36
37 /**
38 * @return number of measurements
39 */
40 int getNumber();
41
42 /**
43 * @return Minimum value
44 */
45 double getMin();
46
47 /**
48 * @return Maximum value
49 */
50 double getMax();
51
52 /**
53 * @return Average
54 */
55 double getAvg();
56
57 /**
58 * @return Sum of values from all measurements
59 */
60 double getTotal();
61
62 /**
63 * @return average distance from average
64 */
65 double getDeviation();
66
67 /**
68 * Adds measurement
69 * @param source Source object
70 * @param value value
71 */
72 void add(double value, long time);
73
74 /**
75 * Adds another metric (aggregates)
76 * @param metric
77 */
78 void add(Metric metric);
79
80 /**
81 * @return Collection of {@link Measurement}
82 */
83 Collection getMeasurements();
84
85 String getName();
86}