org.cloudfoundry.client.v2.serviceplans

Class Parameters.Builder

java.lang.Object

org.cloudfoundry.client.v2.serviceplans.Parameters.Builder

Enclosing class:

Parameters

public static final class Parameters.Builder
extends Object

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

Methods inherited from class java.lang.Object

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

Method Detail

from

public final Parameters.Builder from(Parameters instance)

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

jsonSchema

public final Parameters.Builder jsonSchema(String jsonSchema)

Initializes the value for the jsonSchema attribute.

Parameters:

jsonSchema - The value for jsonSchema (can be null)

Returns:

this builder for use in a chained invocation

type

public final Parameters.Builder type(String type)

Initializes the value for the type attribute.

Parameters:

type - The value for type (can be null)

Returns:

this builder for use in a chained invocation

property

public final Parameters.Builder property(String key,
                                         Object value)

Put one entry to the properties map.

Parameters:

key - The key in the properties map

value - The associated value in the properties map

Returns:

this builder for use in a chained invocation

property

public final Parameters.Builder property(Map.Entry<String,? extends Object> entry)

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

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

properties

public final Parameters.Builder properties(Map<String,? extends Object> entries)

Sets or replaces all mappings from the specified map as entries for the properties 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 properties map

Returns:

this builder for use in a chained invocation

putAllProperties

public final Parameters.Builder putAllProperties(Map<String,? extends Object> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

build

public Parameters build()

Builds a new Parameters.

Returns:

An immutable instance of Parameters

Throws:

IllegalStateException - if any required attributes are missing