Record Class QCommandMetadata

java.lang.Object

java.lang.Record

com.io7m.quarrel.core.QCommandMetadata

Record Components:

name - The name

shortDescription - The short description

longDescription - The long description

public record QCommandMetadata(String name, QStringType shortDescription, Optional<QStringType> longDescription)
extends Record

The metadata for a command.

Constructor Summary

Constructors

Constructor	Description
QCommandMetadata(String name, QStringType shortDescription, Optional<QStringType> longDescription)	The metadata for a command.

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.
Optional<QStringType>	longDescription()	Returns the value of the longDescription record component.
String	name()	Returns the value of the name record component.
QStringType	shortDescription()	Returns the value of the shortDescription 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

QCommandMetadata

public QCommandMetadata(String name,
 QStringType shortDescription,
 Optional<QStringType> longDescription)

The metadata for a command.

Parameters:

name - The name

shortDescription - The short description

longDescription - The long description

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.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

shortDescription

public QStringType shortDescription()

Returns the value of the shortDescription record component.

Returns:

the value of the shortDescription record component

longDescription

public Optional<QStringType> longDescription()

Returns the value of the longDescription record component.

Returns:

the value of the longDescription record component