Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.gui

Record Class GUI.DialogResult<ResultType>

java.lang.Object

java.lang.Record

page.codeberg.friedolyn.gui.GUI.DialogResult<ResultType>

Type Parameters:

ResultType - The type of the result that the user has entered.

Record Components:

success - Whether the user has successfully entered valid information and closed the window.

result - The actual value(s) that the user has entered. If the user has not entered any information or closed the window without entering anything, this will be an empty Optional.

Enclosing class:

GUI

public static record GUI.DialogResult<ResultType>(@NonNull FuzzyBoolean success, @NonNull Optional<ResultType> result)
extends Record

A record that represents the user's input in a dialog window.

Field Summary

Fields

Modifier and Type	Field	Description
private final @NonNull Optional<ResultType>	result	The field for the result record component.
private final @NonNull FuzzyBoolean	success	The field for the success record component.

Constructor Summary

Constructors

Constructor	Description
DialogResult(@NonNull FuzzyBoolean success, @NonNull Optional<ResultType> result)	Creates an instance of a DialogResult record class.

Method Summary

Modifier and Type	Method	Description
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.
@NonNull Optional<ResultType>	result()	Returns the value of the result record component.
@NonNull FuzzyBoolean	success()	Returns the value of the success 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

Field Details

success

@NonNull
private final @NonNull FuzzyBoolean success

The field for the success record component.

result

@NonNull
private final @NonNull Optional<ResultType> result

The field for the result record component.

Constructor Details

DialogResult

public DialogResult(@NonNull
 @NonNull FuzzyBoolean success,
 @NonNull
 @NonNull Optional<ResultType> result)

Creates an instance of a DialogResult record class.

Parameters:

success - the value for the success record component

result - the value for the result 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.

success

@NonNull
public @NonNull FuzzyBoolean success()

Returns the value of the success record component.

Returns:

the value of the success record component

result

@NonNull
public @NonNull Optional<ResultType> result()

Returns the value of the result record component.

Returns:

the value of the result record component