Record Class ParameterDescription

java.lang.Object

java.lang.Record

com.github.kaktushose.jda.commands.definitions.description.ParameterDescription

Record Components:

type - the Class representing the type of this parameter

name - the name of the parameter

annotations - a Collection of all Annotations this parameter is annotated with

All Implemented Interfaces:

Description

public record ParameterDescription(@NotNull Class<?> type, @NotNull String name, @NotNull Collection<Annotation> annotations)
extends Record
implements Description

A Description that describes a parameter.

Constructor Summary

Constructors

Constructor	Description
ParameterDescription(@NotNull Class<?> type, @NotNull String name, @NotNull Collection<Annotation> annotations)	Creates an instance of a ParameterDescription record class.

Method Summary

Modifier and Type	Method	Description
@NotNull Collection<Annotation>	annotations()	Returns the value of the annotations record component.
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.
@NotNull String	name()	Returns the value of the name record component.
final String	toString()	Returns a string representation of this record class.
@NotNull Class<?>	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.github.kaktushose.jda.commands.definitions.description.Description

annotation

Constructor Details

ParameterDescription

public ParameterDescription(@NotNull
 @NotNull Class<?> type,
 @NotNull
 @NotNull String name,
 @NotNull
 @NotNull Collection<Annotation> annotations)

Creates an instance of a ParameterDescription record class.

Parameters:

type - the value for the type record component

name - the value for the name record component

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

type

@NotNull
public @NotNull Class<?> type()

Returns the value of the type record component.

Returns:

the value of the type record component

name

@NotNull
public @NotNull String name()

Returns the value of the name record component.

Returns:

the value of the name record component

annotations

@NotNull
public @NotNull Collection<Annotation> annotations()

Returns the value of the annotations record component.

Specified by:

annotations in interface Description

Returns:

the value of the annotations record component