org.avaje.metric

Interface MetricName

All Superinterfaces:

Comparable<MetricName>

public interface MetricName
extends Comparable<MetricName>

The name of the metric.

Method Summary

Modifier and Type	Method and Description
MetricName	append(String suffix) Create and return another MetricName by appending the suffix.
String	getSimpleName() Return a simple java like name.
boolean	isError() Return true if the metric is considered an "error" metric with a name ending in ".error".
static MetricName	of(Class<?> cls, String name) Create a MetricName based on a class and name.
static MetricName	of(String name) Create a Metric name by parsing a name that is expected to include periods (dot notation similar to package.Class.method).
boolean	startsWith(String prefix) Return true if the metric name starts with the given prefix.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

of

static MetricName of(String name)

Create a Metric name by parsing a name that is expected to include periods (dot notation similar to package.Class.method).

of

static MetricName of(Class<?> cls,
                     String name)

Create a MetricName based on a class and name.

Often the name maps to a method name.

getSimpleName

String getSimpleName()

Return a simple java like name.

append

MetricName append(String suffix)

Create and return another MetricName by appending the suffix.

startsWith

boolean startsWith(String prefix)

Return true if the metric name starts with the given prefix.

isError

boolean isError()

Return true if the metric is considered an "error" metric with a name ending in ".error".