org.springframework.data.redis.connection

Class RedisPassword

java.lang.Object

org.springframework.data.redis.connection.RedisPassword

public class RedisPassword
extends Object

Value object which may or may not contain a Redis password.

If a password is present, isPresent() will return true and get() will return the value.

The password is stored as character array.

Since:

2.0

Author:

Mark Paluch, Christoph Strobl

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
char[]	get() Return the password value if present.
int	hashCode()
boolean	isPresent() Return true if there is a password present, otherwise false.
<R> Optional<R>	map(Function<char[],R> mapper) Map the password using a Function and return a Optional containing the mapped value.
static RedisPassword	none() Create an absent RedisPassword.
static RedisPassword	of(char[] passwordAsChars) Create a RedisPassword from a char array.
static RedisPassword	of(String passwordAsString) Create a RedisPassword from a String.
Optional<char[]>	toOptional() Adopt the password to Optional containing the password value.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

of

public static RedisPassword of(@Nullable
                               String passwordAsString)

Create a RedisPassword from a String.

Parameters:

passwordAsString - the password as string.

Returns:

the RedisPassword for passwordAsString.

of

public static RedisPassword of(@Nullable
                               char[] passwordAsChars)

Create a RedisPassword from a char array.

Parameters:

passwordAsChars - the password as char array.

Returns:

the RedisPassword for passwordAsChars.

none

public static RedisPassword none()

Create an absent RedisPassword.

Returns:

the absent RedisPassword.

isPresent

public boolean isPresent()

Return true if there is a password present, otherwise false.

Returns:

true if there is a password present, otherwise false

get

public char[] get()
           throws NoSuchElementException

Return the password value if present. Throws NoSuchElementException if the password is absent.

Returns:

the password.

Throws:

NoSuchElementException - if the password is absent.

map

public <R> Optional<R> map(Function<char[],R> mapper)

Map the password using a Function and return a Optional containing the mapped value.

Absent passwords return a Optional.empty().

Parameters:

mapper - must not be null.

Returns:

the mapped result.

toOptional

public Optional<char[]> toOptional()

Adopt the password to Optional containing the password value.

Absent passwords return a Optional.empty().

Returns:

the Optional containing the password value.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object