Interface FunctionalCounter

All Superinterfaces:

Meter, Wrapper, 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 Meter

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

Modifier and Type	Interface	Description
static class	Meter.BaseUnits	Common unit declarations (inspired by the list from MicroProfile metrics).
static interface	Meter.Id	Unique idenfier for a meter.
static class	Meter.Scope	Deprecated, for removal: This API element is subject to removal in a future version. Core metrics ignores scope values, and this type will be removed.
static enum	Meter.Type	Type of meter.

Method Summary

Modifier and Type	Method	Description
static <T> FunctionalCounter.Builder<?>	builder(String name, T stateObject, Function<T,Long> fn)	Deprecated, for removal: This API element is subject to removal in a future version. this method uses service registry to get a MetricsFactory instance, which may be inefficient, use MetricsFactory.functionalCounterBuilder(String, Object, java.util.function.Function) instead
long	count()	Returns the counter value.

Methods inherited from interface Meter

baseUnit, description, id, scope, type

Modifier and Type	Method	Description
Optional<String>	baseUnit()	Returns the meter's base unit.
Optional<String>	description()	Returns the meter's description.
Meter.Id	id()	Returns the meter ID.
default Optional<String>	scope()	Deprecated, for removal: This API element is subject to removal in a future version. Core metrics does not assign scopes, and this method will be removed.
Meter.Type	type()	Returns the meter type.

Methods inherited from interface Wrapper

unwrap

Modifier and Type	Method	Description
<T> T	unwrap(Class<? extends T> type)	Unwraps the delegate as the specified type.

Method Details

builder

@Deprecated(forRemoval=true,
            since="27.0.0")
static <T> FunctionalCounter.Builder<?> builder(String name,
 T stateObject,
 Function<T,Long> fn)

Deprecated, for removal: This API element is subject to removal in a future version.

this method uses service registry to get a MetricsFactory instance, which may be inefficient, use MetricsFactory.functionalCounterBuilder(String, Object, java.util.function.Function) instead

Returns a builder for registering or locating a functional counter.

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