org.honton.chas.dogstatd.model

Class Gauge

java.lang.Object

org.honton.chas.dogstatd.model.Gauge

All Implemented Interfaces:

Message

public class Gauge
extends Object

A Gauge records a value of a at a particular time.

Field Summary

Fields

Modifier and Type	Field and Description
protected T	value

Constructor Summary

Constructors

Constructor and Description
Gauge(String name, Number value, String... tags) Create an Gauge value to be sent to DogStatD.

Method Summary

Modifier and Type	Method and Description
void	format(CharBuffer chars) Format the message to be sent.
boolean	validate() Validate the message to be sent.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

value

protected final T value

Constructor Detail

Gauge

public Gauge(String name,
             Number value,
             String... tags)

Create an Gauge value to be sent to DogStatD.

Parameters:

name - The name of the gauge.

value - The value of the gauge.

tags - Any additional data about the value.

Method Detail

validate

public boolean validate()

Description copied from interface: Message

Validate the message to be sent. If the message is invalid, this method should log the incorrect portion and reason for failure. This method may be called from a different thread than the one invoking the Sender.send(Message) method.

Specified by:

validate in interface Message

Returns:

true, if the message is valid and should be sent.

format

public void format(CharBuffer chars)

Description copied from interface: Message

Format the message to be sent. In general, message includes type of record, metrics, tags and ends with newline.

Specified by:

format in interface Message

Parameters:

chars - The buffer to hold the formatted message.