de.flapdoodle.embed.mongo.config

Class ImmutableMongodConfig.Builder

java.lang.Object

de.flapdoodle.embed.mongo.config.ImmutableMongodConfig.Builder

Enclosing class:

ImmutableMongodConfig

public static final class ImmutableMongodConfig.Builder
extends java.lang.Object

Builds instances of type ImmutableMongodConfig. 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
ImmutableMongodConfig.Builder	args(java.util.Map<java.lang.String,? extends java.lang.String> entries) Sets or replaces all mappings from the specified map as entries for the args map.
ImmutableMongodConfig	build() Builds a new ImmutableMongodConfig.
ImmutableMongodConfig.Builder	cmdOptions(MongoCmdOptions cmdOptions) Initializes the value for the cmdOptions attribute.
ImmutableMongodConfig.Builder	from(de.flapdoodle.embed.process.config.ExecutableProcessConfig instance) Fill a builder with attribute values from the provided de.flapdoodle.embed.process.config.ExecutableProcessConfig instance.
ImmutableMongodConfig.Builder	from(MongoCommonConfig instance) Fill a builder with attribute values from the provided de.flapdoodle.embed.mongo.config.MongoCommonConfig instance.
ImmutableMongodConfig.Builder	from(MongodConfig instance) Fill a builder with attribute values from the provided de.flapdoodle.embed.mongo.config.MongodConfig instance.
ImmutableMongodConfig.Builder	isConfigServer(boolean isConfigServer) Initializes the value for the isConfigServer attribute.
ImmutableMongodConfig.Builder	isShardServer(boolean isShardServer) Initializes the value for the isShardServer attribute.
ImmutableMongodConfig.Builder	net(Net net) Initializes the value for the net attribute.
ImmutableMongodConfig.Builder	params(java.util.Map<java.lang.String,? extends java.lang.String> entries) Sets or replaces all mappings from the specified map as entries for the params map.
ImmutableMongodConfig.Builder	password(java.lang.String password) Initializes the value for the password attribute.
ImmutableMongodConfig.Builder	pidFile(java.lang.String pidFile) Initializes the value for the pidFile attribute.
ImmutableMongodConfig.Builder	processListener(IMongoProcessListener processListener) Initializes the value for the processListener attribute.
ImmutableMongodConfig.Builder	putAllArgs(java.util.Map<java.lang.String,? extends java.lang.String> entries) Put all mappings from the specified map as entries to args map.
ImmutableMongodConfig.Builder	putAllParams(java.util.Map<java.lang.String,? extends java.lang.String> entries) Put all mappings from the specified map as entries to params map.
ImmutableMongodConfig.Builder	putArgs(java.util.Map.Entry<java.lang.String,? extends java.lang.String> entry) Put one entry to the args map.
ImmutableMongodConfig.Builder	putArgs(java.lang.String key, java.lang.String value) Put one entry to the args map.
ImmutableMongodConfig.Builder	putParams(java.util.Map.Entry<java.lang.String,? extends java.lang.String> entry) Put one entry to the params map.
ImmutableMongodConfig.Builder	putParams(java.lang.String key, java.lang.String value) Put one entry to the params map.
ImmutableMongodConfig.Builder	replication(Storage replication) Initializes the value for the replication attribute.
ImmutableMongodConfig.Builder	stopTimeoutInMillis(long stopTimeoutInMillis) Initializes the optional value stopTimeoutInMillis to stopTimeoutInMillis.
ImmutableMongodConfig.Builder	stopTimeoutInMillis(java.util.OptionalLong stopTimeoutInMillis) Initializes the optional value stopTimeoutInMillis to stopTimeoutInMillis.
ImmutableMongodConfig.Builder	supportConfig(de.flapdoodle.embed.process.config.SupportConfig supportConfig) Initializes the value for the supportConfig attribute.
ImmutableMongodConfig.Builder	timeout(Timeout timeout) Initializes the value for the timeout attribute.
ImmutableMongodConfig.Builder	userName(java.lang.String userName) Initializes the value for the userName attribute.
ImmutableMongodConfig.Builder	version(IFeatureAwareVersion version) Initializes the value for the version attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final ImmutableMongodConfig.Builder from(MongodConfig instance)

Fill a builder with attribute values from the provided de.flapdoodle.embed.mongo.config.MongodConfig instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final ImmutableMongodConfig.Builder from(MongoCommonConfig instance)

Fill a builder with attribute values from the provided de.flapdoodle.embed.mongo.config.MongoCommonConfig instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final ImmutableMongodConfig.Builder from(de.flapdoodle.embed.process.config.ExecutableProcessConfig instance)

Fill a builder with attribute values from the provided de.flapdoodle.embed.process.config.ExecutableProcessConfig instance.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

stopTimeoutInMillis

public final ImmutableMongodConfig.Builder stopTimeoutInMillis(long stopTimeoutInMillis)

Initializes the optional value stopTimeoutInMillis to stopTimeoutInMillis.

Parameters:

stopTimeoutInMillis - The value for stopTimeoutInMillis

Returns:

this builder for chained invocation

stopTimeoutInMillis

public final ImmutableMongodConfig.Builder stopTimeoutInMillis(java.util.OptionalLong stopTimeoutInMillis)

