MicroProfile 7.0 · org.eclipse.microprofile.metrics.Tag

public Class Tag

Tag represents a singular metric tag key and value pair. The Tag contains:

TagName: (Required) The name of the tag. Must match the regex [a-zA-Z_][a-zA-Z0-9_]*.
TagValue: (Required) The value of the tag.

Field Summary

Modifier and Type	Field and Description
private static final Pattern	PATTERN Pattern that matches regex [a-zA-Z_][a-zA-Z0-9_]*
private final String	tagName Name of the Tag.
private final String	tagValue Value of the Tag.

Constructor Summary

Access	Constructor and Description
public	Tag(String The tag name, must match the regex [a-zA-Z_][a-zA-Z0-9_]*. tagName, String The tag value tagValue) Constructs the Tag object with the given tag name and tag value

Method Summary

Modifier and Type	Method and Description
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 tagName getTagName()
public String	Returns: the tagValue getTagValue()
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:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

PATTERN	back to summary
private static final Pattern PATTERN Pattern that matches regex [a-zA-Z_][a-zA-Z0-9_]*

tagName	back to summary
private final String tagName Name of the Tag. Must match the regex [a-zA-Z_][a-zA-Z0-9_]*. A required field which holds the name of the tag.

tagName

back to summary

private final String tagName

Name of the Tag. Must match the regex [a-zA-Z_][a-zA-Z0-9_]*.

A required field which holds the name of the tag.

tagValue	back to summary
private final String tagValue Value of the Tag. A required field which holds the value of the tag.

tagValue

back to summary

private final String tagValue

Value of the Tag.

A required field which holds the value of the tag.

Constructor Detail

Tag	back to summary
public Tag(String tagName, String tagValue) throws IllegalArgumentException Constructs the Tag object with the given tag name and tag value Parameters tagName:String The tag name, must match the regex [a-zA-Z_][a-zA-Z0-9_]. tagValue:String The tag value Exceptions IllegalArgumentException: If the tagName does not match [a-zA-Z_][a-zA-Z0-9_]

Tag

back to summary

public Tag(String tagName, String tagValue) throws IllegalArgumentException

Constructs the Tag object with the given tag name and tag value

Parameters

tagName:String: The tag name, must match the regex [a-zA-Z_][a-zA-Z0-9_]*.
tagValue:String: The tag value

Exceptions

IllegalArgumentException:: If the tagName does not match [a-zA-Z_][a-zA-Z0-9_]*

Method Detail

equals back to summary

equals	back 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

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

getTagName	back to summary
public String getTagName() Returns:String the tagName

getTagValue	back to summary
public String getTagValue() Returns:String the tagValue

hashCode back to summary

hashCode	back 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

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

toString back to summary

toString	back 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

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