com.ibm.cos.v2.core.client.config

Class SdkClientConfiguration.Builder

java.lang.Object

com.ibm.cos.v2.core.client.config.SdkClientConfiguration.Builder

All Implemented Interfaces:

Buildable, CopyableBuilder<SdkClientConfiguration.Builder,SdkClientConfiguration>, SdkBuilder<SdkClientConfiguration.Builder,SdkClientConfiguration>

Enclosing class:

SdkClientConfiguration

public static final class SdkClientConfiguration.Builder
extends Object
implements CopyableBuilder<SdkClientConfiguration.Builder,SdkClientConfiguration>

Method Summary

Modifier and Type	Method and Description
ClientOverrideConfiguration.Builder	asOverrideConfigurationBuilder() Create a ClientOverrideConfiguration.Builder using the values currently in this builder.
SdkClientConfiguration	build() An immutable object that is created from the properties that have been set on the builder.
<T> T	computeOptionIfAbsent(ClientOption<T> option, Supplier<T> valueSupplier) Add a mapping between the provided key and value, if the current value for the option is null.
SdkClientConfiguration.Builder	copy() A shallow copy of this object created by building an immutable T and then transforming it back to a builder.
<T> SdkClientConfiguration.Builder	lazyOption(ClientOption<T> option, AttributeMap.LazyValue<T> lazyValue) Add a mapping between the provided option and value provider.
<T> SdkClientConfiguration.Builder	lazyOptionIfAbsent(ClientOption<T> option, AttributeMap.LazyValue<T> lazyValue) Equivalent to lazyOption(ClientOption, AttributeMap.LazyValue), but does not assign the value if there is already a non-null value assigned for the provided option.
<T> T	option(ClientOption<T> option) Retrieve the value of a specific option.
<T> SdkClientConfiguration.Builder	option(ClientOption<T> option, T value) Configure the value of a specific option.
SdkClientConfiguration.Builder	putAll(ClientOverrideConfiguration configuration) Put all of the attributes from the provided override configuration into this one.
SdkClientConfiguration.Builder	putAll(Map<? extends ClientOption<?>,?> options) Adds all the options from the map provided.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.cos.v2.utils.builder.SdkBuilder

applyMutation

Method Detail

asOverrideConfigurationBuilder

public ClientOverrideConfiguration.Builder asOverrideConfigurationBuilder()

Create a ClientOverrideConfiguration.Builder using the values currently in this builder.

option

public <T> SdkClientConfiguration.Builder option(ClientOption<T> option,
                                                 T value)

Configure the value of a specific option.

lazyOption

public <T> SdkClientConfiguration.Builder lazyOption(ClientOption<T> option,
                                                     AttributeMap.LazyValue<T> lazyValue)

Add a mapping between the provided option and value provider. The lazy value will only be resolved when the value is needed. During resolution, the lazy value is provided with a value reader. The value reader will fail if the reader attempts to read its own value (directly, or indirectly through other lazy values). If a value is updated that a lazy value is depended on, the lazy value will be re-resolved the next time the lazy value is accessed.

lazyOptionIfAbsent

public <T> SdkClientConfiguration.Builder lazyOptionIfAbsent(ClientOption<T> option,
                                                             AttributeMap.LazyValue<T> lazyValue)

Equivalent to lazyOption(ClientOption, AttributeMap.LazyValue), but does not assign the value if there is already a non-null value assigned for the provided option.

option

public <T> T option(ClientOption<T> option)

Retrieve the value of a specific option.

computeOptionIfAbsent

public <T> T computeOptionIfAbsent(ClientOption<T> option,
                                   Supplier<T> valueSupplier)

Add a mapping between the provided key and value, if the current value for the option is null. Returns the value.

putAll

public SdkClientConfiguration.Builder putAll(Map<? extends ClientOption<?>,?> options)

Adds all the options from the map provided. This is not type safe, and will throw an exception during creation if a value in the map is not of the correct type for its option.

putAll

public SdkClientConfiguration.Builder putAll(ClientOverrideConfiguration configuration)

Put all of the attributes from the provided override configuration into this one.

copy

public SdkClientConfiguration.Builder copy()

Description copied from interface: CopyableBuilder

A shallow copy of this object created by building an immutable T and then transforming it back to a builder.

Specified by:

copy in interface CopyableBuilder<SdkClientConfiguration.Builder,SdkClientConfiguration>

Returns:

a copy of this object

build

public SdkClientConfiguration build()

Description copied from interface: SdkBuilder

An immutable object that is created from the properties that have been set on the builder.

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<SdkClientConfiguration.Builder,SdkClientConfiguration>

Returns:

an instance of T