Package de.florianmichael.classic4j.model.classicube.account

Record Class CCAuthenticationData

java.lang.Object

java.lang.Record

de.florianmichael.classic4j.model.classicube.account.CCAuthenticationData

public record CCAuthenticationData(String username, String password, String previousToken, String loginCode)
extends Record

This class represents the data needed to authenticate with the ClassiCube server list. It is used by ClassiCubeHandler.

Constructor Summary

Constructors

Constructor	Description
CCAuthenticationData(String username, String password, String previousToken)
CCAuthenticationData(String username, String password, String previousToken, String loginCode)	Creates an instance of a CCAuthenticationData record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	loginCode()	Returns the value of the loginCode record component.
String	password()	Returns the value of the password record component.
String	previousToken()	Returns the value of the previousToken record component.
final String	toString()	Returns a string representation of this record class.
String	username()	Returns the value of the username record component.
CCAuthenticationData	withLoginCode(String loginCode)	Creates a new CCAuthenticationData with the given loginCode.

Methods inherited from class java.lang.Object

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

Constructor Details

CCAuthenticationData

public CCAuthenticationData(String username,
 String password,
 String previousToken)

CCAuthenticationData

public CCAuthenticationData(String username,
 String password,
 String previousToken,
 String loginCode)

Creates an instance of a CCAuthenticationData record class.

Parameters:

username - the value for the username record component

password - the value for the password record component

previousToken - the value for the previousToken record component

loginCode - the value for the loginCode record component

Method Details

withLoginCode

public CCAuthenticationData withLoginCode(String loginCode)

Creates a new CCAuthenticationData with the given loginCode. This is used for two-factor authentication.

Parameters:

loginCode - The login code.

Returns:

The created CCAuthenticationData.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

username

public String username()

Returns the value of the username record component.

Returns:

the value of the username record component

password

public String password()

Returns the value of the password record component.

Returns:

the value of the password record component

previousToken

public String previousToken()

Returns the value of the previousToken record component.

Returns:

the value of the previousToken record component

loginCode

public String loginCode()

Returns the value of the loginCode record component.

Returns:

the value of the loginCode record component