Package com.tnsai.channels.model

Record Class ChannelError

java.lang.Object

java.lang.Record

com.tnsai.channels.model.ChannelError

Record Components:

channelId - which adapter produced the error

severity - how critical the error is

message - human-readable description

cause - underlying exception (may be null)

timestamp - when the error occurred

public record ChannelError(String channelId, ChannelError.Severity severity, String message, Throwable cause, Instant timestamp)
extends Record

Represents an error that occurred within a channel adapter.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ChannelError.Severity

Constructor Summary

Constructors

Constructor	Description
ChannelError(String channelId, ChannelError.Severity severity, String message, Throwable cause, Instant timestamp)	Creates an instance of a ChannelError record class.

Method Summary

Modifier and Type	Method	Description
Throwable	cause()	Returns the value of the cause record component.
String	channelId()	Returns the value of the channelId record component.
static ChannelError	degraded(String channelId, String message, Throwable cause)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static ChannelError	fatal(String channelId, String message, Throwable cause)
final int	hashCode()	Returns a hash code value for this object.
String	message()	Returns the value of the message record component.
ChannelError.Severity	severity()	Returns the value of the severity record component.
Instant	timestamp()	Returns the value of the timestamp record component.
final String	toString()	Returns a string representation of this record class.
static ChannelError	transient_(String channelId, String message, Throwable cause)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ChannelError

public ChannelError(String channelId,
 ChannelError.Severity severity,
 String message,
 Throwable cause,
 Instant timestamp)

Creates an instance of a ChannelError record class.

Parameters:

channelId - the value for the channelId record component

severity - the value for the severity record component

message - the value for the message record component

cause - the value for the cause record component

timestamp - the value for the timestamp record component

Method Details

transient_

public static ChannelError transient_(String channelId,
 String message,
 Throwable cause)

degraded

public static ChannelError degraded(String channelId,
 String message,
 Throwable cause)

fatal

public static ChannelError fatal(String channelId,
 String message,
 Throwable cause)

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.

channelId

public String channelId()

Returns the value of the channelId record component.

Returns:

the value of the channelId record component

severity

public ChannelError.Severity severity()

Returns the value of the severity record component.

Returns:

the value of the severity record component

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component

cause

public Throwable cause()

Returns the value of the cause record component.

Returns:

the value of the cause record component

timestamp

public Instant timestamp()

Returns the value of the timestamp record component.

Returns:

the value of the timestamp record component