is.codion.common.user

Interface User

public interface User

Encapsulates a username and password. Factory class for User instances. Note that a User instance is mutable as the password can be set and cleared.

Method Summary

Modifier and Type	Method and Description
void	clearPassword() Clears the password
char[]	getPassword()
static User	parse(String userPassword) Parses a User from a string, containing a username and password with a single ':' as delimiter, i.e.
void	setPassword(char[] password)
static User	user(String username) Creates a new User with an empty password.
static User	user(String username, char[] password) Creates a new User.
String	username()

Method Detail

username

String username()

Returns:

the username

setPassword

void setPassword(char[] password)

Parameters:

password - the password, null in case of an empty password

getPassword

char[] getPassword()

Returns:

the password, an empty array in case of an empty password

clearPassword

void clearPassword()

Clears the password

user

static User user(String username)

Creates a new User with an empty password.

Parameters:

username - the username

Returns:

a new User

user

static User user(String username,
                 char[] password)

Creates a new User.

Parameters:

username - the username

password - the password

Returns:

a new User

parse

static User parse(String userPassword)

Parses a User from a string, containing a username and password with a single ':' as delimiter, i.e. "user:pass" or "user:" for en empty password. If no delimiter is found the whole string is assumed to be the username and the password empty. The username portion is trimmed. Any delimeters beyond the initial one are assumed to be part of the password.

Parameters:

userPassword - the username and password string

Returns:

a User with the given username and password