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

Modifier and Type	Field and Description
private final String	description A human readable description.
private final String	name Name of the metric.
private final String	unit Unit of the metric.

Access	Constructor and Description
protected	DefaultMetadata(String name, String description, String unit)

Method Summary

Modifier and Type	Method and Description
public Optional<String>	description() Implements org.eclipse.microprofile.metrics.Metadata.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	getDescription() Implements org.eclipse.microprofile.metrics.Metadata.getDescription. Returns the description of the metric if set, otherwise this method returns the empty `String`.
public String	getName() Implements org.eclipse.microprofile.metrics.Metadata.getName. Returns the metric name.
public String	getUnit() Implements org.eclipse.microprofile.metrics.Metadata.getUnit. Returns the unit of this metric if set, otherwise this method returns `MetricUnits#NONE`
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.
public Optional<String>	unit() Implements org.eclipse.microprofile.metrics.Metadata.unit.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

description	back to summary
private final String description A human readable description. An optional field which holds the description of the metric object.

name	back to summary
private final String name Name of the metric. A required field which holds the name of the metric object.

unit	back to summary
private final String unit Unit of the metric. An optional field which holds the Unit of the metric object.

Method Detail

description	back to summary
public Optional<String> description() Implements org.eclipse.microprofile.metrics.Metadata.description. Annotations @Override

description

back to summary

public Optional<String> description()

Implements org.eclipse.microprofile.metrics.Metadata.description.

Annotations

@Override

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

getDescription back to summary

getDescription	back to summary
public String getDescription() Implements org.eclipse.microprofile.metrics.Metadata.getDescription. Doc from org.eclipse.microprofile.metrics.Metadata.getDescription. Returns the description of the metric if set, otherwise this method returns the empty `String`. Returns:String the description Annotations @Override

public String getDescription()

Implements org.eclipse.microprofile.metrics.Metadata.getDescription.

Doc from org.eclipse.microprofile.metrics.Metadata.getDescription.

Returns the description of the metric if set, otherwise this method returns the empty String.

Returns:String

the description

Annotations

@Override

getName	back to summary
public String getName() Implements org.eclipse.microprofile.metrics.Metadata.getName. Doc from org.eclipse.microprofile.metrics.Metadata.getName. Returns the metric name. Returns:String the metric name. Annotations @Override

getName

back to summary

public String getName()

Implements org.eclipse.microprofile.metrics.Metadata.getName.

Doc from org.eclipse.microprofile.metrics.Metadata.getName.

Returns the metric name.

Returns:String

the metric name.

Annotations

@Override

getUnit back to summary

getUnit	back to summary
public String getUnit() Implements org.eclipse.microprofile.metrics.Metadata.getUnit. Doc from org.eclipse.microprofile.metrics.Metadata.getUnit. Returns the unit of this metric if set, otherwise this method returns `MetricUnits#NONE` Returns:String the unit Annotations @Override

public String getUnit()

Implements org.eclipse.microprofile.metrics.Metadata.getUnit.

Doc from org.eclipse.microprofile.metrics.Metadata.getUnit.

Returns the unit of this metric if set, otherwise this method returns MetricUnits#NONE

Returns:String

the unit

Annotations

@Override

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