Top Description Fields Constructors Methods
org.eclipse.microprofile.metrics

public Class MetricID

extends Object
implements Comparable<MetricID>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable
Imports
java.util.ArrayList, .Collections, .Iterator, .List, .Map, .Map.Entry, .Objects, .TreeMap, java.util.stream.Collectors, .Stream
A unique identifier for Metric and Metadata that are registered in the MetricRegistry The MetricID contains:

Field Summary

Modifier and TypeField and Description
private final String
name

Name of the metric.

private final Map<String, String>
tags

Tags of the metric.

Constructor Summary

AccessConstructor and Description
public
MetricID(String
the name of the metric
name)

Constructs a MetricID with the given metric name and no tags.

public
MetricID(String
the name of the metric
name, Tag...
the tags associated with this metric
tags)

Constructs a MetricID with the given metric name and Tags.

Method Summary

Modifier and TypeMethod and Description
private void
addTag(Tag
the Tag object
tag)

Adds a singular Tag object into the MetricID.

private void
addTags(Tag[]
an array of Tag objects
tagArray)

Add multiple Tag objects This method will call addTag(Tag) on each tag.

public int
compareTo(MetricID
the other MetricID
other)

Implements java.lang.Comparable.compareTo.

Compares two MetricID objects through the following steps:

  1. Compares the names of the two MetricIDs lexicographically.
  2. If the names are equal: Compare the number of tags.
  3. If the tag lengths are equal: Compare the Tags (sorted by the Tag's key value)
    • a) Compare the Tag names/keys lexicographically
    • b) If keys are equal, compare the Tag values lexicographically
public boolean
equals(Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public String

Returns:

the Metric name associated with this MetricID
getName()

Returns the Metric name associated with this MetricID

public Map<String, String>

Returns:

a Map of tags
getTags()

Returns the underlying map containing the tags.

public Tag[]

Returns:

An array of tags
getTagsAsArray()

Gets the list of tags as an array of Tag objects.

public List<Tag>

Returns:

a a list of Tag objects
getTagsAsList()

Gets the list of tags as a list of Tag objects

public String

Returns:

a String containing the tags
getTagsAsString()

Gets the list of tags as a single String in the format 'key="value",key2="value2",...'

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

nameback to summary
private final String name

Name of the metric.

A required field which holds the name of the metric object.

tagsback to summary
private final Map<String, String> tags

Tags of the metric.

Constructor Detail

MetricIDback to summary
public MetricID(String name)

Constructs a MetricID with the given metric name and no tags. If global tags are available then they will be appended to this MetricID.

Parameters
name:String

the name of the metric

MetricIDback to summary
public MetricID(String name, Tag... tags)

Constructs a MetricID with the given metric name and Tags. If global tags are available then they will be appended to this MetricID

Parameters
name:String

the name of the metric

tags:Tag[]

the tags associated with this metric

Method Detail

addTagback to summary
private void addTag(Tag tag)

Adds a singular Tag object into the MetricID. If the tag key/name already exists then it will be overwritten with the new value.

Parameters
tag:Tag

the Tag object

addTagsback to summary
private void addTags(Tag[] tagArray)

Add multiple Tag objects This method will call addTag(Tag) on each tag. If a key already exists then it will be overwritten.

Parameters
tagArray:Tag[]

an array of Tag objects

compareToback to summary
public int compareTo(MetricID other)

Implements java.lang.Comparable.compareTo.

Compares two MetricID objects through the following steps:

  1. Compares the names of the two MetricIDs lexicographically.
  2. If the names are equal: Compare the number of tags.
  3. If the tag lengths are equal: Compare the Tags (sorted by the Tag's key value)
    • a) Compare the Tag names/keys lexicographically
    • b) If keys are equal, compare the Tag values lexicographically
Parameters
other:MetricID

the other MetricID

Returns:int

Doc from java.lang.Comparable.compareTo.

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getNameback to summary
public String getName()

Returns the Metric name associated with this MetricID

Returns:String

the Metric name associated with this MetricID

getTagsback to summary
public Map<String, String> getTags()

Returns the underlying map containing the tags.

Returns:Map<String, String>

a Map of tags

getTagsAsArrayback to summary
public Tag[] getTagsAsArray()

Gets the list of tags as an array of Tag objects.

Returns:Tag[]

An array of tags

getTagsAsListback to summary
public List<Tag> getTagsAsList()

Gets the list of tags as a list of Tag objects

Returns:List<Tag>

a a list of Tag objects

getTagsAsStringback to summary
public String getTagsAsString()

Gets the list of tags as a single String in the format 'key="value",key2="value2",...'

Returns:String

a String containing the tags

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override