com.timgroup.statsd

Class Message

java.lang.Object

com.timgroup.statsd.Message

All Implemented Interfaces:

Comparable<Message>

Direct Known Subclasses:

AlphaNumericMessage, NumericMessage

public abstract class Message
extends Object
implements Comparable<Message>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Message.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected static Set<Message.Type>	AGGREGATE_SET
protected boolean	done
protected static int	HASH_MULTIPLIER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Message(Message.Type type)
protected	Message(String aspect, Message.Type type, String[] tags)

Method Summary

Modifier and Type	Method and Description
abstract void	aggregate(Message message) Aggregate message.
boolean	canAggregate() Return whether a message can be aggregated.
int	compareTo(Message message)
boolean	equals(Object object) Messages must implement hashCode.
String	getAspect() Return the message aspect.
boolean	getDone()
String[]	getTags() Return the array of tags for the message.
Message.Type	getType() Return the message type.
int	hashCode() Messages must implement hashCode.
void	setDone(boolean done)

Methods inherited from class java.lang.Object

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

Field Detail

done

protected boolean done

HASH_MULTIPLIER

protected static final int HASH_MULTIPLIER

See Also:

Constant Field Values

AGGREGATE_SET

protected static final Set<Message.Type> AGGREGATE_SET

Constructor Detail

Message

protected Message(Message.Type type)

Message

protected Message(String aspect,
                  Message.Type type,
                  String[] tags)

Method Detail

aggregate

public abstract void aggregate(Message message)

Aggregate message.

Parameters:

message - Message to aggregate.

getAspect

public final String getAspect()

Return the message aspect.

Returns:

returns the string representing the Message aspect

getType

public final Message.Type getType()

Return the message type.

Returns:

returns the dogstatsd type for the Message

getTags

public String[] getTags()

Return the array of tags for the message.

Returns:

returns the string array of tags for the Message

canAggregate

public boolean canAggregate()

Return whether a message can be aggregated.

Returns:

boolean on whether or not this message type may be aggregated.

setDone

public void setDone(boolean done)

getDone

public boolean getDone()

hashCode

public int hashCode()

Messages must implement hashCode.

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Messages must implement hashCode.

Overrides:

equals in class Object

compareTo

public int compareTo(Message message)

Specified by:

compareTo in interface Comparable<Message>