Package dev.turboism.sdk.storage

Record Class StorageError

java.lang.Object

java.lang.Record

dev.turboism.sdk.storage.StorageError

Record Components:

code - stable category suitable for programmatic handling

message - non-blank, sanitized diagnostic text

path - confined logical path to which the error applies, not a host filesystem path

public record StorageError(StorageErrorCode code, String message, StoragePath path)
extends Record

Structured storage failure associated with the logical source or target path of an operation.

Constructor Summary

Constructors

Constructor	Description
StorageError(StorageErrorCode code, String message, StoragePath path)	Validates the error components.

Method Summary

Modifier and Type	Method	Description
StorageErrorCode	code()	Returns the value of the code record component.
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	message()	Returns the value of the message record component.
StoragePath	path()	Returns the value of the path 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

StorageError

public StorageError(StorageErrorCode code,
 String message,
 StoragePath path)

Validates the error components.

Parameters:

code - stable storage error category

message - sanitized diagnostic text

path - confined logical path associated with the error

Throws:

NullPointerException - if a component is null

IllegalArgumentException - if message is blank

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.

code

public StorageErrorCode code()

Returns the value of the code record component.

Returns:

the value of the code record component

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component

path

public StoragePath path()

Returns the value of the path record component.

Returns:

the value of the path record component