de.flapdoodle.embed.mongo.client

Class ImmutableRole

java.lang.Object

de.flapdoodle.embed.mongo.client.ImmutableRole

All Implemented Interfaces:

AuthenticationSetup.Entry, AuthenticationSetup.Role

public final class ImmutableRole
extends Object
implements AuthenticationSetup.Role

Immutable implementation of AuthenticationSetup.Role.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
List<String>	actions()
static ImmutableRole.Builder	builder() Creates a builder for ImmutableRole.
String	collection()
static ImmutableRole	copyOf(AuthenticationSetup.Role instance) Creates an immutable copy of a AuthenticationSetup.Role value.
String	database()
boolean	equals(Object another) This instance is equal to all instances of ImmutableRole that have equal attribute values.
int	hashCode() Computes a hash code from attributes: database, collection, name, actions.
String	name()
static ImmutableRole	of(String database, String collection, String name) Construct a new immutable Role instance.
String	toString() Prints the immutable value Role with attribute values.
ImmutableRole	withActions(Iterable<String> elements) Copy the current immutable object with elements that replace the content of actions.
ImmutableRole	withActions(String... elements) Copy the current immutable object with elements that replace the content of actions.
ImmutableRole	withCollection(String value) Copy the current immutable object by setting a value for the collection attribute.
ImmutableRole	withDatabase(String value) Copy the current immutable object by setting a value for the database attribute.
ImmutableRole	withName(String value) Copy the current immutable object by setting a value for the name 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.Role

Returns:

The value of the database attribute

collection

public String collection()

Specified by:

collection in interface AuthenticationSetup.Role

Returns:

The value of the collection attribute

name

public String name()

Specified by:

name in interface AuthenticationSetup.Role

Returns:

The value of the name attribute

actions

public List<String> actions()

Specified by:

actions in interface AuthenticationSetup.Role

Returns:

The value of the actions attribute

withDatabase

public final ImmutableRole 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

withCollection

public final ImmutableRole withCollection(String value)

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

Parameters:

value - A new value for collection

Returns:

A modified copy of the this object

withName

public final ImmutableRole withName(String value)

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

Parameters:

value - A new value for name

Returns:

A modified copy of the this object

withActions

public final ImmutableRole withActions(String... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withActions

public final ImmutableRole withActions(Iterable<String> elements)

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

Parameters:

elements - An iterable of actions elements to set

Returns:

A modified copy of this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableRole 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, collection, name, actions.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value Role with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static ImmutableRole of(String database,
                               String collection,
                               String name)

Construct a new immutable Role instance.

Parameters:

database - The value for the database attribute

collection - The value for the collection attribute

name - The value for the name attribute

Returns:

An immutable Role instance

copyOf

public static ImmutableRole copyOf(AuthenticationSetup.Role instance)

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

builder

public static ImmutableRole.Builder builder()

Creates a builder for ImmutableRole.

 ImmutableRole.builder()
    .database(String) // required database
    .collection(String) // required collection
    .name(String) // required name
    .addActions|addAllActions(String) // actions elements
    .build();
 

Returns:

A new ImmutableRole builder