Record Class ModuleApiResult

java.lang.Object

java.lang.Record

de.rexlcloud.core.api.module.ModuleApiResult

Record Components:

status - what happened

message - human-readable explanation, mainly for errors

data - optional payload (for example the generated key of a new wrapper)

public record ModuleApiResult(@NonNull ModuleApiResult.Status status, @Nullable String message, @Nullable com.google.gson.JsonElement data)
extends Record

Outcome of a state-changing ModuleApi call.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ModuleApiResult.Status

Constructor Summary

Constructors

Constructor	Description
ModuleApiResult(@NonNull ModuleApiResult.Status status, @Nullable String message, @Nullable com.google.gson.JsonElement data)	Creates an instance of a ModuleApiResult record class.

Method Summary

Modifier and Type	Method	Description
static ModuleApiResult	accepted(String message)
static ModuleApiResult	conflict(String message)
@Nullable com.google.gson.JsonElement	data()	Returns the value of the data 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.
static ModuleApiResult	invalid(String message)
boolean	isSuccess()
@Nullable String	message()	Returns the value of the message record component.
static ModuleApiResult	notFound(String message)
static ModuleApiResult	ok()
static ModuleApiResult	ok(com.google.gson.JsonElement data)
static ModuleApiResult	ok(String message)
@NonNull ModuleApiResult.Status	status()	Returns the value of the status record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

ModuleApiResult

public ModuleApiResult(@NonNull
 @NonNull ModuleApiResult.Status status,
 @Nullable
 @Nullable String message,
 @Nullable
 @Nullable com.google.gson.JsonElement data)

Creates an instance of a ModuleApiResult record class.

Parameters:

status - the value for the status record component

message - the value for the message record component

data - the value for the data record component

Method Details

ok

public static ModuleApiResult ok()

ok

public static ModuleApiResult ok(com.google.gson.JsonElement data)

ok

public static ModuleApiResult ok(String message)

accepted

public static ModuleApiResult accepted(String message)

notFound

public static ModuleApiResult notFound(String message)

conflict

public static ModuleApiResult conflict(String message)

invalid

public static ModuleApiResult invalid(String message)

isSuccess

public boolean isSuccess()

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

@NonNull
public @NonNull ModuleApiResult.Status status()

Returns the value of the status record component.

Returns:

the value of the status record component

message

@Nullable
public @Nullable String message()

Returns the value of the message record component.

Returns:

the value of the message record component

data

@Nullable
public @Nullable com.google.gson.JsonElement data()

Returns the value of the data record component.

Returns:

the value of the data record component