de.flapdoodle.embed.mongo.client

Class ImmutableUsernamePassword

java.lang.Object

de.flapdoodle.embed.mongo.client.ImmutableUsernamePassword

All Implemented Interfaces:

UsernamePassword

public final class ImmutableUsernamePassword
extends Object
implements UsernamePassword

Immutable implementation of UsernamePassword.

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ImmutableUsernamePassword.Builder	builder() Creates a builder for ImmutableUsernamePassword.
static ImmutableUsernamePassword	copyOf(UsernamePassword instance) Creates an immutable copy of a UsernamePassword value.
boolean	equals(Object another) This instance is equal to all instances of ImmutableUsernamePassword that have equal attribute values.
int	hashCode() Computes a hash code from attributes: name, password.
String	name()
static ImmutableUsernamePassword	of(String name, char[] password) Construct a new immutable UsernamePassword instance.
char[]	password()
String	toString() Prints the immutable value UsernamePassword with attribute values.
ImmutableUsernamePassword	withName(String value) Copy the current immutable object by setting a value for the name attribute.
ImmutableUsernamePassword	withPassword(char... elements) Copy the current immutable object with elements that replace the content of password.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.flapdoodle.embed.mongo.client.UsernamePassword

of, passwordAsString

Method Detail

name

public String name()

Specified by:

name in interface UsernamePassword

Returns:

The value of the name attribute

password

public char[] password()

Specified by:

password in interface UsernamePassword

Returns:

A cloned password array

withName

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

withPassword

public final ImmutableUsernamePassword withPassword(char... elements)

Copy the current immutable object with elements that replace the content of password. The array is cloned before being saved as attribute values.

Parameters:

elements - The non-null elements for password

Returns:

A modified copy of this object

equals

public boolean equals(Object another)

This instance is equal to all instances of ImmutableUsernamePassword 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: name, password.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value UsernamePassword with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static ImmutableUsernamePassword of(String name,
                                           char[] password)

Construct a new immutable UsernamePassword instance.

Specified by:

of in interface UsernamePassword

Parameters:

name - The value for the name attribute

password - The value for the password attribute

Returns:

An immutable UsernamePassword instance

copyOf

public static ImmutableUsernamePassword copyOf(UsernamePassword instance)

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

builder

public static ImmutableUsernamePassword.Builder builder()

Creates a builder for ImmutableUsernamePassword.

 ImmutableUsernamePassword.builder()
    .name(String) // required name
    .password(char) // required password
    .build();
 

Returns:

A new ImmutableUsernamePassword builder