org.springframework.geode.core.env.support

Class User

java.lang.Object

org.springframework.geode.core.env.support.User

All Implemented Interfaces:

java.lang.Comparable<User>

public class User
extends java.lang.Object
implements java.lang.Comparable<User>

The User class is an Abstract Data Type (ADT) modeling a user in Pivotal CloudFoundry (PCF).

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	User.Role

Method Summary

Modifier and Type	Method and Description
int	compareTo(User other)
boolean	equals(java.lang.Object obj)
java.lang.String	getName() Returns the name of this User.
java.util.Optional<java.lang.String>	getPassword() Returns an Optional String containing User's password.
java.util.Optional<User.Role>	getRole() Returns an Optional User.Role for this User.
int	hashCode()
java.lang.String	toString()
static User	with(java.lang.String name) Factory method used to construct a new User initialized with the given name.
User	withPassword(java.lang.String password) Builder method used to set this User's password.
User	withRole(User.Role role) Builder method used to set this User's User.Role.

Methods inherited from class java.lang.Object

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

Method Detail

with

public static User with(java.lang.String name)

Factory method used to construct a new User initialized with the given name.

Parameters:

name - String containing the name of the User.

Returns:

a new User initialized witht he given name.

Throws:

java.lang.IllegalArgumentException - if name is null or empty.

See Also:

User(String)

getName

public java.lang.String getName()

Returns the name of this User.

Returns:

a String containing the User's name.

getPassword

public java.util.Optional<java.lang.String> getPassword()

Returns an Optional String containing User's password.

Returns:

an Optional String containing User's password.

See Also:

Optional

getRole

public java.util.Optional<User.Role> getRole()

Returns an Optional User.Role for this User.

Returns:

an Optional User.Role for this User.

See Also:

User.Role, Optional

withPassword

public User withPassword(java.lang.String password)

Builder method used to set this User's password.

Parameters:

password - String containing this User's password.

Returns:

this User.

withRole

public User withRole(User.Role role)

Builder method used to set this User's User.Role.

Parameters:

role - assigned User.Role of this User.

Returns:

this User.

See Also:

User

compareTo

public int compareTo(User other)

Specified by:

compareTo in interface java.lang.Comparable<User>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object