Module dev.eidentification.bankid

Package dev.eidentification.bankid.client.request

Record Class CancelRequest

java.lang.Object

java.lang.Record

dev.eidentification.bankid.client.request.CancelRequest

Record Components:

orderRef - The orderRef retrieved from a order response

All Implemented Interfaces:

Request

public record CancelRequest(String orderRef)
extends Record
implements Request

Request to cancel an ongoing sign or auth order.

Constructor Summary

Constructors

Constructor	Description
CancelRequest(String orderRef)	Creates a CancelRequest.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	getUri()	Returns the URI associated with the request.
final int	hashCode()	Returns a hash code value for this object.
String	orderRef()	Returns the value of the orderRef record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

CancelRequest

public CancelRequest(String orderRef)

Creates a CancelRequest.

Parameters:

orderRef - The orderRef retrieved from a order response. Must not be null

Throws:

NullPointerException - if orderRef is null

Method Details

getUri

public String getUri()

Description copied from interface: Request

Returns the URI associated with the request.

Specified by:

getUri in interface Request

Returns:

The URI of the request.

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.

orderRef

public String orderRef()

Returns the value of the orderRef record component.

Returns:

the value of the orderRef record component