de.flapdoodle.embed.mongo.client

Class ImmutableAuthenticationSetup

java.lang.Object

de.flapdoodle.embed.mongo.client.AuthenticationSetup

de.flapdoodle.embed.mongo.client.ImmutableAuthenticationSetup

public final class ImmutableAuthenticationSetup
extends AuthenticationSetup

Immutable implementation of AuthenticationSetup.

Use the builder to create immutable instances: ImmutableAuthenticationSetup.builder(). Use the static factory method to create immutable instances: ImmutableAuthenticationSetup.of().

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableAuthenticationSetup.Builder Builds instances of type ImmutableAuthenticationSetup.

Nested classes/interfaces inherited from class de.flapdoodle.embed.mongo.client.AuthenticationSetup

AuthenticationSetup.Entry, AuthenticationSetup.Role, AuthenticationSetup.User

Method Summary

Modifier and Type	Method and Description
protected UsernamePassword	admin()
static ImmutableAuthenticationSetup.Builder	builder() Creates a builder for ImmutableAuthenticationSetup.
static ImmutableAuthenticationSetup	copyOf(AuthenticationSetup instance) Creates an immutable copy of a AuthenticationSetup value.
protected List<AuthenticationSetup.Entry>	entries()
boolean	equals(Object another) This instance is equal to all instances of ImmutableAuthenticationSetup that have equal attribute values.
int	hashCode() Computes a hash code from attributes: admin, entries.
static ImmutableAuthenticationSetup	of(UsernamePassword admin) Construct a new immutable AuthenticationSetup instance.
String	toString() Prints the immutable value AuthenticationSetup with attribute values.
ImmutableAuthenticationSetup	withAdmin(UsernamePassword value) Copy the current immutable object by setting a value for the admin attribute.
ImmutableAuthenticationSetup	withEntries(AuthenticationSetup.Entry... elements) Copy the current immutable object with elements that replace the content of entries.
ImmutableAuthenticationSetup	withEntries(Iterable<? extends AuthenticationSetup.Entry> elements) Copy the current immutable object with elements that replace the content of entries.

Methods inherited from class de.flapdoodle.embed.mongo.client.AuthenticationSetup

role, user

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

admin

protected UsernamePassword admin()

Specified by:

admin in class AuthenticationSetup

Returns:

The value of the admin attribute

entries

protected List<AuthenticationSetup.Entry> entries()

Overrides:

entries in class AuthenticationSetup

Returns:

The value of the entries attribute

withAdmin

public final ImmutableAuthenticationSetup withAdmin(UsernamePassword value)

Copy the current immutable object by setting a value for the admin attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for admin

Returns:

A modified copy of the this object

withEntries

public final ImmutableAuthenticationSetup withEntries(AuthenticationSetup.Entry... elements)

Copy the current immutable object with elements that replace the content of entries.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withEntries

public final ImmutableAuthenticationSetup withEntries(Iterable<? extends AuthenticationSetup.Entry> elements)

Copy the current immutable object with elements that replace the content of entries. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of entries elements to set

Returns:

A modified copy of this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableAuthenticationSetup 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: admin, entries.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value AuthenticationSetup with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static ImmutableAuthenticationSetup of(UsernamePassword admin)

Construct a new immutable AuthenticationSetup instance.

Parameters:

admin - The value for the admin attribute

Returns:

An immutable AuthenticationSetup instance

copyOf

public static ImmutableAuthenticationSetup copyOf(AuthenticationSetup instance)

Creates an immutable copy of a AuthenticationSetup 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 AuthenticationSetup instance

builder

public static ImmutableAuthenticationSetup.Builder builder()

Creates a builder for ImmutableAuthenticationSetup.

 ImmutableAuthenticationSetup.builder()
    .admin(de.flapdoodle.embed.mongo.client.UsernamePassword) // required admin
    .addEntries|addAllEntries(de.flapdoodle.embed.mongo.client.AuthenticationSetup.Entry) // entries elements
    .build();
 

Returns:

A new ImmutableAuthenticationSetup builder