Record Class AutoCompleteDefinition

java.lang.Object

java.lang.Record

io.github.kaktushose.jdac.definitions.interactions.AutoCompleteDefinition

Record Components:

classDescription - the ClassDescription of the declaring class of the methodDescription()

methodDescription - the MethodDescription of the method this definition is bound to

rules - the rules this autocomplete handler can handle

All Implemented Interfaces:

Definition, Invokable, InteractionDefinition

public record AutoCompleteDefinition(ClassDescription classDescription, MethodDescription methodDescription, Set<AutoCompleteDefinition.AutoCompleteRule> rules)
extends Record
implements InteractionDefinition

Representation of an auto complete handler.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	AutoCompleteDefinition.AutoCompleteRule	Representation of an auto complete rule.

Nested classes/interfaces inherited from interface InteractionDefinition

InteractionDefinition.ReplyConfig

Field Summary

Fields inherited from interface Invokable

log

Constructor Summary

Constructors

Constructor	Description
AutoCompleteDefinition(ClassDescription classDescription, MethodDescription methodDescription, Set<AutoCompleteDefinition.AutoCompleteRule> rules)	Creates an instance of a AutoCompleteDefinition record class.

Method Summary

Modifier and Type	Method	Description
static AutoCompleteDefinition	build(ClassDescription clazz, MethodDescription method)	Builds a new AutoCompleteDefinition from the given class and method description.
ClassDescription	classDescription()	Returns the value of the classDescription record component.
String	displayName()	The human-readable name of this definition.
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.
MethodDescription	methodDescription()	Returns the value of the methodDescription record component.
Collection<String>	permissions()	A possibly-empty Collection of permissions for this interaction.
Set<AutoCompleteDefinition.AutoCompleteRule>	rules()	Returns the value of the rules 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

Methods inherited from interface InteractionDefinition

definitionId

Methods inherited from interface Invokable

invoke

Constructor Details

AutoCompleteDefinition

public AutoCompleteDefinition(ClassDescription classDescription,
 MethodDescription methodDescription,
 Set<AutoCompleteDefinition.AutoCompleteRule> rules)

Creates an instance of a AutoCompleteDefinition record class.

Parameters:

classDescription - the value for the classDescription record component

methodDescription - the value for the methodDescription record component

rules - the value for the rules record component

Method Details

build

public static AutoCompleteDefinition build(ClassDescription clazz,
 MethodDescription method)

Builds a new AutoCompleteDefinition from the given class and method description.

Parameters:

clazz - the corresponding ClassDescription

method - the corresponding MethodDescription

Returns:

the AutoCompleteDefinition

displayName

public String displayName()

Description copied from interface: Definition

The human-readable name of this definition.

Specified by:

displayName in interface Definition

permissions

public Collection<String> permissions()

Description copied from interface: InteractionDefinition

A possibly-empty Collection of permissions for this interaction.

Specified by:

permissions in interface InteractionDefinition

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.

classDescription

public ClassDescription classDescription()

Returns the value of the classDescription record component.

Specified by:

classDescription in interface Invokable

Returns:

the value of the classDescription record component

methodDescription

public MethodDescription methodDescription()

Returns the value of the methodDescription record component.

Specified by:

methodDescription in interface Invokable

Returns:

the value of the methodDescription record component

rules

public Set<AutoCompleteDefinition.AutoCompleteRule> rules()

Returns the value of the rules record component.

Returns:

the value of the rules record component