de.flapdoodle.embed.mongo.client

Class ImmutableUser.Builder

java.lang.Object

de.flapdoodle.embed.mongo.client.ImmutableUser.Builder

Enclosing class:

ImmutableUser

public static final class ImmutableUser.Builder
extends Object

Builds instances of type ImmutableUser. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method and Description
ImmutableUser.Builder	addAllRoles(Iterable<String> elements) Adds elements to roles list.
ImmutableUser.Builder	addRoles(String... elements) Adds elements to roles list.
ImmutableUser.Builder	addRoles(String element) Adds one element to roles list.
ImmutableUser	build() Builds a new ImmutableUser.
ImmutableUser.Builder	database(String database) Initializes the value for the database attribute.
ImmutableUser.Builder	from(AuthenticationSetup.User instance) Fill a builder with attribute values from the provided User instance.
ImmutableUser.Builder	roles(Iterable<String> elements) Sets or replaces all elements for roles list.
ImmutableUser.Builder	user(UsernamePassword user) Initializes the value for the user attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public final ImmutableUser.Builder from(AuthenticationSetup.User instance)

Fill a builder with attribute values from the provided User instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

database

public final ImmutableUser.Builder database(String database)

Initializes the value for the database attribute.

Parameters:

database - The value for database

Returns:

this builder for use in a chained invocation

user

public final ImmutableUser.Builder user(UsernamePassword user)

Initializes the value for the user attribute.

Parameters:

user - The value for user

Returns:

this builder for use in a chained invocation

addRoles

public final ImmutableUser.Builder addRoles(String element)

Adds one element to roles list.

Parameters:

element - A roles element

Returns:

this builder for use in a chained invocation

addRoles

public final ImmutableUser.Builder addRoles(String... elements)

Adds elements to roles list.

Parameters:

elements - An array of roles elements

Returns:

this builder for use in a chained invocation

roles

public final ImmutableUser.Builder roles(Iterable<String> elements)

Sets or replaces all elements for roles list.

Parameters:

elements - An iterable of roles elements

Returns:

this builder for use in a chained invocation

addAllRoles

public final ImmutableUser.Builder addAllRoles(Iterable<String> elements)

Adds elements to roles list.

Parameters:

elements - An iterable of roles elements

Returns:

this builder for use in a chained invocation

build

public ImmutableUser build()

Builds a new ImmutableUser.

Returns:

An immutable instance of User

Throws:

IllegalStateException - if any required attributes are missing