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

public Class MetadataBuilder

extends Object

Class Inheritance

java.lang.Object
org.eclipse.microprofile.metrics.MetadataBuilder

Imports

java.util.Objects

The Metadata builder. All values are considered "not present" by default. Name must be set before build() is called.

Field Summary

Modifier and Type	Field and Description
private String	description
private String	name
private String	unit

Constructor Summary

Access	Constructor and Description
pack-priv	MetadataBuilder(Metadata metadata)
public	MetadataBuilder()

Method Summary

Modifier and Type	Method and Description
public Metadata	Returns: An object implementing `Metadata` from the provided properties build()
public MetadataBuilder	Returns: the builder instance withDescription(String the name, empty string is considered as "not present" (null) description) Sets the description.
public MetadataBuilder	Returns: the builder instance withName(String the name name) Sets the name.
public MetadataBuilder	Returns: the builder instance withUnit(String the unit, `MetricUnits#NONE` is considered as "not present" (null) unit) Sets the unit.

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

Field Detail

description	back to summary
private String description

name	back to summary
private String name

unit	back to summary
private String unit

Constructor Detail

MetadataBuilder	back to summary
pack-priv MetadataBuilder(Metadata metadata)

MetadataBuilder	back to summary
public MetadataBuilder()

Method Detail

build	back to summary
public Metadata build() Returns:Metadata An object implementing `Metadata` from the provided properties Exceptions IllegalStateException: when either name is null

withDescription	back to summary
public MetadataBuilder withDescription(String description) Sets the description. Parameters description:String the name, empty string is considered as "not present" (null) Returns:MetadataBuilder the builder instance

withDescription

back to summary

public MetadataBuilder withDescription(String description)

Sets the description.

Parameters

description:String: the name, empty string is considered as "not present" (null)

Returns:MetadataBuilder

the builder instance

withName	back to summary
public MetadataBuilder withName(String name) Sets the name. Does not accept null. Parameters name:String the name Returns:MetadataBuilder the builder instance Exceptions NullPointerException: when name is null IllegalArgumentException: when name is empty

withName

back to summary

public MetadataBuilder withName(String name)

Sets the name. Does not accept null.

Parameters

name:String: the name

Returns:MetadataBuilder

the builder instance

Exceptions

NullPointerException:: when name is null
IllegalArgumentException:: when name is empty

withUnit back to summary

withUnit	back to summary
public MetadataBuilder withUnit(String unit) Sets the unit. Parameters unit:String the unit, `MetricUnits#NONE` is considered as "not present" (null) Returns:MetadataBuilder the builder instance

public MetadataBuilder withUnit(String unit)

Sets the unit.

Parameters

unit:String: the unit, MetricUnits#NONE is considered as "not present" (null)

Returns:MetadataBuilder

the builder instance