ImmutableMongosConfig (Flapdoodle Embedded MongoDB 3.4.7 API)

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

All Implemented Interfaces:

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableMongosConfig.Builder
Builds instances of type ImmutableMongosConfig.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,String>`	`args()`
`static ImmutableMongosConfig.Builder`	`builder()` Creates a builder for `ImmutableMongosConfig`.
`MongoCmdOptions`	`cmdOptions()`
`static ImmutableMongosConfig`	`copyOf(MongosConfig instance)` Creates an immutable copy of a `MongosConfig` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableMongosConfig` that have equal attribute values.
`String`	`getConfigDB()`
`int`	`hashCode()` Computes a hash code from attributes: `stopTimeoutInMillis`, `version`, `timeout`, `net`, `cmdOptions`, `password`, `userName`, `configDB`, `replicaSet`, `args`, `pidFile`, `supportConfig`.
`Net`	`net()`
`String`	`password()`
`String`	`pidFile()`
`String`	`replicaSet()`
`OptionalLong`	`stopTimeoutInMillis()`
`de.flapdoodle.embed.process.config.SupportConfig`	`supportConfig()`
`Timeout`	`timeout()`
`String`	`toString()` Prints the immutable value `MongosConfig` with attribute values.
`String`	`userName()`
`IFeatureAwareVersion`	`version()`
`ImmutableMongosConfig`	`withArgs(Map<String,? extends String> entries)` Copy the current immutable object by replacing the `args` map with the specified map.
`ImmutableMongosConfig`	`withCmdOptions(MongoCmdOptions value)` Copy the current immutable object by setting a value for the `cmdOptions` attribute.
`ImmutableMongosConfig`	`withConfigDB(String value)` Copy the current immutable object by setting a value for the `configDB` attribute.
`ImmutableMongosConfig`	`withNet(Net value)` Copy the current immutable object by setting a value for the `net` attribute.
`ImmutableMongosConfig`	`withPassword(String value)` Copy the current immutable object by setting a value for the `password` attribute.
`ImmutableMongosConfig`	`withPidFile(String value)` Copy the current immutable object by setting a value for the `pidFile` attribute.
`ImmutableMongosConfig`	`withReplicaSet(String value)` Copy the current immutable object by setting a value for the `replicaSet` attribute.
`ImmutableMongosConfig`	`withStopTimeoutInMillis(long value)` Copy the current immutable object by setting a present value for the optional `stopTimeoutInMillis` attribute.
`ImmutableMongosConfig`	`withStopTimeoutInMillis(OptionalLong optional)` Copy the current immutable object by setting an optional value for the `stopTimeoutInMillis` attribute.
`ImmutableMongosConfig`	`withSupportConfig(de.flapdoodle.embed.process.config.SupportConfig value)` Copy the current immutable object by setting a value for the `supportConfig` attribute.
`ImmutableMongosConfig`	`withTimeout(Timeout value)` Copy the current immutable object by setting a value for the `timeout` attribute.
`ImmutableMongosConfig`	`withUserName(String value)` Copy the current immutable object by setting a value for the `userName` attribute.
`ImmutableMongosConfig`	`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
  - getConfigDB
```
public String getConfigDB()
```
    Specified by:
    
    getConfigDB in interface MongosConfig
    
    Returns:
    
    The value of the configDB attribute
  - replicaSet
```
public String replicaSet()
```
    Specified by:
    
    replicaSet in interface MongosConfig
    
    Returns:
    
    The value of the replicaSet attribute
  - args
```
public Map<String,String> args()
```
    Specified by:
    
    args in interface MongosConfig
    
    Returns:
    
    The value of the args attribute
  - pidFile
```
public String pidFile()
```
    Specified by:
    
    pidFile in interface MongoCommonConfig
    
    Specified by:
    
    pidFile in interface MongosConfig
    
    Returns:
    
    The value of the pidFile attribute
  - supportConfig
```
public de.flapdoodle.embed.process.config.SupportConfig supportConfig()
```
    Specified by:
    
    supportConfig in interface MongosConfig
    
    Specified by:
    
    supportConfig in interface de.flapdoodle.embed.process.config.ExecutableProcessConfig
    
    Returns:
    
    The value of the supportConfig attribute
  - withStopTimeoutInMillis
```
public final ImmutableMongosConfig 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 ImmutableMongosConfig 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 ImmutableMongosConfig 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 ImmutableMongosConfig 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 ImmutableMongosConfig 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 ImmutableMongosConfig 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 ImmutableMongosConfig 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 ImmutableMongosConfig 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
  - withConfigDB
```
public final ImmutableMongosConfig withConfigDB(String value)
```
    Copy the current immutable object by setting a value for the configDB attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for configDB
    
    Returns:
    
    A modified copy of the this object
  - withReplicaSet
```
public final ImmutableMongosConfig withReplicaSet(String value)
```
    Copy the current immutable object by setting a value for the replicaSet attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for replicaSet
    
    Returns:
    
    A modified copy of the this object
  - withArgs
```
public final ImmutableMongosConfig 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 ImmutableMongosConfig 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 ImmutableMongosConfig 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 ImmutableMongosConfig 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, configDB, replicaSet, args, pidFile, supportConfig.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value MongosConfig with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableMongosConfig copyOf(MongosConfig instance)
```
    Creates an immutable copy of a MongosConfig 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 MongosConfig instance
  - builder
```
public static ImmutableMongosConfig.Builder builder()
```
    Creates a builder for ImmutableMongosConfig.
```
 ImmutableMongosConfig.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
    .configDB(String) // required configDB
    .replicaSet(String) // optional replicaSet
    .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 MongosConfig
    
    Returns:
    
    A new ImmutableMongosConfig builder

Class ImmutableMongosConfig

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

stopTimeoutInMillis

version

timeout

net

cmdOptions

password

userName

getConfigDB

replicaSet

args

pidFile

supportConfig

withStopTimeoutInMillis

withStopTimeoutInMillis

withVersion

withTimeout

withNet

withCmdOptions

withPassword

withUserName

withConfigDB

withReplicaSet

withArgs

withPidFile

withSupportConfig

equals

hashCode

toString

copyOf

builder