Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.util

Class Result<Type>

java.lang.Object

page.codeberg.friedolyn.util.Result<Type>

Type Parameters:

Type - The class of the operation's result.

public class Result<Type>
extends Object

Represents the outcome of an operation that is either successful or unsuccessful and may return an elaborate result.

Field Summary

Fields

Modifier and Type	Field	Description
private final Type	RESULT	The detailed outcome of the operation.
private final boolean	SUCCESS	Whether the operation was successful.

Constructor Summary

Constructors

Constructor	Description
Result(boolean success)	Creates a new result object with no elaborate return value.
Result(boolean success, Type result)	Creates a new result object.

Method Summary

Modifier and Type	Method	Description
Optional<Type>	getResult()
boolean	getSuccess()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SUCCESS

private final boolean SUCCESS

Whether the operation was successful. Success does not imply that an elaborate result was returned, and failure does not imply that no elaborate result was returned.

RESULT

@Nullable
private final Type RESULT

The detailed outcome of the operation. Its presence does not imply that the operation was successful, and its absence does not imply that the operation was unsuccessful.

Constructor Details

Result

public Result(boolean success)

Creates a new result object with no elaborate return value. Use Result(boolean, Type) if there is an elaborate return value that should be included.

Parameters:

success - True if the operation was successful, false otherwise.

See Also:

• Result(boolean, Type)

Result

public Result(boolean success,
 @NonNull
 Type result)

Creates a new result object.

Parameters:

success - True if the operation was successful, false otherwise.

result - The elaborate return value of the operation. Must not be null. Use Result(boolean) if there is no elaborate return value.

See Also:

• Result(boolean)

Method Details

getSuccess

public boolean getSuccess()

Returns:

Whether the operation was successful. If true, this does not imply that getResult() will return a non-empty value. If false, this does not imply that getResult() will return an empty value.

getResult

public Optional<Type> getResult()

Returns:

The elaborate return value of the operation, if any. If it is present, this does not imply that the operation was successful. If it is absent, this does not imply that the operation was unsuccessful.