Record Class HelpCommandSupport.HelpResult

java.lang.Object

java.lang.Record

dev.ua.theroer.magicutils.commands.HelpCommandSupport.HelpResult

Record Components:

success - true when help rendering succeeds

lines - formatted output lines

errorMessage - error message when rendering fails

Enclosing class:

HelpCommandSupport

public static record HelpCommandSupport.HelpResult(boolean success, List<String> lines, String errorMessage)
extends Record

Result of help rendering.

Constructor Summary

Constructors

Constructor	Description
HelpResult(boolean success, List<String> lines, String errorMessage)	Creates an instance of a HelpResult record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	errorMessage()	Returns the value of the errorMessage record component.
static HelpCommandSupport.HelpResult	failure(String message)
final int	hashCode()	Returns a hash code value for this object.
List<String>	lines()	Returns the value of the lines record component.
boolean	success()	Returns the value of the success record component.
static HelpCommandSupport.HelpResult	success(List<String> lines)
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

HelpResult

public HelpResult(boolean success,
 List<String> lines,
 String errorMessage)

Creates an instance of a HelpResult record class.

Parameters:

success - the value for the success record component

lines - the value for the lines record component

errorMessage - the value for the errorMessage record component

Method Details

success

public static HelpCommandSupport.HelpResult success(List<String> lines)

failure

public static HelpCommandSupport.HelpResult failure(String message)

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 the compare method from their corresponding wrapper classes.

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

public boolean success()

Returns the value of the success record component.

Returns:

the value of the success record component

lines

public List<String> lines()

Returns the value of the lines record component.

Returns:

the value of the lines record component

errorMessage

public String errorMessage()

Returns the value of the errorMessage record component.

Returns:

the value of the errorMessage record component