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