org.cloudfoundry.logcache.v1

Class Gauge.Builder

java.lang.Object

org.cloudfoundry.logcache.v1.Gauge.Builder

Enclosing class:

Gauge

public static final class Gauge.Builder
extends Object

Builds instances of type Gauge. 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
Gauge	build() Builds a new Gauge.
Gauge.Builder	from(Gauge instance) Fill a builder with attribute values from the provided Gauge instance.
Gauge.Builder	metric(Map.Entry<String,? extends Metric> entry) Put one entry to the metrics map.
Gauge.Builder	metric(String key, Metric value) Put one entry to the metrics map.
Gauge.Builder	metrics(Map<String,? extends Metric> entries) Sets or replaces all mappings from the specified map as entries for the metrics map.
Gauge.Builder	putAllMetrics(Map<String,? extends Metric> entries) Put all mappings from the specified map as entries to metrics map.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final Gauge.Builder from(Gauge instance)

Fill a builder with attribute values from the provided Gauge instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

metric

public final Gauge.Builder metric(String key,
                                  Metric value)

Put one entry to the metrics map.

Parameters:

key - The key in the metrics map

value - The associated value in the metrics map

Returns:

this builder for use in a chained invocation

metric

public final Gauge.Builder metric(Map.Entry<String,? extends Metric> entry)

Put one entry to the metrics map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

metrics

public final Gauge.Builder metrics(Map<String,? extends Metric> entries)

Sets or replaces all mappings from the specified map as entries for the metrics map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the metrics map

Returns:

this builder for use in a chained invocation

putAllMetrics

public final Gauge.Builder putAllMetrics(Map<String,? extends Metric> entries)

Put all mappings from the specified map as entries to metrics map. Nulls are not permitted

Parameters:

entries - The entries that will be added to the metrics map

Returns:

this builder for use in a chained invocation

build

public Gauge build()

Builds a new Gauge.

Returns:

An immutable instance of Gauge

Throws:

IllegalStateException - if any required attributes are missing