Package org.eclipse.microprofile.metrics

Class MetadataBuilder

java.lang.Object

org.eclipse.microprofile.metrics.MetadataBuilder

public class MetadataBuilder
extends java.lang.Object

The Metadata builder. This builder has a default value: type as MetricType.INVALID unit as MetricUnits.NONE reusable as Boolean.FALSE

Constructor Summary

Constructors

Constructor	Description
MetadataBuilder()

Method Summary

Modifier and Type	Method	Description
Metadata	build()
MetadataBuilder	notReusable()	Sets the reusability flag to Boolean.FALSE
MetadataBuilder	reusable()	Sets the reusability flag to Boolean.TRUE
MetadataBuilder	reusable(boolean value)	Sets the reusability flag to the desired boolean value
MetadataBuilder	withDescription(java.lang.String description)	Sets the description.
MetadataBuilder	withDisplayName(java.lang.String displayName)	Sets the displayName.
MetadataBuilder	withName(java.lang.String name)	Sets the name.
MetadataBuilder	withOptionalDescription(java.lang.String description)	Sets the description.
MetadataBuilder	withOptionalDisplayName(java.lang.String displayName)	Sets the displayName.
MetadataBuilder	withOptionalType(MetricType type)	Sets the type.
MetadataBuilder	withOptionalUnit(java.lang.String unit)	Sets the unit.
MetadataBuilder	withType(MetricType type)	Sets the type.
MetadataBuilder	withUnit(java.lang.String unit)	Sets the unit.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataBuilder

public MetadataBuilder()

Method Detail

withName

public MetadataBuilder withName(java.lang.String name)

Sets the name. Does not accept null.

Parameters:

name - the name

Returns:

the builder instance

Throws:

java.lang.NullPointerException - when name is null

withDisplayName

public MetadataBuilder withDisplayName(java.lang.String displayName)

Sets the displayName. Does not accept null.

Parameters:

displayName - the displayName

Returns:

the builder instance

Throws:

java.lang.NullPointerException - when displayName is null

withOptionalDisplayName

public MetadataBuilder withOptionalDisplayName(java.lang.String displayName)

Sets the displayName. Does accept null.

Parameters:

displayName - the displayName

Returns:

the builder instance

withDescription

public MetadataBuilder withDescription(java.lang.String description)

Sets the description. Does not accept null.

Parameters:

description - the name

Returns:

the builder instance

Throws:

java.lang.NullPointerException - when description is null

withOptionalDescription

public MetadataBuilder withOptionalDescription(java.lang.String description)

Sets the description. Does accept null.

Parameters:

description - the name

Returns:

the builder instance

withType

public MetadataBuilder withType(MetricType type)

Sets the type. Does not accept null.

Parameters:

type - the type

Returns:

the builder instance

Throws:

java.lang.NullPointerException - when type is null

withOptionalType

public MetadataBuilder withOptionalType(MetricType type)

Sets the type. Does accept null.

Parameters:

type - the type

Returns:

the builder instance

withUnit

public MetadataBuilder withUnit(java.lang.String unit)

Sets the unit. Does not accept null.

Parameters:

unit - the unit

Returns:

the builder instance

Throws:

java.lang.NullPointerException - when unit is null

withOptionalUnit

public MetadataBuilder withOptionalUnit(java.lang.String unit)

Sets the unit. Does accept null.

Parameters:

unit - the unit

Returns:

the builder instance

reusable

public MetadataBuilder reusable()

Sets the reusability flag to Boolean.TRUE

Returns:

the builder instance

reusable

public MetadataBuilder reusable(boolean value)

Sets the reusability flag to the desired boolean value

Parameters:

value - the value of the reusability flag

Returns:

the builder instance

notReusable

public MetadataBuilder notReusable()

Sets the reusability flag to Boolean.FALSE

Returns:

the builder instance

build

public Metadata build()

Returns:

An object implementing Metadata from the provided properties

Throws:

java.lang.IllegalStateException - when either name is null