de.flapdoodle.embed.mongo.client

Class ImmutableUser

java.lang.Object

de.flapdoodle.embed.mongo.client.ImmutableUser

All Implemented Interfaces:

AuthenticationSetup.Entry, AuthenticationSetup.User

public final class ImmutableUser
extends Object
implements AuthenticationSetup.User

Immutable implementation of AuthenticationSetup.User.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ImmutableUser.Builder	builder() Creates a builder for ImmutableUser.
static ImmutableUser	copyOf(AuthenticationSetup.User instance) Creates an immutable copy of a AuthenticationSetup.User value.
String	database()
boolean	equals(Object another) This instance is equal to all instances of ImmutableUser that have equal attribute values.
int	hashCode() Computes a hash code from attributes: database, user, roles.
static ImmutableUser	of(String database, UsernamePassword user) Construct a new immutable User instance.
List<String>	roles()
String	toString() Prints the immutable value User with attribute values.
UsernamePassword	user()
ImmutableUser	withDatabase(String value) Copy the current immutable object by setting a value for the database attribute.
ImmutableUser	withRoles(Iterable<String> elements) Copy the current immutable object with elements that replace the content of roles.
ImmutableUser	withRoles(String... elements) Copy the current immutable object with elements that replace the content of roles.
ImmutableUser	withUser(UsernamePassword value) Copy the current immutable object by setting a value for the user attribute.

Methods inherited from class java.lang.Object

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

Method Detail

database

public String database()

Specified by:

database in interface AuthenticationSetup.User

Returns:

The value of the database attribute

user

public UsernamePassword user()

Specified by:

user in interface AuthenticationSetup.User

Returns:

The value of the user attribute

roles

public List<String> roles()

Specified by:

roles in interface AuthenticationSetup.User

Returns:

The value of the roles attribute

withDatabase

public final ImmutableUser withDatabase(String value)

Copy the current immutable object by setting a value for the database attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for database

Returns:

A modified copy of the this object

withUser

public final ImmutableUser withUser(UsernamePassword value)

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

Parameters:

value - A new value for user

Returns:

A modified copy of the this object

withRoles

public final ImmutableUser withRoles(String... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withRoles

public final ImmutableUser withRoles(Iterable<String> elements)

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

Parameters:

elements - An iterable of roles elements to set

Returns:

A modified copy of this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableUser 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: database, user, roles.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value User with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static ImmutableUser of(String database,
                               UsernamePassword user)

Construct a new immutable User instance.

Parameters:

database - The value for the database attribute

user - The value for the user attribute

Returns:

An immutable User instance

copyOf

public static ImmutableUser copyOf(AuthenticationSetup.User instance)

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

builder

public static ImmutableUser.Builder builder()

Creates a builder for ImmutableUser.

 ImmutableUser.builder()
    .database(String) // required database
    .user(de.flapdoodle.embed.mongo.client.UsernamePassword) // required user
    .addRoles|addAllRoles(String) // roles elements
    .build();
 

Returns:

A new ImmutableUser builder