io.smallrye.metrics

Class UnspecifiedMetadata

java.lang.Object

io.smallrye.metrics.UnspecifiedMetadata

All Implemented Interfaces:

org.eclipse.microprofile.metrics.Metadata

public class UnspecifiedMetadata
extends Object
implements org.eclipse.microprofile.metrics.Metadata

This is a special class to internally mark that no metadata was specified for a metric registration. We can't simply use null instead of this because we still need to keep track of the metric name and type somewhere. Instances of this class MUST NOT be actually stored in the MetricsRegistry, it needs to be converted to real metadata first!!!

Constructor Summary

Constructors

Constructor and Description
UnspecifiedMetadata(String name, org.eclipse.microprofile.metrics.MetricType type)

Method Summary

Modifier and Type	Method and Description
org.eclipse.microprofile.metrics.Metadata	convertToRealMetadata()
Optional<String>	getDescription()
String	getDisplayName()
String	getName()
String	getType()
org.eclipse.microprofile.metrics.MetricType	getTypeRaw()
Optional<String>	getUnit()
boolean	isReusable()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.microprofile.metrics.Metadata

builder, builder

Constructor Detail

UnspecifiedMetadata

public UnspecifiedMetadata(String name,
                           org.eclipse.microprofile.metrics.MetricType type)

Method Detail

getName

public String getName()

Specified by:

getName in interface org.eclipse.microprofile.metrics.Metadata

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface org.eclipse.microprofile.metrics.Metadata

getDescription

public Optional<String> getDescription()

Specified by:

getDescription in interface org.eclipse.microprofile.metrics.Metadata

getType

public String getType()

Specified by:

getType in interface org.eclipse.microprofile.metrics.Metadata

getTypeRaw

public org.eclipse.microprofile.metrics.MetricType getTypeRaw()

Specified by:

getTypeRaw in interface org.eclipse.microprofile.metrics.Metadata

getUnit

public Optional<String> getUnit()

Specified by:

getUnit in interface org.eclipse.microprofile.metrics.Metadata

isReusable

public boolean isReusable()

Specified by:

isReusable in interface org.eclipse.microprofile.metrics.Metadata

convertToRealMetadata

public org.eclipse.microprofile.metrics.Metadata convertToRealMetadata()