org.opensolaris.os.dtrace
Class AvgValue

java.lang.Object
  extended by org.opensolaris.os.dtrace.AvgValue
All Implemented Interfaces:
java.io.Serializable, AggregationValue

public final class AvgValue
extends java.lang.Object

A long value aggregated by the DTrace avg() action.

Immutable. Supports persistence using XMLEncoder.

See Also:
Aggregation, Serialized Form

Constructor Summary
AvgValue(long v, long averagedTotal, long averagedValueCount)
          Creates a value aggregated by the DTrace avg() action.
 
Method Summary
 boolean equals(java.lang.Object o)
          Compares the specified object with this aggregation value for equality.
 long getCount()
          Gets the number of aggregated values included in the average.
 long getTotal()
          Gets the sum total of the aggregated values.
 java.lang.Long getValue()
          Gets the average of the aggregated values.
 int hashCode()
          Overridden to ensure that equal instances have equal hash codes.
 java.lang.String toString()
          Gets the string representation of getValue().
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AvgValue

public AvgValue(long v,
                long averagedTotal,
                long averagedValueCount)
Creates a value aggregated by the DTrace avg() action. Supports XML persistence.

Parameters:
v - average
averagedTotal - sum total of all values averaged
averagedValueCount - number of values averaged
Throws:
java.lang.IllegalArgumentException - if the given count is negative or if the given average is not the value expected for the given total and count
Method Detail

getValue

public java.lang.Long getValue()
Gets the average of the aggregated values.

Specified by:
getValue in interface AggregationValue
Returns:
average of the aggregated values, equal to (getTotal() / getCount()) rounded down

getTotal

public long getTotal()
Gets the sum total of the aggregated values.

Returns:
the sum total of the aggregated values

getCount

public long getCount()
Gets the number of aggregated values included in the average.

Returns:
the number of aggregated values included in the average

equals

public boolean equals(java.lang.Object o)
Compares the specified object with this aggregation value for equality. Defines equality as having the same type and the same numeric value.

Overrides:
equals in class java.lang.Object
Returns:
true if and only if the specified object is an aggregation value of the same Class as this value, and both values return equal numbers from getValue().

hashCode

public int hashCode()
Overridden to ensure that equal instances have equal hash codes.

Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()
Gets the string representation of getValue().

Overrides:
toString in class java.lang.Object
Returns:
the string representation of getValue() returned by Object.toString()