com.bigdata.ganglia

Class GangliaMetricMessage

java.lang.Object

com.bigdata.ganglia.AbstractGangliaMessage

com.bigdata.ganglia.GangliaMetricMessage

All Implemented Interfaces:

IGangliaMessage, IGangliaMetricMessage

Direct Known Subclasses:

RichMetricMessage

public class GangliaMetricMessage
extends AbstractGangliaMessage
implements IGangliaMetricMessage

A ganglia 3.1 metric message.

Constructor Summary

Constructors

Constructor and Description
GangliaMetricMessage(GangliaMessageTypeEnum recordType, String hostName, String metricName, boolean spoof, String format, Object value) Constructor from data.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getFormat() The printf format string associated with the metric value.
Number	getNumericValue() Return the Number for the metric value.
String	getStringValue() Return a String representation of the metric value (always succeeds).
Object	getValue() Return the metric value (non-null).
int	hashCode()
boolean	isMetricMetadata() Return true iff this message contains the metadata for a metric (the metric declaration).
boolean	isMetricRequest() Return true iff this message is a request for a metric.
boolean	isMetricValue() Return true if this message represents a metric value.
boolean	isNumeric() Return true if the metric value is a numeric, in which case it can be cast to a Number.
String	toString()

Methods inherited from class com.bigdata.ganglia.AbstractGangliaMessage

getHostName, getMetricName, getRecordType, isSpoof

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.bigdata.ganglia.IGangliaMessage

getHostName, getMetricName, getRecordType, isSpoof

Constructor Detail

GangliaMetricMessage

public GangliaMetricMessage(GangliaMessageTypeEnum recordType,
                    String hostName,
                    String metricName,
                    boolean spoof,
                    String format,
                    Object value)

Constructor from data.

Parameters:

recordType -

hostName -

metricName -

spoof -

format -

value -

Method Detail

isMetricValue

public boolean isMetricValue()

Description copied from interface: IGangliaMessage

Return true if this message represents a metric value.

Specified by:

isMetricValue in interface IGangliaMessage

isMetricRequest

public boolean isMetricRequest()

Description copied from interface: IGangliaMessage

Return true iff this message is a request for a metric.

Specified by:

isMetricRequest in interface IGangliaMessage

See Also:

GangliaMessageTypeEnum.REQUEST

isMetricMetadata

public boolean isMetricMetadata()

Description copied from interface: IGangliaMessage

Return true iff this message contains the metadata for a metric (the metric declaration).

Specified by:

isMetricMetadata in interface IGangliaMessage

See Also:

GangliaMessageTypeEnum.METADATA

getFormat

public String getFormat()

Description copied from interface: IGangliaMetricMessage

The printf format string associated with the metric value.

Specified by:

getFormat in interface IGangliaMetricMessage

isNumeric

public boolean isNumeric()

Description copied from interface: IGangliaMetricMessage

Return true if the metric value is a numeric, in which case it can be cast to a Number.

Specified by:

isNumeric in interface IGangliaMetricMessage

getValue

public Object getValue()

Description copied from interface: IGangliaMetricMessage

Return the metric value (non-null).

Specified by:

getValue in interface IGangliaMetricMessage

getStringValue

public String getStringValue()

Description copied from interface: IGangliaMetricMessage

Return a String representation of the metric value (always succeeds).

Specified by:

getStringValue in interface IGangliaMetricMessage

getNumericValue

public Number getNumericValue()

Description copied from interface: IGangliaMetricMessage

Return the Number for the metric value.

Specified by:

getNumericValue in interface IGangliaMetricMessage

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Specified by:

equals in class AbstractGangliaMessage

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractGangliaMessage