Module io.helidon.metrics.api

Package io.helidon.metrics.api

Interface FunctionalCounter

All Superinterfaces:

Meter, Wrapper

public interface FunctionalCounter
extends Meter

A read-only counter which wraps some other object that provides the counter value via a function.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	FunctionalCounter.Builder<T>	Builder for a FunctionalCounter.

Nested classes/interfaces inherited from interface io.helidon.metrics.api.Meter

Meter.BaseUnits, Meter.Id, Meter.Scope, Meter.Type

Method Summary

Modifier and Type	Method	Description
static <T> FunctionalCounter.Builder<?>	builder(String name, T stateObject, Function<T,Long> fn)	Returns a builder for registering or locating a functional counter.
long	count()	Returns the counter value.

Methods inherited from interface io.helidon.metrics.api.Meter

baseUnit, description, id, scope, type

Methods inherited from interface io.helidon.metrics.api.Wrapper

unwrap

Method Details

builder

static <T> FunctionalCounter.Builder<?> builder(String name,
 T stateObject,
 Function<T,Long> fn)

Returns a builder for registering or locating a functional counter.

For new code, prefer MetricsFactory.functionalCounterBuilder(String, Object, java.util.function.Function) on the MetricsFactory instance used by the application.

Type Parameters:

T - type of the state object

Parameters:

name - functional counter name

stateObject - object which provides the counter value on demand

fn - function which, when applied to the state object, returns the counter value

Returns:

new builder

count

long count()

Returns the counter value.

Returns:

counter value