1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  *
26  * ident	"%Z%%M%	%I%	%E% SMI"
27  */
28 package org.opensolaris.os.dtrace;
29 
30 /**
31  * A value accumulated by an aggregating DTrace action such as {@code
32  * count()} or {@code sum()}.  Each {@code AggregationValue} is
33  * associated with a {@link Tuple} in an {@link AggregationRecord}.  In
34  * other words it is a value in a key-value pair (each pair representing
35  * an entry in a DTrace aggregation).
36  * <p>
37  * This value may be a single number or consist of multiple numbers,
38  * such as a value distribution.  In the latter case, it still has a
39  * single, composite value useful for display and/or comparison.
40  *
41  * @see AggregationRecord
42  *
43  * @author Tom Erickson
44  */
45 public interface AggregationValue {
46     /**
47      * Gets the numeric value of this instance.
48      *
49      * @return non-null numeric value
50      */
getValue()51     public Number getValue();
52 }
53