1 /**
2 * Redistribution and use in source and binary forms, with or without
3 * modification, are permitted provided that the following conditions are
4 * met :
5 *
6 * . Redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer.
8 *
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 *
13 * . The name of the author may not 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 AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * 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 THE AUTHOR BE LIABLE FOR ANY DIRECT,
20 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
24 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29 package cppncss;
30
31 import java.util.List;
32
33 /**
34 * Defines a component to output results.
35 *
36 * @author Mathieu Champlon
37 */
38 public interface ResultOutput
39 {
40 /**
41 * Notify about a list of labels.
42 *
43 * @param type the type of measure
44 * @param labels a list of measurements
45 */
46 void notify( final String type, final List<String> labels );
47
48 /**
49 * Notify about a measurement.
50 *
51 * @param type the type of measure
52 * @param item the measured item
53 * @param count the result
54 */
55 void notify( final String type, final String item, final int count );
56
57 /**
58 * Notify about an average.
59 *
60 * @param type the type of measure
61 * @param item the measured item
62 * @param average the result
63 */
64 void notify( final String type, final String item, final float average );
65
66 /**
67 * Notify about a sum.
68 *
69 * @param type the type of measure
70 * @param item the measured item
71 * @param sum the result
72 */
73 void notify( final String type, final String item, final long sum );
74
75 /**
76 * Notify about the end of the result flow.
77 */
78 void flush();
79 }