uk.co.visalia.brightpearl.apiclient.account

Class UserCredentials

java.lang.Object

uk.co.visalia.brightpearl.apiclient.account.UserCredentials

All Implemented Interfaces:

Serializable

public final class UserCredentials
extends Object
implements Serializable

Contains the email address and password of an account user with API access to be used for authentication.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserCredentials(String emailAddress, String password) Create an immutable credentials instance with a supplied email address and password.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getEmailAddress() Returns the email address.
String	getPassword() Returns the password.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UserCredentials

public UserCredentials(String emailAddress,
               String password)

Create an immutable credentials instance with a supplied email address and password.

Parameters:

emailAddress - Email address of a user account within a Brightpearl customer account. Must be a non-empty string.

password - The user's password. Must be a non-empty string.

Method Detail

getEmailAddress

public String getEmailAddress()

Returns the email address.

Returns:

the email address.

getPassword

public String getPassword()

Returns the password.

Returns:

the password.

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