Record Class CJ1StructuredError

java.lang.Object

java.lang.Record

com.io7m.cardant.protocol.inventory.json.internal.CJ1StructuredError

All Implemented Interfaces:

CJ1ValueType

@JsonClassDescription("A structured error value.")
public record CJ1StructuredError(String errorCode, String message, Map<String,String> attributes, Optional<String> remediatingAction)
extends Record
implements CJ1ValueType

Constructor Summary

Constructors

Constructor	Description
CJ1StructuredError(String errorCode, String message, Map<String,String> attributes, Optional<String> remediatingAction)	Creates an instance of a CJ1StructuredError record class.

Method Summary

Modifier and Type	Method	Description
Map<String,String>	attributes()	Returns the value of the attributes record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	errorCode()	Returns the value of the errorCode record component.
final int	hashCode()	Returns a hash code value for this object.
String	message()	Returns the value of the message record component.
Optional<String>	remediatingAction()	Returns the value of the remediatingAction 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

CJ1StructuredError

public CJ1StructuredError(@JsonPropertyDescription("The error code.")
 String errorCode,
 @JsonPropertyDescription("The error message.")
 String message,
 @JsonPropertyDescription("The error attributes.")
 Map<String,String> attributes,
 @JsonPropertyDescription("The remediating action.")
 Optional<String> remediatingAction)

Creates an instance of a CJ1StructuredError record class.

Parameters:

errorCode - the value for the errorCode record component

message - the value for the message record component

attributes - the value for the attributes record component

remediatingAction - the value for the remediatingAction record component

Method Details

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.

errorCode

@JsonPropertyDescription("The error code.")
public String errorCode()

Returns the value of the errorCode record component.

Returns:

the value of the errorCode record component

message

@JsonPropertyDescription("The error message.")
public String message()

Returns the value of the message record component.

Returns:

the value of the message record component

attributes

@JsonPropertyDescription("The error attributes.")
public Map<String,String> attributes()

Returns the value of the attributes record component.

Returns:

the value of the attributes record component

remediatingAction

@JsonPropertyDescription("The remediating action.")
public Optional<String> remediatingAction()

Returns the value of the remediatingAction record component.

Returns:

the value of the remediatingAction record component