org.opendaylight.infrautils.metrics

Class ImmutableMetricDescriptor.Builder

java.lang.Object

org.opendaylight.infrautils.metrics.ImmutableMetricDescriptor.Builder

All Implemented Interfaces:

ImmutableMetricDescriptor.AnchorBuildStage, ImmutableMetricDescriptor.BuildFinal, ImmutableMetricDescriptor.IdBuildStage, ImmutableMetricDescriptor.ModuleBuildStage, ImmutableMetricDescriptor.ProjectBuildStage

Enclosing class:

ImmutableMetricDescriptor

@NotThreadSafe
public static final class ImmutableMetricDescriptor.Builder
extends Object
implements ImmutableMetricDescriptor.AnchorBuildStage, ImmutableMetricDescriptor.ProjectBuildStage, ImmutableMetricDescriptor.ModuleBuildStage, ImmutableMetricDescriptor.IdBuildStage, ImmutableMetricDescriptor.BuildFinal

Builds instances of type ImmutableMetricDescriptor. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method and Description
ImmutableMetricDescriptor.Builder	anchor(Object anchor) Initializes the value for the anchor attribute.
ImmutableMetricDescriptor	build() Builds a new ImmutableMetricDescriptor.
ImmutableMetricDescriptor.Builder	description(String description) Initializes the value for the description attribute.
ImmutableMetricDescriptor.Builder	id(String id) Initializes the value for the id attribute.
ImmutableMetricDescriptor.Builder	module(String module) Initializes the value for the module attribute.
ImmutableMetricDescriptor.Builder	project(String project) Initializes the value for the project attribute.

Methods inherited from class java.lang.Object

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

Method Detail

anchor

@CanIgnoreReturnValue
public final ImmutableMetricDescriptor.Builder anchor(Object anchor)

Initializes the value for the anchor attribute.

Specified by:

anchor in interface ImmutableMetricDescriptor.AnchorBuildStage

Parameters:

anchor - The value for anchor

Returns:

this builder for use in a chained invocation

project

@CanIgnoreReturnValue
public final ImmutableMetricDescriptor.Builder project(String project)

Initializes the value for the project attribute.

Specified by:

project in interface ImmutableMetricDescriptor.ProjectBuildStage

Parameters:

project - The value for project

Returns:

this builder for use in a chained invocation

module

@CanIgnoreReturnValue
public final ImmutableMetricDescriptor.Builder module(String module)

Initializes the value for the module attribute.

Specified by:

module in interface ImmutableMetricDescriptor.ModuleBuildStage

Parameters:

module - The value for module

Returns:

this builder for use in a chained invocation

id

@CanIgnoreReturnValue
public final ImmutableMetricDescriptor.Builder id(String id)

Initializes the value for the id attribute.

Specified by:

id in interface ImmutableMetricDescriptor.IdBuildStage

Parameters:

id - The value for id

Returns:

this builder for use in a chained invocation

description

@CanIgnoreReturnValue
public final ImmutableMetricDescriptor.Builder description(String description)

Initializes the value for the description attribute.

If not set, this attribute will have a default value as returned by the initializer of description.

Specified by:

description in interface ImmutableMetricDescriptor.BuildFinal

Parameters:

description - The value for description

Returns:

this builder for use in a chained invocation

build

public ImmutableMetricDescriptor build()

Builds a new ImmutableMetricDescriptor.

Specified by:

build in interface ImmutableMetricDescriptor.BuildFinal

Returns:

An immutable instance of MetricDescriptor

Throws:

IllegalStateException - if any required attributes are missing