ImmutableLoginResponse (FFB Depot Client 0.2.0 API)

java.lang.Object
- de.bmarwell.ffb.depot.client.json.ImmutableLoginResponse

All Implemented Interfaces:

LoginResponse
```
@Generated(value={"Immutables.generator","LoginResponse"})
public final class ImmutableLoginResponse
extends Object
implements LoginResponse
```
Immutable implementation of LoginResponse.
Use the builder to create immutable instances: ImmutableLoginResponse.builder().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ImmutableLoginResponse.Builder
Builds instances of type ImmutableLoginResponse.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ImmutableLoginResponse.Builder` Builds instances of type `ImmutableLoginResponse`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImmutableLoginResponse.Builder`	`builder()` Creates a builder for `ImmutableLoginResponse`.
`static ImmutableLoginResponse`	`copyOf(LoginResponse instance)` Creates an immutable copy of a `LoginResponse` value.
`boolean`	`equals(Object another)` This instance is equal to all instances of `ImmutableLoginResponse` that have equal attribute values.
`boolean`	`getAgbAgreed()`
`Optional<String>`	`getErrormessage()` Error message set by FFB.
`String`	`getFirstname()` The customers first name.
`String`	`getLastname()` The customers last name.
`String`	`getUsername()` The name of the user.
`String`	`getUsertype()` The type of the user.
`int`	`hashCode()` Computes a hash code from attributes: `isLoggedIn`, `username`, `firstname`, `lastname`, `usertype`, `errormessage`, `agbAgreed`.
`boolean`	`isLoggedIn()`
`String`	`toString()` Prints the immutable value `LoginResponse` with attribute values.
`ImmutableLoginResponse`	`withAgbAgreed(boolean value)` Copy the current immutable object by setting a value for the `agbAgreed` attribute.
`ImmutableLoginResponse`	`withErrormessage(Optional<String> optional)` Copy the current immutable object by setting an optional value for the `errormessage` attribute.
`ImmutableLoginResponse`	`withErrormessage(String value)` Copy the current immutable object by setting a present value for the optional `errormessage` attribute.
`ImmutableLoginResponse`	`withFirstname(String value)` Copy the current immutable object by setting a value for the `firstname` attribute.
`ImmutableLoginResponse`	`withIsLoggedIn(boolean value)` Copy the current immutable object by setting a value for the `isLoggedIn` attribute.
`ImmutableLoginResponse`	`withLastname(String value)` Copy the current immutable object by setting a value for the `lastname` attribute.
`ImmutableLoginResponse`	`withUsername(String value)` Copy the current immutable object by setting a value for the `username` attribute.
`ImmutableLoginResponse`	`withUsertype(String value)` Copy the current immutable object by setting a value for the `usertype` attribute.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - isLoggedIn
```
public boolean isLoggedIn()
```
    Specified by:
    
    isLoggedIn in interface LoginResponse
    
    Returns:
    
    The value of the isLoggedIn attribute
  - getUsername
```
public String getUsername()
```
    The name of the user.
    
    Specified by:
    
    getUsername in interface LoginResponse
    
    Returns:
    
    the username.
  - getFirstname
```
public String getFirstname()
```
    The customers first name.
    
    Specified by:
    
    getFirstname in interface LoginResponse
    
    Returns:
    
    the first name.
  - getLastname
```
public String getLastname()
```
    The customers last name.
    
    Specified by:
    
    getLastname in interface LoginResponse
    
    Returns:
    
    the last name.
  - getUsertype
```
public String getUsertype()
```
    The type of the user.
    Known values:
    - Customer
    Specified by:
    
    getUsertype in interface LoginResponse
    
    Returns:
    
    the user type.
  - getErrormessage
```
public Optional<String> getErrormessage()
```
    Error message set by FFB.
    
    Specified by:
    
    getErrormessage in interface LoginResponse
    
    Returns:
    
    the error message.
  - getAgbAgreed
```
public boolean getAgbAgreed()
```
    Specified by:
    
    getAgbAgreed in interface LoginResponse
    
    Returns:
    
    The value of the agbAgreed attribute
  - withIsLoggedIn
```
public final ImmutableLoginResponse withIsLoggedIn(boolean value)
```
    Copy the current immutable object by setting a value for the isLoggedIn attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for isLoggedIn
    
    Returns:
    
    A modified copy of the this object
  - withUsername
```
public final ImmutableLoginResponse withUsername(String value)
```
    Copy the current immutable object by setting a value for the username attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for username
    
    Returns:
    
    A modified copy of the this object
  - withFirstname
```
public final ImmutableLoginResponse withFirstname(String value)
```
    Copy the current immutable object by setting a value for the firstname attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for firstname
    
    Returns:
    
    A modified copy of the this object
  - withLastname
```
public final ImmutableLoginResponse withLastname(String value)
```
    Copy the current immutable object by setting a value for the lastname attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for lastname
    
    Returns:
    
    A modified copy of the this object
  - withUsertype
```
public final ImmutableLoginResponse withUsertype(String value)
```
    Copy the current immutable object by setting a value for the usertype attribute. An equals check used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for usertype
    
    Returns:
    
    A modified copy of the this object
  - withErrormessage
```
public final ImmutableLoginResponse withErrormessage(String value)
```
    Copy the current immutable object by setting a present value for the optional errormessage attribute.
    
    Parameters:
    
    value - The value for errormessage
    
    Returns:
    
    A modified copy of this object
  - withErrormessage
```
public final ImmutableLoginResponse withErrormessage(Optional<String> optional)
```
    Copy the current immutable object by setting an optional value for the errormessage attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
    
    Parameters:
    
    optional - A value for errormessage
    
    Returns:
    
    A modified copy of this object
  - withAgbAgreed
```
public final ImmutableLoginResponse withAgbAgreed(boolean value)
```
    Copy the current immutable object by setting a value for the agbAgreed attribute. A value equality check is used to prevent copying of the same value by returning this.
    
    Parameters:
    
    value - A new value for agbAgreed
    
    Returns:
    
    A modified copy of the this object
  - equals
```
public boolean equals(Object another)
```
    This instance is equal to all instances of ImmutableLoginResponse 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: isLoggedIn, username, firstname, lastname, usertype, errormessage, agbAgreed.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    hashCode value
  - toString
```
public String toString()
```
    Prints the immutable value LoginResponse with attribute values.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the value
  - copyOf
```
public static ImmutableLoginResponse copyOf(LoginResponse instance)
```
    Creates an immutable copy of a LoginResponse 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 LoginResponse instance
  - builder
```
public static ImmutableLoginResponse.Builder builder()
```
    Creates a builder for ImmutableLoginResponse.
    
    Specified by:
    
    builder in interface LoginResponse
    
    Returns:
    
    A new ImmutableLoginResponse builder

Class ImmutableLoginResponse

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isLoggedIn

getUsername

getFirstname

getLastname

getUsertype

getErrormessage

getAgbAgreed

withIsLoggedIn

withUsername

withFirstname

withLastname

withUsertype

withErrormessage

withErrormessage

withAgbAgreed

equals

hashCode

toString

copyOf

builder