ImmutableMongoShellConfig (Flapdoodle Embedded MongoDB 3.4.7 API)

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

All Implemented Interfaces:

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableMongoShellConfig.Builder
Builds instances of type ImmutableMongoShellConfig.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableMongoShellConfig.Builder`	`builder()` Creates a builder for `ImmutableMongoShellConfig`.
`MongoCmdOptions`	`cmdOptions()`
`static ImmutableMongoShellConfig`	`copyOf(MongoShellConfig instance)` Creates an immutable copy of a `MongoShellConfig` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableMongoShellConfig` that have equal attribute values.
`String`	`getDbName()`
`String`	`getScriptName()`
`List<String>`	`getScriptParameters()`
`int`	`hashCode()` Computes a hash code from attributes: `stopTimeoutInMillis`, `version`, `timeout`, `net`, `cmdOptions`, `password`, `userName`, `scriptParameters`, `scriptName`, `dbName`, `pidFile`, `supportConfig`.
`Net`	`net()`
`String`	`password()`
`String`	`pidFile()`
`OptionalLong`	`stopTimeoutInMillis()`
`de.flapdoodle.embed.process.config.SupportConfig`	`supportConfig()`
`Timeout`	`timeout()`
`String`	`toString()` Prints the immutable value `MongoShellConfig` with attribute values.
`String`	`userName()`
`IFeatureAwareVersion`	`version()`
`ImmutableMongoShellConfig`	`withCmdOptions(MongoCmdOptions value)` Copy the current immutable object by setting a value for the `cmdOptions` attribute.
`ImmutableMongoShellConfig`	`withDbName(String value)` Copy the current immutable object by setting a value for the `dbName` attribute.
`ImmutableMongoShellConfig`	`withNet(Net value)` Copy the current immutable object by setting a value for the `net` attribute.
`ImmutableMongoShellConfig`	`withPassword(String value)` Copy the current immutable object by setting a value for the `password` attribute.
`ImmutableMongoShellConfig`	`withPidFile(String value)` Copy the current immutable object by setting a value for the `pidFile` attribute.
`ImmutableMongoShellConfig`	`withScriptName(String value)` Copy the current immutable object by setting a value for the `scriptName` attribute.
`ImmutableMongoShellConfig`	`withScriptParameters(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `scriptParameters`.
`ImmutableMongoShellConfig`	`withScriptParameters(String... elements)` Copy the current immutable object with elements that replace the content of `scriptParameters`.
`ImmutableMongoShellConfig`	`withStopTimeoutInMillis(long value)` Copy the current immutable object by setting a present value for the optional `stopTimeoutInMillis` attribute.
`ImmutableMongoShellConfig`	`withStopTimeoutInMillis(OptionalLong optional)` Copy the current immutable object by setting an optional value for the `stopTimeoutInMillis` attribute.
`ImmutableMongoShellConfig`	`withSupportConfig(de.flapdoodle.embed.process.config.SupportConfig value)` Copy the current immutable object by setting a value for the `supportConfig` attribute.
`ImmutableMongoShellConfig`	`withTimeout(Timeout value)` Copy the current immutable object by setting a value for the `timeout` attribute.
`ImmutableMongoShellConfig`	`withUserName(String value)` Copy the current immutable object by setting a value for the `userName` attribute.
`ImmutableMongoShellConfig`	`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
  - getScriptParameters
```
public List<String> getScriptParameters()
```
    Specified by:
    
    getScriptParameters in interface MongoShellConfig
    
    Returns:
    
    The value of the scriptParameters attribute
  - getScriptName
```
public String getScriptName()
```
    Specified by:
    
    getScriptName in interface MongoShellConfig
    
    Returns:
    
    The value of the scriptName attribute
  - getDbName
```
public String getDbName()
```
    Specified by:
    
    getDbName in interface MongoShellConfig
    
    Returns:
    
    The value of the dbName attribute
  - pidFile
```
public String pidFile()
```
    Specified by:
    
    pidFile in interface MongoCommonConfig
    
    Specified by:
    
    pidFile in interface MongoShellConfig
    
    Returns:
    
    The value of the pidFile attribute
  - supportConfig
```
public de.flapdoodle.embed.process.config.SupportConfig supportConfig()
```
    Specified by:
    
    supportConfig in interface MongoShellConfig
    
    Specified by:
    
    supportConfig in interface de.flapdoodle.embed.process.config.ExecutableProcessConfig
    
    Returns:
    
    The value of the supportConfig attribute
  - withStopTimeoutInMillis
```
public final ImmutableMongoShellConfig 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 ImmutableMongoShellConfig 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 ImmutableMongoShellConfig 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 ImmutableMongoShellConfig 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 ImmutableMongoShellConfig 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 ImmutableMongoShellConfig 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 ImmutableMongoShellConfig 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 ImmutableMongoShellConfig 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
  - withScriptParameters
```
public final ImmutableMongoShellConfig withScriptParameters(String... elements)
```
    Copy the current immutable object with elements that replace the content of scriptParameters.
    
    Parameters:
    
    elements - The elements to set
    
    Returns:
    
    A modified copy of this object
  - withScriptParameters
```
public final ImmutableMongoShellConfig withScriptParameters(Iterable<String> elements)
```
    Copy the current immutable object with elements that replace the content of scriptParameters. A shallow reference equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    elements - An iterable of scriptParameters elements to set
    
    Returns:
    
    A modified copy of this object
  - withScriptName
```
public final ImmutableMongoShellConfig withScriptName(String value)
```
    Copy the current immutable object by setting a value for the scriptName attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for scriptName
    
    Returns:
    
    A modified copy of the this object
  - withDbName
```
public final ImmutableMongoShellConfig withDbName(String value)
```
    Copy the current immutable object by setting a value for the dbName attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for dbName
    
    Returns:
    
    A modified copy of the this object
  - withPidFile
```
public final ImmutableMongoShellConfig 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 ImmutableMongoShellConfig 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 ImmutableMongoShellConfig 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, scriptParameters, scriptName, dbName, pidFile, supportConfig.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value MongoShellConfig with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableMongoShellConfig copyOf(MongoShellConfig instance)
```
    Creates an immutable copy of a MongoShellConfig 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 MongoShellConfig instance
  - builder
```
public static ImmutableMongoShellConfig.Builder builder()
```
    Creates a builder for ImmutableMongoShellConfig.
```
 ImmutableMongoShellConfig.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
    .addScriptParameters|addAllScriptParameters(String) // scriptParameters elements
    .scriptName(String) // required scriptName
    .dbName(String) // required dbName
    .pidFile(String) // optional pidFile
    .supportConfig(de.flapdoodle.embed.process.config.SupportConfig) // optional supportConfig
    .build();
 
```
    Specified by:
    
    builder in interface MongoShellConfig
    
    Returns:
    
    A new ImmutableMongoShellConfig builder

Class ImmutableMongoShellConfig

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

stopTimeoutInMillis

version

timeout

net

cmdOptions

password

userName

getScriptParameters

getScriptName

getDbName

pidFile

supportConfig

withStopTimeoutInMillis

withStopTimeoutInMillis

withVersion

withTimeout

withNet

withCmdOptions

withPassword

withUserName

withScriptParameters

withScriptParameters

withScriptName

withDbName

withPidFile

withSupportConfig

equals

hashCode

toString

copyOf

builder