Module org.mule.metrics.api

Package org.mule.metrics.api.instrument.builder

Interface InstrumentBuilder<T extends Instrument>

Type Parameters:

T - the type of the Instrument that will be returned.

All Known Subinterfaces:

LongCounterBuilder, LongGaugeBuilder, LongUpDownCounterBuilder

public interface InstrumentBuilder<T extends Instrument>

A builder for Instrument's component.

Method Summary

Modifier and Type	Method	Description
T	build()
InstrumentBuilder<T>	withDescription(String description)	Sets the description for the instrument to build.
InstrumentBuilder<T>	withUnit(String unit)	Sets the unit for this instrument to build.

Method Details

withDescription

InstrumentBuilder<T> withDescription(String description)

Sets the description for the instrument to build.

Parameters:

description - the description.

Returns:

the LongCounterBuilder

withUnit

InstrumentBuilder<T> withUnit(String unit)

Sets the unit for this instrument to build.

Parameters:

unit - the unit.

Returns:

the LongCounterBuilder.

build

T build()

Returns:

the InstrumentBuilder.