org.cloudfoundry.client.v3

Class Metadata.Builder

java.lang.Object

org.cloudfoundry.client.v3.Metadata.Builder

Enclosing class:

Metadata

public static final class Metadata.Builder
extends Object

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

Methods inherited from class java.lang.Object

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

Method Detail

from

public final Metadata.Builder from(Metadata instance)

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

annotation

public final Metadata.Builder annotation(String key,
                                         String value)

Put one entry to the annotations map.

Parameters:

key - The key in the annotations map

value - The associated value in the annotations map

Returns:

this builder for use in a chained invocation

annotation

public final Metadata.Builder annotation(Map.Entry<String,? extends String> entry)

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

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

annotations

public final Metadata.Builder annotations(Map<String,? extends String> entries)

Sets or replaces all mappings from the specified map as entries for the annotations map. Nulls are not permitted as keys or values, but parameter itself can be null

Parameters:

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

Returns:

this builder for use in a chained invocation

putAllAnnotations

public final Metadata.Builder putAllAnnotations(Map<String,? extends String> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

label

public final Metadata.Builder label(String key,
                                    String value)

Put one entry to the labels map.

Parameters:

key - The key in the labels map

value - The associated value in the labels map

Returns:

this builder for use in a chained invocation

label

public final Metadata.Builder label(Map.Entry<String,? extends String> entry)

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

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

labels

public final Metadata.Builder labels(Map<String,? extends String> entries)

Sets or replaces all mappings from the specified map as entries for the labels map. Nulls are not permitted as keys or values, but parameter itself can be null

Parameters:

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

Returns:

this builder for use in a chained invocation

putAllLabels

public final Metadata.Builder putAllLabels(Map<String,? extends String> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

build

public Metadata build()

Builds a new Metadata.

Returns:

An immutable instance of Metadata

Throws:

IllegalStateException - if any required attributes are missing