Initializes the optional value stopTimeoutInMillis to stopTimeoutInMillis.

Parameters:

stopTimeoutInMillis - The value for stopTimeoutInMillis

Returns:

this builder for use in a chained invocation

version

public final ImmutableMongodConfig.Builder version(IFeatureAwareVersion version)

Initializes the value for the version attribute.

Parameters:

version - The value for version

Returns:

this builder for use in a chained invocation

timeout

public final ImmutableMongodConfig.Builder timeout(Timeout timeout)

Initializes the value for the timeout attribute.

If not set, this attribute will have a default value as returned by the initializer of timeout.

Parameters:

timeout - The value for timeout

Returns:

this builder for use in a chained invocation

net

public final ImmutableMongodConfig.Builder net(Net net)

Initializes the value for the net attribute.

If not set, this attribute will have a default value as returned by the initializer of net.

Parameters:

net - The value for net

Returns:

this builder for use in a chained invocation

cmdOptions

public final ImmutableMongodConfig.Builder cmdOptions(MongoCmdOptions cmdOptions)

Initializes the value for the cmdOptions attribute.

If not set, this attribute will have a default value as returned by the initializer of cmdOptions.

Parameters:

cmdOptions - The value for cmdOptions

Returns:

this builder for use in a chained invocation

password

public final ImmutableMongodConfig.Builder password(java.lang.String password)

Initializes the value for the password attribute.

If not set, this attribute will have a default value as returned by the initializer of password.

Parameters:

password - The value for password

Returns:

this builder for use in a chained invocation

userName

public final ImmutableMongodConfig.Builder userName(java.lang.String userName)

Initializes the value for the userName attribute.

If not set, this attribute will have a default value as returned by the initializer of userName.

Parameters:

userName - The value for userName

Returns:

this builder for use in a chained invocation

replication

public final ImmutableMongodConfig.Builder replication(Storage replication)

Initializes the value for the replication attribute.

If not set, this attribute will have a default value as returned by the initializer of replication.

Parameters:

replication - The value for replication

Returns:

this builder for use in a chained invocation

isConfigServer

public final ImmutableMongodConfig.Builder isConfigServer(boolean isConfigServer)

Initializes the value for the isConfigServer attribute.

If not set, this attribute will have a default value as returned by the initializer of isConfigServer.

Parameters:

isConfigServer - The value for isConfigServer

Returns:

this builder for use in a chained invocation

isShardServer

public final ImmutableMongodConfig.Builder isShardServer(boolean isShardServer)

Initializes the value for the isShardServer attribute.

If not set, this attribute will have a default value as returned by the initializer of isShardServer.

Parameters:

isShardServer - The value for isShardServer

Returns:

this builder for use in a chained invocation

processListener

public final ImmutableMongodConfig.Builder processListener(IMongoProcessListener processListener)

Initializes the value for the processListener attribute.

If not set, this attribute will have a default value as returned by the initializer of processListener.

Parameters:

processListener - The value for processListener

Returns:

this builder for use in a chained invocation

putParams

public final ImmutableMongodConfig.Builder putParams(java.lang.String key,
                                                     java.lang.String value)

Put one entry to the params map.

Parameters:

key - The key in the params map

value - The associated value in the params map

Returns:

this builder for use in a chained invocation

putParams

public final ImmutableMongodConfig.Builder putParams(java.util.Map.Entry<java.lang.String,? extends java.lang.String> entry)

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

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

params

public final ImmutableMongodConfig.Builder params(java.util.Map<java.lang.String,? extends java.lang.String> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putAllParams

public final ImmutableMongodConfig.Builder putAllParams(java.util.Map<java.lang.String,? extends java.lang.String> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putArgs

public final ImmutableMongodConfig.Builder putArgs(java.lang.String key,
                                                   java.lang.String value)

Put one entry to the args map.

Parameters:

key - The key in the args map

value - The associated value in the args map

Returns:

this builder for use in a chained invocation

putArgs

public final ImmutableMongodConfig.Builder putArgs(java.util.Map.Entry<java.lang.String,? extends java.lang.String> entry)

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

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

args

public final ImmutableMongodConfig.Builder args(java.util.Map<java.lang.String,? extends java.lang.String> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

putAllArgs

public final ImmutableMongodConfig.Builder putAllArgs(java.util.Map<java.lang.String,? extends java.lang.String> entries)

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

Parameters:

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

Returns:

this builder for use in a chained invocation

pidFile

public final ImmutableMongodConfig.Builder pidFile(java.lang.String pidFile)

Initializes the value for the pidFile attribute.

If not set, this attribute will have a default value as returned by the initializer of pidFile.

Parameters:

pidFile - The value for pidFile

Returns:

this builder for use in a chained invocation

supportConfig

public final ImmutableMongodConfig.Builder supportConfig(de.flapdoodle.embed.process.config.SupportConfig supportConfig)

Initializes the value for the supportConfig attribute.

If not set, this attribute will have a default value as returned by the initializer of supportConfig.

Parameters:

supportConfig - The value for supportConfig

Returns:

this builder for use in a chained invocation

build

public ImmutableMongodConfig build()

Builds a new ImmutableMongodConfig.

Returns:

An immutable instance of MongodConfig

Throws:

java.lang.IllegalStateException - if any required attributes are missing