Package org.apache.solr.metrics

Class SolrMetricInfo

java.lang.Object

org.apache.solr.metrics.SolrMetricInfo

public final class SolrMetricInfo
extends Object

Wraps meta-data for a metric.

Field Summary

Fields

Modifier and Type	Field	Description
final SolrInfoBean.Category	category
final String	name
final String	scope

Constructor Summary

Constructors

Constructor	Description
SolrMetricInfo(SolrInfoBean.Category category, String scope, String name)	Creates a new instance of SolrMetricInfo.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getMetricName()	Returns the metric name defined by this object.
int	hashCode()
static SolrMetricInfo	of(String fullName)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

name

public final String name

scope

public final String scope

category

public final SolrInfoBean.Category category

Constructor Details

SolrMetricInfo

public SolrMetricInfo(SolrInfoBean.Category category,
 String scope,
 String name)

Creates a new instance of SolrMetricInfo.

Parameters:

category - the category of the metric (e.g. `QUERY`)

scope - the scope of the metric (e.g. `/admin/ping`)

name - the name of the metric (e.g. `Requests`)

Method Details

of

public static SolrMetricInfo of(String fullName)

getMetricName

public String getMetricName()

Returns the metric name defined by this object. For example, if the name is `Requests`, scope is `/admin/ping`, and category is `QUERY`, then the metric name is `QUERY./admin/ping.Requests`.

Returns:

the metric name defined by this object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object