Record Class InteractionRegistry

java.lang.Object

java.lang.Record

io.github.kaktushose.jdac.definitions.interactions.InteractionRegistry

All Implemented Interfaces:

Definitions

public record InteractionRegistry(Validators validators, MessageResolver messageResolver, Descriptor descriptor, Set<InteractionDefinition> definitions)
extends Record
implements Definitions

Central registry for all InteractionDefinitions.

Constructor Summary

Constructors

Constructor	Description
InteractionRegistry(Validators registry, MessageResolver messageResolver, Descriptor descriptor)	Constructs a new InteractionRegistry
InteractionRegistry(Validators validators, MessageResolver messageResolver, Descriptor descriptor, Set<InteractionDefinition> definitions)	Creates an instance of a InteractionRegistry record class.

Method Summary

Modifier and Type	Method	Description
Collection<InteractionDefinition>	all()	Gets all InteractionDefinitions that were indexed by JDA-Commands.
Set<InteractionDefinition>	definitions()	Returns the value of the definitions record component.
Descriptor	descriptor()	Returns the value of the descriptor record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
<T extends Definition> T	find(Class<T> type, boolean internalError, Predicate<T> predicate)	Attempts to find a Definition of type T based on the given Predicate.
<T extends Definition> SequencedCollection<T>	find(Class<T> type, Predicate<T> predicate)	Attempts to find all Definitions of type T based on the given Predicate.
<T extends Definition> T	findFirst(Class<T> type, Predicate<T> predicate)	Gets the first InteractionDefinition with the given type that match the passed Predicate
final int	hashCode()	Returns a hash code value for this object.
void	index(Iterable<Class<?>> classes, CommandDefinition.CommandConfig globalCommandConfig)	Scans all given classes and registers the interactions defined in them.
MessageResolver	messageResolver()	Returns the value of the messageResolver record component.
final String	toString()	Returns a string representation of this record class.
Validators	validators()	Returns the value of the validators record component.

Methods inherited from class Object

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

Methods inherited from interface Definitions

find

Constructor Details

InteractionRegistry

public InteractionRegistry(Validators registry,
 MessageResolver messageResolver,
 Descriptor descriptor)

Constructs a new InteractionRegistry

Parameters:

registry - the corresponding Validators

messageResolver - the MessageResolver instance to use

descriptor - the Descriptor to use

InteractionRegistry

public InteractionRegistry(Validators validators,
 MessageResolver messageResolver,
 Descriptor descriptor,
 Set<InteractionDefinition> definitions)

Creates an instance of a InteractionRegistry record class.

Parameters:

validators - the value for the validators record component

messageResolver - the value for the messageResolver record component

descriptor - the value for the descriptor record component

definitions - the value for the definitions record component

Method Details

index

public void index(Iterable<Class<?>> classes,
 CommandDefinition.CommandConfig globalCommandConfig)

Scans all given classes and registers the interactions defined in them.

Parameters:

classes - the Classes to build the interactions from

find

public <T extends Definition> T find(Class<T> type,
 boolean internalError,
 Predicate<T> predicate)

Attempts to find a Definition of type T based on the given Predicate.

Type Parameters:

T - a subtype of Definition

Parameters:

type - the type of the Definition to find

internalError - true if the Definition must be found and not finding it indicates a framework bug

predicate - the Predicate used to find the Definition

Returns:

T the definition

Throws:

IllegalStateException - if no Definition was found, although this mandatory should have been the case. This is a rare occasion and can be considered a framework bug

IllegalArgumentException - if no Definition was found, because the Predicate didn't include any elements

findFirst

public <T extends Definition> T findFirst(Class<T> type,
 Predicate<T> predicate)

Description copied from interface: Definitions

Gets the first InteractionDefinition with the given type that match the passed Predicate

Specified by:

findFirst in interface Definitions

Parameters:

type - the type of the needed InteractionDefinition

predicate - the Predicate that has to match the needed InteractionDefinition

Returns:

the frist InteractionDefinition matching the provided criteria

find

public <T extends Definition>
SequencedCollection<T> find(Class<T> type,
 Predicate<T> predicate)

Attempts to find all Definitions of type T based on the given Predicate.

Specified by:

find in interface Definitions

Type Parameters:

T - a subtype of Definition

Parameters:

type - the type of the Definition to find

predicate - the Predicate used to find the Definitions

Returns:

a possibly-empty Collection of all Definitions that match the given Predicate

Throws:

IllegalStateException - if no Definition was found, although this mandatory should have been the case. This is a rare occasion and can be considered a framework bug

IllegalArgumentException - if no Definition was found, because the Predicate didn't include any elements

all

public Collection<InteractionDefinition> all()

Description copied from interface: Definitions

Gets all InteractionDefinitions that were indexed by JDA-Commands.

Specified by:

all in interface Definitions

Returns:

an immutable collection of all indexes InteractionDefinitions

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.

validators

public Validators validators()

Returns the value of the validators record component.

Returns:

the value of the validators record component

messageResolver

public MessageResolver messageResolver()

Returns the value of the messageResolver record component.

Returns:

the value of the messageResolver record component

descriptor

public Descriptor descriptor()

Returns the value of the descriptor record component.

Returns:

the value of the descriptor record component

definitions

public Set<InteractionDefinition> definitions()

Returns the value of the definitions record component.

Returns:

the value of the definitions record component