ImmutableMongoShellArguments (Flapdoodle Embedded MongoDB 4.11.1 API)

java.lang.Object
- de.flapdoodle.embed.mongo.commands.MongoShellArguments
- - de.flapdoodle.embed.mongo.commands.ImmutableMongoShellArguments

All Implemented Interfaces:

MongoToolsArguments
```
public final class ImmutableMongoShellArguments
extends MongoShellArguments
```
Immutable implementation of MongoShellArguments.
Use the builder to create immutable instances: ImmutableMongoShellArguments.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableMongoShellArguments.Builder
Builds instances of type ImmutableMongoShellArguments.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableMongoShellArguments.Builder`	`builder()` Creates a builder for `ImmutableMongoShellArguments`.
`static ImmutableMongoShellArguments`	`copyOf(MongoShellArguments instance)` Creates an immutable copy of a `MongoShellArguments` value.
`Optional<String>`	`dbName()`
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableMongoShellArguments` that have equal attribute values.
`int`	`hashCode()` Computes a hash code from attributes: `scriptParameters`, `scriptName`, `dbName`, `password`, `userName`.
`Optional<String>`	`password()`
`Optional<String>`	`scriptName()`
`List<String>`	`scriptParameters()`
`String`	`toString()` Prints the immutable value `MongoShellArguments` with attribute values.
`Optional<String>`	`userName()`
`ImmutableMongoShellArguments`	`withDbName(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `dbName` attribute.
`ImmutableMongoShellArguments`	`withDbName(String value)` Copy the current immutable object by setting a present value for the optional `dbName` attribute.
`ImmutableMongoShellArguments`	`withPassword(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `password` attribute.
`ImmutableMongoShellArguments`	`withPassword(String value)` Copy the current immutable object by setting a present value for the optional `password` attribute.
`ImmutableMongoShellArguments`	`withScriptName(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `scriptName` attribute.
`ImmutableMongoShellArguments`	`withScriptName(String value)` Copy the current immutable object by setting a present value for the optional `scriptName` attribute.
`ImmutableMongoShellArguments`	`withScriptParameters(Iterable<String> elements)` Copy the current immutable object with elements that replace the content of `scriptParameters`.
`ImmutableMongoShellArguments`	`withScriptParameters(String... elements)` Copy the current immutable object with elements that replace the content of `scriptParameters`.
`ImmutableMongoShellArguments`	`withUserName(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `userName` attribute.
`ImmutableMongoShellArguments`	`withUserName(String value)` Copy the current immutable object by setting a present value for the optional `userName` attribute.

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

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

- Method Detail
  - scriptParameters
```
public List<String> scriptParameters()
```
    Specified by:
    
    scriptParameters in class MongoShellArguments
    
    Returns:
    
    The value of the scriptParameters attribute
  - scriptName
```
public Optional<String> scriptName()
```
    Specified by:
    
    scriptName in class MongoShellArguments
    
    Returns:
    
    The value of the scriptName attribute
  - dbName
```
public Optional<String> dbName()
```
    Specified by:
    
    dbName in class MongoShellArguments
    
    Returns:
    
    The value of the dbName attribute
  - password
```
public Optional<String> password()
```
    Specified by:
    
    password in class MongoShellArguments
    
    Returns:
    
    The value of the password attribute
  - userName
```
public Optional<String> userName()
```
    Specified by:
    
    userName in class MongoShellArguments
    
    Returns:
    
    The value of the userName attribute
  - withScriptParameters
```
public final ImmutableMongoShellArguments 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 ImmutableMongoShellArguments 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 ImmutableMongoShellArguments withScriptName(String value)
```
    Copy the current immutable object by setting a present value for the optional scriptName attribute.
    
    Parameters:
    
    value - The value for scriptName
    
    Returns:
    
    A modified copy of this object
  - withScriptName
```
public final ImmutableMongoShellArguments withScriptName(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the scriptName 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 scriptName
    
    Returns:
    
    A modified copy of this object
  - withDbName
```
public final ImmutableMongoShellArguments withDbName(String value)
```
    Copy the current immutable object by setting a present value for the optional dbName attribute.
    
    Parameters:
    
    value - The value for dbName
    
    Returns:
    
    A modified copy of this object
  - withDbName
```
public final ImmutableMongoShellArguments withDbName(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the dbName 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 dbName
    
    Returns:
    
    A modified copy of this object
  - withPassword
```
public final ImmutableMongoShellArguments withPassword(String value)
```
    Copy the current immutable object by setting a present value for the optional password attribute.
    
    Parameters:
    
    value - The value for password
    
    Returns:
    
    A modified copy of this object
  - withPassword
```
public final ImmutableMongoShellArguments withPassword(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the password 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 password
    
    Returns:
    
    A modified copy of this object
  - withUserName
```
public final ImmutableMongoShellArguments withUserName(String value)
```
    Copy the current immutable object by setting a present value for the optional userName attribute.
    
    Parameters:
    
    value - The value for userName
    
    Returns:
    
    A modified copy of this object
  - withUserName
```
public final ImmutableMongoShellArguments withUserName(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the userName 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 userName
    
    Returns:
    
    A modified copy of this object
  - equals
```
public boolean equals(Object another)
```
    This instance is equal to all instances of ImmutableMongoShellArguments 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: scriptParameters, scriptName, dbName, password, userName.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value MongoShellArguments with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableMongoShellArguments copyOf(MongoShellArguments instance)
```
    Creates an immutable copy of a MongoShellArguments 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 MongoShellArguments instance
  - builder
```
public static ImmutableMongoShellArguments.Builder builder()
```
    Creates a builder for ImmutableMongoShellArguments.
```
 ImmutableMongoShellArguments.builder()
    .addScriptParameters|addAllScriptParameters(String) // scriptParameters elements
    .scriptName(String) // optional scriptName
    .dbName(String) // optional dbName
    .password(String) // optional password
    .userName(String) // optional userName
    .build();
 
```
    Returns:
    
    A new ImmutableMongoShellArguments builder

Class ImmutableMongoShellArguments

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

scriptParameters

scriptName

dbName

password

userName

withScriptParameters

withScriptParameters

withScriptName

withScriptName

withDbName

withDbName

withPassword

withPassword

withUserName

withUserName

equals

hashCode

toString

copyOf

builder