ImmutableMongodArguments (Flapdoodle Embedded MongoDB 4.11.1 API)

java.lang.Object
- de.flapdoodle.embed.mongo.commands.MongodArguments
- - de.flapdoodle.embed.mongo.commands.ImmutableMongodArguments

```
public final class ImmutableMongodArguments
extends MongodArguments
```
Immutable implementation of MongodArguments.
Use the builder to create immutable instances: ImmutableMongodArguments.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableMongodArguments.Builder
Builds instances of type ImmutableMongodArguments.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,String>`	`args()`
`boolean`	`auth()`
`static ImmutableMongodArguments.Builder`	`builder()` Creates a builder for `ImmutableMongodArguments`.
`static ImmutableMongodArguments`	`copyOf(MongodArguments instance)` Creates an immutable copy of a `MongodArguments` value.
`boolean`	`enableTextSearch()`
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableMongodArguments` that have equal attribute values.
`int`	`hashCode()` Computes a hash code from attributes: `syncDelay`, `useDefaultSyncDelay`, `storageEngine`, `isVerbose`, `verbosityLevel`, `isQuiet`, `useNoPrealloc`, `useSmallFiles`, `useNoJournal`, `enableTextSearch`, `auth`, `master`, `replication`, `isConfigServer`, `isShardServer`, `params`, `args`.
`boolean`	`isConfigServer()`
`boolean`	`isQuiet()`
`boolean`	`isShardServer()`
`boolean`	`isVerbose()`
`boolean`	`master()`
`Map<String,String>`	`params()`
`Optional<Storage>`	`replication()`
`Optional<String>`	`storageEngine()`
`int`	`syncDelay()`
`String`	`toString()` Prints the immutable value `MongodArguments` with attribute values.
`boolean`	`useDefaultSyncDelay()`
`boolean`	`useNoJournal()`
`boolean`	`useNoPrealloc()`
`boolean`	`useSmallFiles()`
`int`	`verbosityLevel()`
`ImmutableMongodArguments`	`withArgs(Map<String,? extends String> entries)` Copy the current immutable object by replacing the `args` map with the specified map.
`ImmutableMongodArguments`	`withAuth(boolean value)` Copy the current immutable object by setting a value for the `auth` attribute.
`ImmutableMongodArguments`	`withEnableTextSearch(boolean value)` Copy the current immutable object by setting a value for the `enableTextSearch` attribute.
`ImmutableMongodArguments`	`withIsConfigServer(boolean value)` Copy the current immutable object by setting a value for the `isConfigServer` attribute.
`ImmutableMongodArguments`	`withIsQuiet(boolean value)` Copy the current immutable object by setting a value for the `isQuiet` attribute.
`ImmutableMongodArguments`	`withIsShardServer(boolean value)` Copy the current immutable object by setting a value for the `isShardServer` attribute.
`ImmutableMongodArguments`	`withIsVerbose(boolean value)` Copy the current immutable object by setting a value for the `isVerbose` attribute.
`ImmutableMongodArguments`	`withMaster(boolean value)` Copy the current immutable object by setting a value for the `master` attribute.
`ImmutableMongodArguments`	`withParams(Map<String,? extends String> entries)` Copy the current immutable object by replacing the `params` map with the specified map.
`ImmutableMongodArguments`	`withReplication(Optional<? extends Storage> optional)` Copy the current immutable object by setting an optional value for the `replication` attribute.
`ImmutableMongodArguments`	`withReplication(Storage value)` Copy the current immutable object by setting a present value for the optional `replication` attribute.
`ImmutableMongodArguments`	`withStorageEngine(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `storageEngine` attribute.
`ImmutableMongodArguments`	`withStorageEngine(String value)` Copy the current immutable object by setting a present value for the optional `storageEngine` attribute.
`ImmutableMongodArguments`	`withSyncDelay(int value)` Copy the current immutable object by setting a value for the `syncDelay` attribute.
`ImmutableMongodArguments`	`withUseDefaultSyncDelay(boolean value)` Copy the current immutable object by setting a value for the `useDefaultSyncDelay` attribute.
`ImmutableMongodArguments`	`withUseNoJournal(boolean value)` Copy the current immutable object by setting a value for the `useNoJournal` attribute.
`ImmutableMongodArguments`	`withUseNoPrealloc(boolean value)` Copy the current immutable object by setting a value for the `useNoPrealloc` attribute.
`ImmutableMongodArguments`	`withUseSmallFiles(boolean value)` Copy the current immutable object by setting a value for the `useSmallFiles` attribute.
`ImmutableMongodArguments`	`withVerbosityLevel(int value)` Copy the current immutable object by setting a value for the `verbosityLevel` attribute.

Methods inherited from class de.flapdoodle.embed.mongo.commands.MongodArguments
asArguments, defaults

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

- Method Detail
  - syncDelay
```
public int syncDelay()
```
    Overrides:
    
    syncDelay in class MongodArguments
    
    Returns:
    
    The value of the syncDelay attribute
  - useDefaultSyncDelay
```
public boolean useDefaultSyncDelay()
```
    Overrides:
    
    useDefaultSyncDelay in class MongodArguments
    
    Returns:
    
    The value of the useDefaultSyncDelay attribute
  - storageEngine
```
public Optional<String> storageEngine()
```
    Specified by:
    
    storageEngine in class MongodArguments
    
    Returns:
    
    The value of the storageEngine attribute
  - isVerbose
```
public boolean isVerbose()
```
    Overrides:
    
    isVerbose in class MongodArguments
    
    Returns:
    
    The value of the isVerbose attribute
  - verbosityLevel
```
public int verbosityLevel()
```
    Overrides:
    
    verbosityLevel in class MongodArguments
    
    Returns:
    
    The value of the verbosityLevel attribute
  - isQuiet
```
public boolean isQuiet()
```
    Overrides:
    
    isQuiet in class MongodArguments
    
    Returns:
    
    The value of the isQuiet attribute
  - useNoPrealloc
```
public boolean useNoPrealloc()
```
    Overrides:
    
    useNoPrealloc in class MongodArguments
    
    Returns:
    
    The value of the useNoPrealloc attribute
  - useSmallFiles
```
public boolean useSmallFiles()
```
    Overrides:
    
    useSmallFiles in class MongodArguments
    
    Returns:
    
    The value of the useSmallFiles attribute
  - useNoJournal
```
public boolean useNoJournal()
```
    Overrides:
    
    useNoJournal in class MongodArguments
    
    Returns:
    
    The value of the useNoJournal attribute
  - enableTextSearch
```
public boolean enableTextSearch()
```
    Overrides:
    
    enableTextSearch in class MongodArguments
    
    Returns:
    
    The value of the enableTextSearch attribute
  - auth
```
public boolean auth()
```
    Overrides:
    
    auth in class MongodArguments
    
    Returns:
    
    The value of the auth attribute
  - master
```
public boolean master()
```
    Overrides:
    
    master in class MongodArguments
    
    Returns:
    
    The value of the master attribute
  - replication
```
public Optional<Storage> replication()
```
    Specified by:
    
    replication in class MongodArguments
    
    Returns:
    
    The value of the replication attribute
  - isConfigServer
```
public boolean isConfigServer()
```
    Overrides:
    
    isConfigServer in class MongodArguments
    
    Returns:
    
    The value of the isConfigServer attribute
  - isShardServer
```
public boolean isShardServer()
```
    Overrides:
    
    isShardServer in class MongodArguments
    
    Returns:
    
    The value of the isShardServer attribute
  - params
```
public Map<String,String> params()
```
    Specified by:
    
    params in class MongodArguments
    
    Returns:
    
    The value of the params attribute
  - args
```
public Map<String,String> args()
```
    Specified by:
    
    args in class MongodArguments
    
    Returns:
    
    The value of the args attribute
  - withSyncDelay
```
public final ImmutableMongodArguments withSyncDelay(int value)
```
    Copy the current immutable object by setting a value for the syncDelay attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for syncDelay
    
    Returns:
    
    A modified copy of the this object
  - withUseDefaultSyncDelay
```
public final ImmutableMongodArguments withUseDefaultSyncDelay(boolean value)
```
    Copy the current immutable object by setting a value for the useDefaultSyncDelay attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for useDefaultSyncDelay
    
    Returns:
    
    A modified copy of the this object
  - withStorageEngine
```
public final ImmutableMongodArguments withStorageEngine(String value)
```
    Copy the current immutable object by setting a present value for the optional storageEngine attribute.
    
    Parameters:
    
    value - The value for storageEngine
    
    Returns:
    
    A modified copy of this object
  - withStorageEngine
```
public final ImmutableMongodArguments withStorageEngine(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the storageEngine 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 storageEngine
    
    Returns:
    
    A modified copy of this object
  - withIsVerbose
```
public final ImmutableMongodArguments withIsVerbose(boolean value)
```
    Copy the current immutable object by setting a value for the isVerbose attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for isVerbose
    
    Returns:
    
    A modified copy of the this object
  - withVerbosityLevel
```
public final ImmutableMongodArguments withVerbosityLevel(int value)
```
    Copy the current immutable object by setting a value for the verbosityLevel attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for verbosityLevel
    
    Returns:
    
    A modified copy of the this object
  - withIsQuiet
```
public final ImmutableMongodArguments withIsQuiet(boolean value)
```
    Copy the current immutable object by setting a value for the isQuiet attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for isQuiet
    
    Returns:
    
    A modified copy of the this object
  - withUseNoPrealloc
```
public final ImmutableMongodArguments withUseNoPrealloc(boolean value)
```
    Copy the current immutable object by setting a value for the useNoPrealloc attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for useNoPrealloc
    
    Returns:
    
    A modified copy of the this object
  - withUseSmallFiles
```
public final ImmutableMongodArguments withUseSmallFiles(boolean value)
```
    Copy the current immutable object by setting a value for the useSmallFiles attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for useSmallFiles
    
    Returns:
    
    A modified copy of the this object
  - withUseNoJournal
```
public final ImmutableMongodArguments withUseNoJournal(boolean value)
```
    Copy the current immutable object by setting a value for the useNoJournal attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for useNoJournal
    
    Returns:
    
    A modified copy of the this object
  - withEnableTextSearch
```
public final ImmutableMongodArguments withEnableTextSearch(boolean value)
```
    Copy the current immutable object by setting a value for the enableTextSearch attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for enableTextSearch
    
    Returns:
    
    A modified copy of the this object
  - withAuth
```
public final ImmutableMongodArguments withAuth(boolean value)
```
    Copy the current immutable object by setting a value for the auth attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for auth
    
    Returns:
    
    A modified copy of the this object
  - withMaster
```
public final ImmutableMongodArguments withMaster(boolean value)
```
    Copy the current immutable object by setting a value for the master attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for master
    
    Returns:
    
    A modified copy of the this object
  - withReplication
```
public final ImmutableMongodArguments withReplication(Storage value)
```
    Copy the current immutable object by setting a present value for the optional replication attribute.
    
    Parameters:
    
    value - The value for replication
    
    Returns:
    
    A modified copy of this object
  - withReplication
```
public final ImmutableMongodArguments withReplication(Optional<? extends Storage> optional)
```
    Copy the current immutable object by setting an optional value for the replication attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for replication
    
    Returns:
    
    A modified copy of this object
  - withIsConfigServer
```
public final ImmutableMongodArguments 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 ImmutableMongodArguments 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
  - withParams
```
public final ImmutableMongodArguments 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 ImmutableMongodArguments 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
  - equals
```
public boolean equals(Object another)
```
    This instance is equal to all instances of ImmutableMongodArguments 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: syncDelay, useDefaultSyncDelay, storageEngine, isVerbose, verbosityLevel, isQuiet, useNoPrealloc, useSmallFiles, useNoJournal, enableTextSearch, auth, master, replication, isConfigServer, isShardServer, params, args.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value MongodArguments with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableMongodArguments copyOf(MongodArguments instance)
```
    Creates an immutable copy of a MongodArguments 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 MongodArguments instance
  - builder
```
public static ImmutableMongodArguments.Builder builder()
```
    Creates a builder for ImmutableMongodArguments.
```
 ImmutableMongodArguments.builder()
    .syncDelay(int) // optional syncDelay
    .useDefaultSyncDelay(boolean) // optional useDefaultSyncDelay
    .storageEngine(String) // optional storageEngine
    .isVerbose(boolean) // optional isVerbose
    .verbosityLevel(int) // optional verbosityLevel
    .isQuiet(boolean) // optional isQuiet
    .useNoPrealloc(boolean) // optional useNoPrealloc
    .useSmallFiles(boolean) // optional useSmallFiles
    .useNoJournal(boolean) // optional useNoJournal
    .enableTextSearch(boolean) // optional enableTextSearch
    .auth(boolean) // optional auth
    .master(boolean) // optional master
    .replication(de.flapdoodle.embed.mongo.config.Storage) // optional replication
    .isConfigServer(boolean) // optional isConfigServer
    .isShardServer(boolean) // optional isShardServer
    .putParams|putAllParams(String => String) // params mappings
    .putArgs|putAllArgs(String => String) // args mappings
    .build();
 
```
    Returns:
    
    A new ImmutableMongodArguments builder

Class ImmutableMongodArguments

Nested Class Summary

Method Summary

Methods inherited from class de.flapdoodle.embed.mongo.commands.MongodArguments

Methods inherited from class java.lang.Object

Method Detail

syncDelay

useDefaultSyncDelay

storageEngine

isVerbose

verbosityLevel

isQuiet

useNoPrealloc

useSmallFiles

useNoJournal

enableTextSearch

auth

master

replication

isConfigServer

isShardServer

params

args

withSyncDelay

withUseDefaultSyncDelay

withStorageEngine

withStorageEngine

withIsVerbose

withVerbosityLevel

withIsQuiet

withUseNoPrealloc

withUseSmallFiles

withUseNoJournal

withEnableTextSearch

withAuth

withMaster

withReplication

withReplication

withIsConfigServer

withIsShardServer

withParams

withArgs

equals

hashCode

toString

copyOf

builder