org.cloudfoundry.logcache.v1

Class Metric.Builder

java.lang.Object

org.cloudfoundry.logcache.v1.Metric.Builder

Enclosing class:

Metric

public static final class Metric.Builder
extends Object

Builds instances of type Metric. 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
Metric	build() Builds a new Metric.
Metric.Builder	from(Metric instance) Fill a builder with attribute values from the provided Metric instance.
Metric.Builder	unit(String unit) Initializes the value for the unit attribute.
Metric.Builder	value(Double value) Initializes the value for the value attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final Metric.Builder from(Metric instance)

Fill a builder with attribute values from the provided Metric instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

unit

public final Metric.Builder unit(String unit)

Initializes the value for the unit attribute.

Parameters:

unit - The value for unit (can be null)

Returns:

this builder for use in a chained invocation

value

public final Metric.Builder value(Double value)

Initializes the value for the value attribute.

Parameters:

value - The value for value (can be null)

Returns:

this builder for use in a chained invocation

build

public Metric build()

Builds a new Metric.

Returns:

An immutable instance of Metric

Throws:

IllegalStateException - if any required attributes are missing