org.ballerinalang.util.metrics

Class Summary.Builder

java.lang.Object

org.ballerinalang.util.metrics.Summary.Builder

All Implemented Interfaces:

Metric.Builder<Summary.Builder,Summary>

Enclosing interface:

Summary

public static class Summary.Builder
extends Object
implements Metric.Builder<Summary.Builder,Summary>

Builder for Summarys.

Method Summary

Modifier and Type	Method and Description
Summary.Builder	description(String description) Set the description of the metric.
Summary	register() Create and register the metric with the default registry.
Summary	register(MetricRegistry registry) Create and register the metric with the given registry.
Summary.Builder	tag(String key, String value) Add tags to this metric.
Summary.Builder	tags(Iterable<Tag> tags) Add tags to this metric.
Summary.Builder	tags(Map<String,String> tags) Add tags to this metric.
Summary.Builder	tags(String... keyValues) Add tags to this metric.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

description

public Summary.Builder description(String description)

Description copied from interface: Metric.Builder

Set the description of the metric.

Specified by:

description in interface Metric.Builder<Summary.Builder,Summary>

Parameters:

description - The description of the metric.

Returns:

This builder instance.

tags

public Summary.Builder tags(String... keyValues)

Description copied from interface: Metric.Builder

Add tags to this metric.

Specified by:

tags in interface Metric.Builder<Summary.Builder,Summary>

Parameters:

keyValues - Must be an even number of arguments representing key/value pairs of tags.

Returns:

The builder with added tags.

tags

public Summary.Builder tags(Iterable<Tag> tags)

Description copied from interface: Metric.Builder

Add tags to this metric.

Specified by:

tags in interface Metric.Builder<Summary.Builder,Summary>

Parameters:

tags - Tags to add to the metrics

Returns:

The builder with added tags.

tag

public Summary.Builder tag(String key,
                           String value)

Description copied from interface: Metric.Builder

Add tags to this metric.

Specified by:

tag in interface Metric.Builder<Summary.Builder,Summary>

Parameters:

key - The tag key.

value - The tag value.

Returns:

The builder with a single added tag.

tags

public Summary.Builder tags(Map<String,String> tags)

Description copied from interface: Metric.Builder

Add tags to this metric.

Specified by:

tags in interface Metric.Builder<Summary.Builder,Summary>

Parameters:

tags - A map of key value pairs to be used as tags

Returns:

The builder with added tags.

register

public Summary register()

Description copied from interface: Metric.Builder

Create and register the metric with the default registry.

Specified by:

register in interface Metric.Builder<Summary.Builder,Summary>

Returns:

Registered metric

register

public Summary register(MetricRegistry registry)

Description copied from interface: Metric.Builder

Create and register the metric with the given registry.

Specified by:

register in interface Metric.Builder<Summary.Builder,Summary>

Parameters:

registry - MetricRegistry to be used

Returns:

Registered metric