Interface FunctionalCounter.Builder<T>

Type Parameters:

T - type of the state object

All Superinterfaces:

Meter.Builder<FunctionalCounter.Builder<T>, FunctionalCounter>, Wrapper, Wrapper

Enclosing interface:

FunctionalCounter

public static interface FunctionalCounter.Builder<T>
extends Meter.Builder<FunctionalCounter.Builder<T>, FunctionalCounter>

Builder for a FunctionalCounter.

See Also:

• MeterRegistry.getOrCreate(Meter.Builder)

Method Summary

Modifier and Type	Method	Description
Function<T,Long>	fn()	Returns the function which, when applied to the state object, returns the counter value.
T	stateObject()	Returns the state object which would supply the counter value.

Methods inherited from interface Meter.Builder

addTag, baseUnit, baseUnit, description, description, identity, name, origin, origin, scope, scope, tags, tags

Modifier and Type	Method	Description
FunctionalCounter.Builder<T>	addTag(Tag tag)	Adds a single tag to the builder's collection.
Optional<String>	baseUnit()	Returns the base unit the builder will use.
FunctionalCounter.Builder<T>	baseUnit(String baseUnit)	Sets the units.
Optional<String>	description()	Returns the description the builder will use.
FunctionalCounter.Builder<T>	description(String description)	Sets the description.
default FunctionalCounter.Builder<T>	identity()	Returns the type-correct "this".
String	name()	Returns the name the builder will use.
default Optional<String>	origin()	Returns the fully-qualified name of the type which originated the meter, if set.
default FunctionalCounter.Builder<T>	origin(String origin)	Sets the fully-qualified name of the type which originated the meter.
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.
default FunctionalCounter.Builder<T>	scope(String scope)	Deprecated, for removal: This API element is subject to removal in a future version. No-op, will be removed.
Map<String,String>	tags()	Returns the tags the builder will use.
FunctionalCounter.Builder<T>	tags(Iterable<Tag> tags)	Sets the tags to use in identifying the build meter.

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

stateObject

T stateObject()

Returns the state object which would supply the counter value.

Returns:

state object

fn

Function<T,Long> fn()

Returns the function which, when applied to the state object, returns the counter value.

Returns:

function returning the counter value