1 /**
2 * Copyright (c) 2012, University of Konstanz, Distributed Systems Group
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the University of Konstanz nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27 package org.perfidix.meter;
28
29 /**
30 * For benchmarking in a widen sense, several different meters should be
31 * implemented. The first one is obviously the time. Nevertheless, besides the
32 * time, other meters for special purposes can be implemented with this method.
33 *
34 * @author Alexander Onea, neue Couch
35 * @author Sebastian Graf, University of Konstanz
36 */
37 public abstract class AbstractMeter {
38
39 /**
40 * Getting the current value for this meter.
41 *
42 * @return the current tick value.
43 */
44 public abstract double getValue();
45
46 /**
47 * Returns the unit in which this measure taker computes its results.
48 *
49 * @return the unit of this meter
50 */
51 public abstract String getUnit();
52
53 /**
54 * The long description of the unit. can be empty but if available, it
55 * should provide one or two words about the measure taker.
56 *
57 * @return the long description of the unit in which measurement takes
58 * place.
59 */
60 public abstract String getUnitDescription();
61
62 /**
63 * A short name of the meter.
64 *
65 * @return the name.
66 */
67 public abstract String getName();
68
69 /**
70 * The String representation of this meter with its current value.
71 *
72 * @return a string representation of this meter.
73 */
74 @Override
75 public final String toString() {
76 final StringBuilder builder = new StringBuilder();
77
78 builder.append(getName()).append("[").append(getUnit()).append("]");
79 return builder.toString();
80 }
81
82 /**
83 * {@inheritDoc}
84 */
85 @Override
86 public abstract int hashCode();
87
88 /**
89 * {@inheritDoc}
90 */
91 @Override
92 public abstract boolean equals(final Object obj);
93
94 }