ImmutableMongodConfig (Flapdoodle Embedded MongoDB 3.2.0 API)

java.lang.Object
- de.flapdoodle.embed.mongo.config.ImmutableMongodConfig

All Implemented Interfaces:

MongoCommonConfig, MongodConfig, de.flapdoodle.embed.process.config.ExecutableProcessConfig
```
public final class ImmutableMongodConfig
extends Object
implements MongodConfig
```
Immutable implementation of MongodConfig.
Use the builder to create immutable instances: ImmutableMongodConfig.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableMongodConfig.Builder
Builds instances of type ImmutableMongodConfig.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImmutableMongodConfig.Builder` Builds instances of type `ImmutableMongodConfig`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,String>`	`args()`
`static ImmutableMongodConfig.Builder`	`builder()` Creates a builder for `ImmutableMongodConfig`.
`MongoCmdOptions`	`cmdOptions()`
`static ImmutableMongodConfig`	`copyOf(MongodConfig instance)` Creates an immutable copy of a `MongodConfig` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableMongodConfig` that have equal attribute values.
`int`	`hashCode()` Computes a hash code from attributes: `stopTimeoutInMillis`, `version`, `timeout`, `net`, `cmdOptions`, `password`, `userName`, `replication`, `isConfigServer`, `isShardServer`, `processListener`, `params`, `args`, `pidFile`, `supportConfig`.
`boolean`	`isConfigServer()`
`boolean`	`isShardServer()`
`Net`	`net()`
`Map<String,String>`	`params()`
`String`	`password()`
`String`	`pidFile()`
`IMongoProcessListener`	`processListener()`
`Storage`	`replication()`
`OptionalLong`	`stopTimeoutInMillis()`
`de.flapdoodle.embed.process.config.SupportConfig`	`supportConfig()`
`Timeout`	`timeout()`
`String`	`toString()` Prints the immutable value `MongodConfig` with attribute values.
`String`	`userName()`
`IFeatureAwareVersion`	`version()`
`ImmutableMongodConfig`	`withArgs(Map<String,? extends String> entries)` Copy the current immutable object by replacing the `args` map with the specified map.
`ImmutableMongodConfig`	`withCmdOptions(MongoCmdOptions value)` Copy the current immutable object by setting a value for the `cmdOptions` attribute.
`ImmutableMongodConfig`	`withIsConfigServer(boolean value)` Copy the current immutable object by setting a value for the `isConfigServer` attribute.
`ImmutableMongodConfig`	`withIsShardServer(boolean value)` Copy the current immutable object by setting a value for the `isShardServer` attribute.
`ImmutableMongodConfig`	`withNet(Net value)` Copy the current immutable object by setting a value for the `net` attribute.
`ImmutableMongodConfig`	`withParams(Map<String,? extends String> entries)` Copy the current immutable object by replacing the `params` map with the specified map.
`ImmutableMongodConfig`	`withPassword(String value)` Copy the current immutable object by setting a value for the `password` attribute.
`ImmutableMongodConfig`	`withPidFile(String value)` Copy the current immutable object by setting a value for the `pidFile` attribute.
`ImmutableMongodConfig`	`withProcessListener(IMongoProcessListener value)` Copy the current immutable object by setting a value for the `processListener` attribute.
`ImmutableMongodConfig`	`withReplication(Storage value)` Copy the current immutable object by setting a value for the `replication` attribute.
`ImmutableMongodConfig`	`withStopTimeoutInMillis(long value)` Copy the current immutable object by setting a present value for the optional `stopTimeoutInMillis` attribute.
`ImmutableMongodConfig`	`withStopTimeoutInMillis(OptionalLong optional)` Copy the current immutable object by setting an optional value for the `stopTimeoutInMillis` attribute.
`ImmutableMongodConfig`	`withSupportConfig(de.flapdoodle.embed.process.config.SupportConfig value)` Copy the current immutable object by setting a value for the `supportConfig` attribute.
`ImmutableMongodConfig`	`withTimeout(Timeout value)` Copy the current immutable object by setting a value for the `timeout` attribute.
`ImmutableMongodConfig`	`withUserName(String value)` Copy the current immutable object by setting a value for the `userName` attribute.
`ImmutableMongodConfig`	`withVersion(IFeatureAwareVersion value)` Copy the current immutable object by setting a value for the `version` attribute.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - stopTimeoutInMillis
```
public OptionalLong stopTimeoutInMillis()
```
    Specified by:
    
    stopTimeoutInMillis in interface de.flapdoodle.embed.process.config.ExecutableProcessConfig
    
    Returns:
    
    The value of the stopTimeoutInMillis attribute
  - version
```
public IFeatureAwareVersion version()
```
    Specified by:
    
    version in interface MongoCommonConfig
    
    Specified by:
    
    version in interface de.flapdoodle.embed.process.config.ExecutableProcessConfig
    
    Returns:
    
    The value of the version attribute
  - timeout
```
public Timeout timeout()
```
    Specified by:
    
    timeout in interface MongoCommonConfig
    
    Returns:
    
    The value of the timeout attribute
  - net
```
public Net net()
```
    Specified by:
    
    net in interface MongoCommonConfig
    
    Returns:
    
    The value of the net attribute
  - cmdOptions
```
public MongoCmdOptions cmdOptions()
```
    Specified by:
    
    cmdOptions in interface MongoCommonConfig
    
    Returns:
    
    The value of the cmdOptions attribute
  - password
```
public String password()
```
    Specified by:
    
    password in interface MongoCommonConfig
    
    Returns:
    
    The value of the password attribute
  - userName
```
public String userName()
```
    Specified by:
    
    userName in interface MongoCommonConfig
    
    Returns:
    
    The value of the userName attribute
  - replication
```
public Storage replication()
```
    Specified by:
    
    replication in interface MongodConfig
    
    Returns:
    
    The value of the replication attribute
  - isConfigServer
```
public boolean isConfigServer()
```
    Specified by:
    
    isConfigServer in interface MongodConfig
    
    Returns:
    
    The value of the isConfigServer attribute
  - isShardServer
```
public boolean isShardServer()
```
    Specified by:
    
    isShardServer in interface MongodConfig
    
    Returns:
    
    The value of the isShardServer attribute
  - processListener
```
public IMongoProcessListener processListener()
```
    Specified by:
    
    processListener in interface MongodConfig
    
    Returns:
    
    The value of the processListener attribute
  - params
```
public Map<String,String> params()
```
    Specified by:
    
    params in interface MongodConfig
    
    Returns:
    
    The value of the params attribute
  - args
```
public Map<String,String> args()
```
    Specified by:
    
    args in interface MongodConfig
    
    Returns:
    
    The value of the args attribute
  - pidFile
```
public String pidFile()
```
    Specified by:
    
    pidFile in interface MongoCommonConfig
    
    Specified by:
    
    pidFile in interface MongodConfig
    
    Returns:
    
    The value of the pidFile attribute
  - supportConfig
```
public de.flapdoodle.embed.process.config.SupportConfig supportConfig()
```
    Specified by:
    
    supportConfig in interface MongodConfig
    
    Specified by:
    
    supportConfig in interface de.flapdoodle.embed.process.config.ExecutableProcessConfig
    
    Returns:
    
    The value of the supportConfig attribute
  - withStopTimeoutInMillis
```
public final ImmutableMongodConfig withStopTimeoutInMillis(long value)
```
    Copy the current immutable object by setting a present value for the optional stopTimeoutInMillis attribute.
    
    Parameters:
    
    value - The value for stopTimeoutInMillis
    
    Returns:
    
    A modified copy of this object
  - withStopTimeoutInMillis
```
public final ImmutableMongodConfig withStopTimeoutInMillis(OptionalLong optional)
```
    Copy the current immutable object by setting an optional value for the stopTimeoutInMillis attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for stopTimeoutInMillis
    
    Returns:
    
    A modified copy of this object
  - withVersion
```
public final ImmutableMongodConfig withVersion(IFeatureAwareVersion value)
```
    Copy the current immutable object by setting a value for the version attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for version
    
    Returns:
    
    A modified copy of the this object
  - withTimeout
```
public final ImmutableMongodConfig withTimeout(Timeout value)
```
    Copy the current immutable object by setting a value for the timeout attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for timeout
    
    Returns:
    
    A modified copy of the this object
  - withNet
```
public final ImmutableMongodConfig withNet(Net value)
```
    Copy the current immutable object by setting a value for the net attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for net
    
    Returns:
    
    A modified copy of the this object
  - withCmdOptions
```
public final ImmutableMongodConfig withCmdOptions(MongoCmdOptions value)
```
    Copy the current immutable object by setting a value for the cmdOptions attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for cmdOptions
    
    Returns:
    
    A modified copy of the this object
  - withPassword
```
public final ImmutableMongodConfig withPassword(String value)
```
    Copy the current immutable object by setting a value for the password attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for password
    
    Returns:
    
    A modified copy of the this object
  - withUserName
```
public final ImmutableMongodConfig withUserName(String value)
```
    Copy the current immutable object by setting a value for the userName attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for userName
    
    Returns:
    
    A modified copy of the this object
  - withReplication
```
public final ImmutableMongodConfig withReplication(Storage value)
```
    Copy the current immutable object by setting a value for the replication attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for replication
    
    Returns:
    
    A modified copy of the this object
  - withIsConfigServer
```
public final ImmutableMongodConfig withIsConfigServer(boolean value)
```
    Copy the current immutable object by setting a value for the isConfigServer attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for isConfigServer
    
    Returns:
    
    A modified copy of the this object
  - withIsShardServer
```
public final ImmutableMongodConfig withIsShardServer(boolean value)
```
    Copy the current immutable object by setting a value for the isShardServer attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for isShardServer
    
    Returns:
    
    A modified copy of the this object
  - withProcessListener
```
public final ImmutableMongodConfig withProcessListener(IMongoProcessListener value)
```
    Copy the current immutable object by setting a value for the processListener attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for processListener
    
    Returns:
    
    A modified copy of the this object
  - withParams
```
public final ImmutableMongodConfig withParams(Map<String,? extends String> entries)
```
    Copy the current immutable object by replacing the params map with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    entries - The entries to be added to the params map
    
    Returns:
    
    A modified copy of this object
  - withArgs
```
public final ImmutableMongodConfig withArgs(Map<String,? extends String> entries)
```
    Copy the current immutable object by replacing the args map with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    entries - The entries to be added to the args map
    
    Returns:
    
    A modified copy of this object
  - withPidFile
```
public final ImmutableMongodConfig withPidFile(String value)
```
    Copy the current immutable object by setting a value for the pidFile attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for pidFile
    
    Returns:
    
    A modified copy of the this object
  - withSupportConfig
```
public final ImmutableMongodConfig withSupportConfig(de.flapdoodle.embed.process.config.SupportConfig value)
```
    Copy the current immutable object by setting a value for the supportConfig attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for supportConfig
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(Object another)
```
    This instance is equal to all instances of ImmutableMongodConfig that have equal attribute values.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true if this is equal to another instance
  - hashCode
