com.bigdata.ganglia

Class RichMetricMessage

java.lang.Object

com.bigdata.ganglia.AbstractGangliaMessage

com.bigdata.ganglia.GangliaMetricMessage

com.bigdata.ganglia.RichMetricMessage

All Implemented Interfaces:

IGangliaMessage, IGangliaMetricMessage

public class RichMetricMessage
extends GangliaMetricMessage

Class bundles together an IGangliaMetricMessage with the IGangliaMetadataMessage which provides its declaration.

Constructor Summary

Constructors

Constructor and Description
RichMetricMessage(String hostName, IGangliaMetadataMessage decl, boolean spoof, String format, Object value) Constructor produces an IGangliaMetricMessage which is consistent with the IGangliaMetadataMessage.

Method Summary

Methods

Modifier and Type	Method and Description
IGangliaMetadataMessage	getMetadata() The declaration and never null.

Methods inherited from class com.bigdata.ganglia.GangliaMetricMessage

equals, getFormat, getNumericValue, getStringValue, getValue, hashCode, isMetricMetadata, isMetricRequest, isMetricValue, isNumeric, 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

RichMetricMessage

public RichMetricMessage(String hostName,
                 IGangliaMetadataMessage decl,
                 boolean spoof,
                 String format,
                 Object value)

Constructor produces an IGangliaMetricMessage which is consistent with the IGangliaMetadataMessage.

Parameters:

hostName - The host reporting this metric value (should be ip:host if this is a spoof record).

decl - The metric declaration.

spoof - if this is a spoof record.

format - The printf format to be used.

value - The value.

Throws:

IllegalArgumentException - if the hostName is null.

NullPointerException - if the declaration is null.

IllegalArgumentException - if the format is null.

IllegalArgumentException - if the value is null.

Method Detail

getMetadata

public IGangliaMetadataMessage getMetadata()

The declaration and never null.