org.opensolaris.os.dtrace
Class StddevValue

java.lang.Object
  org.opensolaris.os.dtrace.StddevValue

All Implemented Interfaces:

java.io.Serializable, AggregationValue

public final class StddevValue
extends java.lang.Object

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

Immutable. Supports persistence using XMLEncoder.

See Also:

Aggregation, Serialized Form

StddevValue

public StddevValue(long v,
                   long stddevTotal,
                   long stddevCount,
                   java.lang.String stddevTotalSquaresString)

Creates a value aggregated by the DTrace stddev() action. Supports XML persistence.

Parameters:

v - standard deviation

stddevTotal - sum total of all values included in the standard deviation

stddevCount - number of values included in the standard deviation

stddevTotalSquaresString - decimal string representation of the 128-bit sum total of the squares of all values included in the standard deviation

Throws:

java.lang.IllegalArgumentException - if the given count is negative or if the given standard deviation is not the value expected for the given total, total of squares, and count

java.lang.NumberFormatException - if the given total squares is not a valid integer representation

getValue

public java.lang.Long getValue()

Gets the standard deviation of the aggregated values.

Specified by:

getValue in interface AggregationValue

Returns:

standard deviation of the aggregated values

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 standard deviation.

Returns:

the number of aggregated values included in the standard deviation

getTotalSquares

public java.math.BigInteger getTotalSquares()

Gets the sum total of the squares of the aggregated values.

Returns:

the sum total of the squares of the aggregated values

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()