org.springframework.xd.analytics.metrics.core

Interface GaugeService

All Known Implementing Classes:

InMemoryGaugeService, RedisGaugeService

public interface GaugeService

A Gauge service that allows you to set the value of the gauge. You can also reset the gauge. It also provides a 'getOrCreate' method that will return an existing gauge given the name or create a new gauge set to zero.

Author:

Mark Pollack

Method Summary

Methods

Modifier and Type	Method and Description
Gauge	getOrCreate(java.lang.String name) Returns an existing gauge for the given name or creates a new gauge set to zero
void	reset(java.lang.String name) Reset the gauge to zero
void	setValue(java.lang.String name, long value) Set the value of the gauge

Method Detail

getOrCreate

Gauge getOrCreate(java.lang.String name)

Returns an existing gauge for the given name or creates a new gauge set to zero

Parameters:

name - name of the gauge

Returns:

existing or new gauge.

Throws:

java.lang.IllegalArgumentException - in case the given name is null

setValue

void setValue(java.lang.String name,
            long value)

Set the value of the gauge

Parameters:

name - the gauge name

value - the value of the gauge

Throws:

java.lang.IllegalArgumentException - in case the given name is null

reset

void reset(java.lang.String name)

Reset the gauge to zero

Parameters:

name - the gauge name

Throws:

java.lang.IllegalArgumentException - in case the given name is null