de.flapdoodle.embed.mongo.config

Class ImmutableMongoShellConfig.Builder

java.lang.Object

de.flapdoodle.embed.mongo.config.ImmutableMongoShellConfig.Builder

Enclosing class:

ImmutableMongoShellConfig

public static final class ImmutableMongoShellConfig.Builder
extends Object

Builds instances of type ImmutableMongoShellConfig. 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
ImmutableMongoShellConfig.Builder	addAllScriptParameters(Iterable<String> elements) Adds elements to scriptParameters list.
ImmutableMongoShellConfig.Builder	addScriptParameters(String... elements) Adds elements to scriptParameters list.
ImmutableMongoShellConfig.Builder	addScriptParameters(String element) Adds one element to scriptParameters list.
ImmutableMongoShellConfig	build() Builds a new ImmutableMongoShellConfig.
ImmutableMongoShellConfig.Builder	cmdOptions(MongoCmdOptions cmdOptions) Initializes the value for the cmdOptions attribute.
ImmutableMongoShellConfig.Builder	dbName(String dbName) Initializes the value for the dbName attribute.
ImmutableMongoShellConfig.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.
ImmutableMongoShellConfig.Builder	from(MongoCommonConfig instance) Fill a builder with attribute values from the provided de.flapdoodle.embed.mongo.config.MongoCommonConfig instance.
ImmutableMongoShellConfig.Builder	from(MongoShellConfig instance) Fill a builder with attribute values from the provided de.flapdoodle.embed.mongo.config.MongoShellConfig instance.
ImmutableMongoShellConfig.Builder	net(Net net) Initializes the value for the net attribute.
ImmutableMongoShellConfig.Builder	password(String password) Initializes the value for the password attribute.
ImmutableMongoShellConfig.Builder	pidFile(String pidFile) Initializes the value for the pidFile attribute.
ImmutableMongoShellConfig.Builder	scriptName(String scriptName) Initializes the value for the scriptName attribute.
ImmutableMongoShellConfig.Builder	scriptParameters(Iterable<String> elements) Sets or replaces all elements for scriptParameters list.
ImmutableMongoShellConfig.Builder	stopTimeoutInMillis(long stopTimeoutInMillis) Initializes the optional value stopTimeoutInMillis to stopTimeoutInMillis.
ImmutableMongoShellConfig.Builder	stopTimeoutInMillis(OptionalLong stopTimeoutInMillis) Initializes the optional value stopTimeoutInMillis to stopTimeoutInMillis.
ImmutableMongoShellConfig.Builder	supportConfig(de.flapdoodle.embed.process.config.SupportConfig supportConfig) Initializes the value for the supportConfig attribute.
ImmutableMongoShellConfig.Builder	timeout(Timeout timeout) Initializes the value for the timeout attribute.
ImmutableMongoShellConfig.Builder	userName(String userName) Initializes the value for the userName attribute.
ImmutableMongoShellConfig.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 ImmutableMongoShellConfig.Builder from(MongoShellConfig instance)

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

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

from

public final ImmutableMongoShellConfig.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 ImmutableMongoShellConfig.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 ImmutableMongoShellConfig.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 ImmutableMongoShellConfig.Builder stopTimeoutInMillis(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 ImmutableMongoShellConfig.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 ImmutableMongoShellConfig.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 ImmutableMongoShellConfig.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 ImmutableMongoShellConfig.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 ImmutableMongoShellConfig.Builder password(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 ImmutableMongoShellConfig.Builder userName(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

addScriptParameters

public final ImmutableMongoShellConfig.Builder addScriptParameters(String element)

Adds one element to scriptParameters list.

Parameters:

element - A scriptParameters element

Returns:

this builder for use in a chained invocation

addScriptParameters

public final ImmutableMongoShellConfig.Builder addScriptParameters(String... elements)

Adds elements to scriptParameters list.

Parameters:

elements - An array of scriptParameters elements

Returns:

this builder for use in a chained invocation

scriptParameters

public final ImmutableMongoShellConfig.Builder scriptParameters(Iterable<String> elements)

Sets or replaces all elements for scriptParameters list.

Parameters:

elements - An iterable of scriptParameters elements

Returns:

this builder for use in a chained invocation

addAllScriptParameters

public final ImmutableMongoShellConfig.Builder addAllScriptParameters(Iterable<String> elements)

Adds elements to scriptParameters list.

Parameters:

elements - An iterable of scriptParameters elements

Returns:

this builder for use in a chained invocation

scriptName

public final ImmutableMongoShellConfig.Builder scriptName(String scriptName)

Initializes the value for the scriptName attribute.

Parameters:

scriptName - The value for scriptName

Returns:

this builder for use in a chained invocation

dbName

public final ImmutableMongoShellConfig.Builder dbName(String dbName)

Initializes the value for the dbName attribute.

Parameters:

dbName - The value for dbName

Returns:

this builder for use in a chained invocation

pidFile

public final ImmutableMongoShellConfig.Builder pidFile(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 ImmutableMongoShellConfig.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 ImmutableMongoShellConfig build()

Builds a new ImmutableMongoShellConfig.

Returns:

An immutable instance of MongoShellConfig

Throws:

IllegalStateException - if any required attributes are missing