com.yammer.metrics.core

Class Counter

java.lang.Object

com.yammer.metrics.core.Counter

All Implemented Interfaces:

Metric

public class Counter
extends Object
implements Metric

An incrementing and decrementing counter metric.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Resets the counter to 0.
long	count() Returns the counter's current value.
void	dec() Decrement the counter by one.
void	dec(long n) Decrement the counter by n.
void	inc() Increment the counter by one.
void	inc(long n) Increment the counter by n.
<T> void	processWith(MetricProcessor<T> processor, MetricName name, T context) Allow the given MetricProcessor to process this as a metric.

Methods inherited from class java.lang.Object

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

Method Detail

inc

public void inc()

Increment the counter by one.

inc

public void inc(long n)

Increment the counter by n.

Parameters:

n - the amount by which the counter will be increased

dec

public void dec()

Decrement the counter by one.

dec

public void dec(long n)

Decrement the counter by n.

Parameters:

n - the amount by which the counter will be increased

count

public long count()

Returns the counter's current value.

Returns:

the counter's current value

clear

public void clear()

Resets the counter to 0.

processWith

public <T> void processWith(MetricProcessor<T> processor,
                   MetricName name,
                   T context)
                 throws Exception

Description copied from interface: Metric

Allow the given MetricProcessor to process this as a metric.

Specified by:

processWith in interface Metric

Type Parameters:

T - the type of the context object

Parameters:

processor - a MetricProcessor

name - the name of the current metric

context - a given context which should be passed on to processor

Throws:

Exception - if something goes wrong