Package com.amalgamasimulation.utils

Record Class ConnectivityDiagnosis

java.lang.Object

java.lang.Record

com.amalgamasimulation.utils.ConnectivityDiagnosis

Record Components:

status - check outcome

httpStatus - non-success HTTP status, or null

cause - connection failure, or null

public record ConnectivityDiagnosis(ConnectivityDiagnosis.Status status, Integer httpStatus, Throwable cause)
extends Record

Detailed result of a server connectivity check.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ConnectivityDiagnosis.Status

Constructor Summary

Constructors

Constructor	Description
ConnectivityDiagnosis(ConnectivityDiagnosis.Status status, Integer httpStatus, Throwable cause)	Creates an instance of a ConnectivityDiagnosis record class.

Method Summary

Modifier and Type	Method	Description
Throwable	cause()	Returns the value of the cause record component.
static ConnectivityDiagnosis	connectionError(Throwable cause)
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.
static ConnectivityDiagnosis	httpError(int statusCode)
Integer	httpStatus()	Returns the value of the httpStatus record component.
static ConnectivityDiagnosis	invalidResponse()
boolean	isOk()
static ConnectivityDiagnosis	ok()
ConnectivityDiagnosis.Status	status()	Returns the value of the status record component.
final String	toString()	Returns a string representation of this record class.
static ConnectivityDiagnosis	unavailable()

Methods inherited from class java.lang.Object

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

Constructor Details

ConnectivityDiagnosis

public ConnectivityDiagnosis(ConnectivityDiagnosis.Status status,
 Integer httpStatus,
 Throwable cause)

Creates an instance of a ConnectivityDiagnosis record class.

Parameters:

status - the value for the status record component

httpStatus - the value for the httpStatus record component

cause - the value for the cause record component

Method Details

isOk

public boolean isOk()

ok

public static ConnectivityDiagnosis ok()

httpError

public static ConnectivityDiagnosis httpError(int statusCode)

connectionError

public static ConnectivityDiagnosis connectionError(Throwable cause)

invalidResponse

public static ConnectivityDiagnosis invalidResponse()

unavailable

public static ConnectivityDiagnosis unavailable()

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.

status

public ConnectivityDiagnosis.Status status()

Returns the value of the status record component.

Returns:

the value of the status record component

httpStatus

public Integer httpStatus()

Returns the value of the httpStatus record component.

Returns:

the value of the httpStatus record component

cause

public Throwable cause()

Returns the value of the cause record component.

Returns:

the value of the cause record component