```
public int hashCode()
```
    Computes a hash code from attributes: stopTimeoutInMillis, version, timeout, net, cmdOptions, password, userName, replication, isConfigServer, isShardServer, processListener, params, args, pidFile, supportConfig.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value MongodConfig with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableMongodConfig copyOf(MongodConfig instance)
```
    Creates an immutable copy of a MongodConfig value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.
    
    Parameters:
    
    instance - The instance to copy
    
    Returns:
    
    A copied immutable MongodConfig instance
  - builder
```
public static ImmutableMongodConfig.Builder builder()
```
    Creates a builder for ImmutableMongodConfig.
```
 ImmutableMongodConfig.builder()
    .stopTimeoutInMillis(long) // optional stopTimeoutInMillis
    .version(de.flapdoodle.embed.mongo.distribution.IFeatureAwareVersion) // required version
    .timeout(de.flapdoodle.embed.mongo.config.Timeout) // optional timeout
    .net(de.flapdoodle.embed.mongo.config.Net) // optional net
    .cmdOptions(de.flapdoodle.embed.mongo.config.MongoCmdOptions) // optional cmdOptions
    .password(String) // optional password
    .userName(String) // optional userName
    .replication(de.flapdoodle.embed.mongo.config.Storage) // optional replication
    .isConfigServer(boolean) // optional isConfigServer
    .isShardServer(boolean) // optional isShardServer
    .processListener(de.flapdoodle.embed.mongo.config.processlistener.IMongoProcessListener) // optional processListener
    .putParams|putAllParams(String => String) // params mappings
    .putArgs|putAllArgs(String => String) // args mappings
    .pidFile(String) // optional pidFile
    .supportConfig(de.flapdoodle.embed.process.config.SupportConfig) // optional supportConfig
    .build();
 
```
    Specified by:
    
    builder in interface MongodConfig
    
    Returns:
    
    A new ImmutableMongodConfig builder

Class ImmutableMongodConfig

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

stopTimeoutInMillis

version

timeout

net

cmdOptions

password

userName

replication

isConfigServer

isShardServer

processListener

params

args

pidFile

supportConfig

withStopTimeoutInMillis

withStopTimeoutInMillis

withVersion

withTimeout

withNet

withCmdOptions

withPassword

withUserName

withReplication

withIsConfigServer

withIsShardServer

withProcessListener

withParams

withArgs

withPidFile

withSupportConfig

equals

hashCode

toString

copyOf

builder