org.cloudfoundry.logcache.v1

Class Envelope.Builder

java.lang.Object

org.cloudfoundry.logcache.v1.Envelope.Builder

Enclosing class:

Envelope

public static final class Envelope.Builder
extends Object

Builds instances of type Envelope. 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
Envelope	build() Builds a new Envelope.
Envelope.Builder	counter(Counter counter) Initializes the value for the counter attribute.
Envelope.Builder	event(Event event) Initializes the value for the event attribute.
Envelope.Builder	from(Envelope instance) Fill a builder with attribute values from the provided Envelope instance.
Envelope.Builder	gauge(Gauge gauge) Initializes the value for the gauge attribute.
Envelope.Builder	instanceId(String instanceId) Initializes the value for the instanceId attribute.
Envelope.Builder	log(Log log) Initializes the value for the log attribute.
Envelope.Builder	putAllTags(Map<String,? extends String> entries) Put all mappings from the specified map as entries to tags map.
Envelope.Builder	sourceId(String sourceId) Initializes the value for the sourceId attribute.
Envelope.Builder	tag(Map.Entry<String,? extends String> entry) Put one entry to the tags map.
Envelope.Builder	tag(String key, String value) Put one entry to the tags map.
Envelope.Builder	tags(Map<String,? extends String> entries) Sets or replaces all mappings from the specified map as entries for the tags map.
Envelope.Builder	timer(Timer timer) Initializes the value for the timer attribute.
Envelope.Builder	timestamp(Long timestamp) Initializes the value for the timestamp attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final Envelope.Builder from(Envelope instance)

Fill a builder with attribute values from the provided Envelope 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

counter

public final Envelope.Builder counter(Counter counter)

Initializes the value for the counter attribute.

Parameters:

counter - The value for counter (can be null)

Returns:

this builder for use in a chained invocation

event

public final Envelope.Builder event(Event event)

Initializes the value for the event attribute.

Parameters:

event - The value for event (can be null)

Returns:

this builder for use in a chained invocation

gauge

public final Envelope.Builder gauge(Gauge gauge)

Initializes the value for the gauge attribute.

Parameters:

gauge - The value for gauge (can be null)

Returns:

this builder for use in a chained invocation

instanceId

public final Envelope.Builder instanceId(String instanceId)

Initializes the value for the instanceId attribute.

Parameters:

instanceId - The value for instanceId (can be null)

Returns:

this builder for use in a chained invocation

log

public final Envelope.Builder log(Log log)

Initializes the value for the log attribute.

Parameters:

log - The value for log (can be null)

Returns:

this builder for use in a chained invocation

sourceId

public final Envelope.Builder sourceId(String sourceId)

Initializes the value for the sourceId attribute.

Parameters:

sourceId - The value for sourceId (can be null)

Returns:

this builder for use in a chained invocation

tag

public final Envelope.Builder tag(String key,
                                  String value)

Put one entry to the tags map.

Parameters:

key - The key in the tags map

value - The associated value in the tags map

Returns:

this builder for use in a chained invocation

tag

public final Envelope.Builder tag(Map.Entry<String,? extends String> entry)

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

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

tags

public final Envelope.Builder tags(Map<String,? extends String> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putAllTags

public final Envelope.Builder putAllTags(Map<String,? extends String> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

timer

public final Envelope.Builder timer(Timer timer)

Initializes the value for the timer attribute.

Parameters:

timer - The value for timer (can be null)

Returns:

this builder for use in a chained invocation

timestamp

public final Envelope.Builder timestamp(Long timestamp)

Initializes the value for the timestamp attribute.

Parameters:

timestamp - The value for timestamp (can be null)

Returns:

this builder for use in a chained invocation

build

public Envelope build()

Builds a new Envelope.

Returns:

An immutable instance of Envelope

Throws:

IllegalStateException - if any required attributes are missing