ImmutableMongoCmdOptions (Flapdoodle Embedded MongoDB 3.4.7 API)

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

All Implemented Interfaces:

MongoCmdOptions
```
public final class ImmutableMongoCmdOptions
extends Object
implements MongoCmdOptions
```
Immutable implementation of MongoCmdOptions.
Use the builder to create immutable instances: ImmutableMongoCmdOptions.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableMongoCmdOptions.Builder
Builds instances of type ImmutableMongoCmdOptions.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`auth()`
`static ImmutableMongoCmdOptions.Builder`	`builder()` Creates a builder for `ImmutableMongoCmdOptions`.
`static ImmutableMongoCmdOptions`	`copyOf(MongoCmdOptions instance)` Creates an immutable copy of a `MongoCmdOptions` value.
`boolean`	`enableTextSearch()`
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableMongoCmdOptions` that have equal attribute values.
`int`	`hashCode()` Computes a hash code from attributes: `syncDelay`, `useDefaultSyncDelay`, `storageEngine`, `isVerbose`, `useNoPrealloc`, `useSmallFiles`, `useNoJournal`, `enableTextSearch`, `auth`, `master`.
`boolean`	`isVerbose()`
`boolean`	`master()`
`Optional<String>`	`storageEngine()`
`int`	`syncDelay()`
`String`	`toString()` Prints the immutable value `MongoCmdOptions` with attribute values.
`boolean`	`useDefaultSyncDelay()`
`boolean`	`useNoJournal()`
`boolean`	`useNoPrealloc()`
`boolean`	`useSmallFiles()`
`ImmutableMongoCmdOptions`	`withAuth(boolean value)` Copy the current immutable object by setting a value for the `auth` attribute.
`ImmutableMongoCmdOptions`	`withEnableTextSearch(boolean value)` Copy the current immutable object by setting a value for the `enableTextSearch` attribute.
`ImmutableMongoCmdOptions`	`withIsVerbose(boolean value)` Copy the current immutable object by setting a value for the `isVerbose` attribute.
`ImmutableMongoCmdOptions`	`withMaster(boolean value)` Copy the current immutable object by setting a value for the `master` attribute.
`ImmutableMongoCmdOptions`	`withStorageEngine(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `storageEngine` attribute.
`ImmutableMongoCmdOptions`	`withStorageEngine(String value)` Copy the current immutable object by setting a present value for the optional `storageEngine` attribute.
`ImmutableMongoCmdOptions`	`withSyncDelay(int value)` Copy the current immutable object by setting a value for the `syncDelay` attribute.
`ImmutableMongoCmdOptions`	`withUseDefaultSyncDelay(boolean value)` Copy the current immutable object by setting a value for the `useDefaultSyncDelay` attribute.
`ImmutableMongoCmdOptions`	`withUseNoJournal(boolean value)` Copy the current immutable object by setting a value for the `useNoJournal` attribute.
`ImmutableMongoCmdOptions`	`withUseNoPrealloc(boolean value)` Copy the current immutable object by setting a value for the `useNoPrealloc` attribute.
`ImmutableMongoCmdOptions`	`withUseSmallFiles(boolean value)` Copy the current immutable object by setting a value for the `useSmallFiles` attribute.

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

Methods inherited from interface de.flapdoodle.embed.mongo.config.MongoCmdOptions
defaults

- Method Detail
  - syncDelay
```
public int syncDelay()
```
    Specified by:
    
    syncDelay in interface MongoCmdOptions
    
    Returns:
    
    The value of the syncDelay attribute
  - useDefaultSyncDelay
```
public boolean useDefaultSyncDelay()
```
    Specified by:
    
    useDefaultSyncDelay in interface MongoCmdOptions
    
    Returns:
    
    The value of the useDefaultSyncDelay attribute
  - storageEngine
```
public Optional<String> storageEngine()
```
    Specified by:
    
    storageEngine in interface MongoCmdOptions
    
    Returns:
    
    The value of the storageEngine attribute
  - isVerbose
```
public boolean isVerbose()
```
    Specified by:
    
    isVerbose in interface MongoCmdOptions
    
    Returns:
    
    The value of the isVerbose attribute
  - useNoPrealloc
```
public boolean useNoPrealloc()
```
    Specified by:
    
    useNoPrealloc in interface MongoCmdOptions
    
    Returns:
    
    The value of the useNoPrealloc attribute
  - useSmallFiles
```
public boolean useSmallFiles()
```
    Specified by:
    
    useSmallFiles in interface MongoCmdOptions
    
    Returns:
    
    The value of the useSmallFiles attribute
  - useNoJournal
```
public boolean useNoJournal()
```
    Specified by:
    
    useNoJournal in interface MongoCmdOptions
    
    Returns:
    
    The value of the useNoJournal attribute
  - enableTextSearch
```
public boolean enableTextSearch()
```
    Specified by:
    
    enableTextSearch in interface MongoCmdOptions
    
    Returns:
    
    The value of the enableTextSearch attribute
  - auth
```
public boolean auth()
```
    Specified by:
    
    auth in interface MongoCmdOptions
    
    Returns:
    
    The value of the auth attribute
  - master
```
public boolean master()
```
    Specified by:
    
    master in interface MongoCmdOptions
    
    Returns:
    
    The value of the master attribute
  - withSyncDelay
```
public final ImmutableMongoCmdOptions 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 ImmutableMongoCmdOptions 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 ImmutableMongoCmdOptions 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 ImmutableMongoCmdOptions 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 ImmutableMongoCmdOptions 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
  - withUseNoPrealloc
```
public final ImmutableMongoCmdOptions 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 ImmutableMongoCmdOptions 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 ImmutableMongoCmdOptions 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 ImmutableMongoCmdOptions 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 ImmutableMongoCmdOptions 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 ImmutableMongoCmdOptions 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
  - equals
```
public boolean equals(Object another)
```
    This instance is equal to all instances of ImmutableMongoCmdOptions 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, useNoPrealloc, useSmallFiles, useNoJournal, enableTextSearch, auth, master.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value MongoCmdOptions with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableMongoCmdOptions copyOf(MongoCmdOptions instance)
```
    Creates an immutable copy of a MongoCmdOptions 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 MongoCmdOptions instance
  - builder
```
public static ImmutableMongoCmdOptions.Builder builder()
```
    Creates a builder for ImmutableMongoCmdOptions.
```
 ImmutableMongoCmdOptions.builder()
    .syncDelay(int) // optional syncDelay
    .useDefaultSyncDelay(boolean) // optional useDefaultSyncDelay
    .storageEngine(String) // optional storageEngine
    .isVerbose(boolean) // optional isVerbose
    .useNoPrealloc(boolean) // optional useNoPrealloc
    .useSmallFiles(boolean) // optional useSmallFiles
    .useNoJournal(boolean) // optional useNoJournal
    .enableTextSearch(boolean) // optional enableTextSearch
    .auth(boolean) // optional auth
    .master(boolean) // optional master
    .build();
 
```
    Specified by:
    
    builder in interface MongoCmdOptions
    
    Returns:
    
    A new ImmutableMongoCmdOptions builder

Class ImmutableMongoCmdOptions

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface de.flapdoodle.embed.mongo.config.MongoCmdOptions

Method Detail

syncDelay

useDefaultSyncDelay

storageEngine

isVerbose

useNoPrealloc

useSmallFiles

useNoJournal

enableTextSearch

auth

master

withSyncDelay

withUseDefaultSyncDelay

withStorageEngine

withStorageEngine

withIsVerbose

withUseNoPrealloc

withUseSmallFiles

withUseNoJournal

withEnableTextSearch

withAuth

withMaster

equals

hashCode

toString

copyOf

builder