Package gg.xp.xivsupport.groovy

Record Class GroovyScriptResult

java.lang.Object

java.lang.Record

gg.xp.xivsupport.groovy.GroovyScriptResult

public record GroovyScriptResult(@Nullable Object result, @Nullable Throwable failure, boolean success, DisplayControl displayControl)
extends Record

Constructor Summary

Constructors

Constructor	Description
GroovyScriptResult(@Nullable Object result, @Nullable Throwable failure, boolean success, DisplayControl displayControl)	Creates an instance of a GroovyScriptResult record class.

Method Summary

Modifier and Type	Method	Description
DisplayControl	displayControl()	Returns the value of the displayControl record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@Nullable Throwable	failure()	Returns the value of the failure record component.
static GroovyScriptResult	failure(DisplayControl dc, @Nullable Throwable failure)
final int	hashCode()	Returns a hash code value for this object.
@Nullable Object	result()	Returns the value of the result record component.
boolean	success()	Returns the value of the success record component.
static GroovyScriptResult	success(DisplayControl dc, @Nullable Object value)
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

GroovyScriptResult

public GroovyScriptResult(@Nullable
 @Nullable Object result,
 @Nullable
 @Nullable Throwable failure,
 boolean success,
 DisplayControl displayControl)

Creates an instance of a GroovyScriptResult record class.

Parameters:

result - the value for the result record component

failure - the value for the failure record component

success - the value for the success record component

displayControl - the value for the displayControl record component

Method Details

success

public static GroovyScriptResult success(DisplayControl dc,
 @Nullable
 @Nullable Object value)

failure

public static GroovyScriptResult failure(DisplayControl dc,
 @Nullable
 @Nullable Throwable failure)

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

result

@Nullable
public @Nullable Object result()

Returns the value of the result record component.

Returns:

the value of the result record component

failure

@Nullable
public @Nullable Throwable failure()

Returns the value of the failure record component.

Returns:

the value of the failure record component

success

public boolean success()

Returns the value of the success record component.

Returns:

the value of the success record component

displayControl

public DisplayControl displayControl()

Returns the value of the displayControl record component.

Returns:

the value of the displayControl record component