Package dev.sympho.bot_utils.event

Class AbstractChannelEventContext<E extends @NonNull Event>

java.lang.Object

dev.sympho.bot_utils.event.AbstractChannelEventContext<E>

Type Parameters:

E - The event type.

All Implemented Interfaces:

AccessContext, AccessValidator, ChannelAccessContext, ChannelAccessValidator, ChannelEventContext, EventContext

Direct Known Subclasses:

AbstractRepliableContext

public abstract class AbstractChannelEventContext<E extends @NonNull Event>
extends Object
implements ChannelEventContext

Convenience base for implementing a channel-bound event context.

Most leaf interfaces here should be able to be implemented on top of this class without any further overrides as they already have default methods pulling all necessary data from the event.

Since:

1.0

Version:

1.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractChannelEventContext(E event, AccessManager accessManager)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
E	event()	Retrieves the triggering event.
ChannelAccessValidator	validator()	The access validator used in this context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface dev.sympho.bot_utils.access.AccessContext

asGuild, guild, guildId, isPrivate, member, member, user

Methods inherited from interface dev.sympho.bot_utils.access.ChannelAccessContext

asUser, channel, channelId

Methods inherited from interface dev.sympho.bot_utils.event.ChannelEventContext

belongs, belongs, belongs, belongs, hasAccess, hasAccess, validate

Methods inherited from interface dev.sympho.bot_utils.event.EventContext

client, validate

Constructor Details

AbstractChannelEventContext

protected AbstractChannelEventContext(E event,
 AccessManager accessManager)

Creates a new instance.

Parameters:

event - The triggering event.

accessManager - The access manager to use.

Method Details

event

public E event()

Description copied from interface: EventContext

Retrieves the triggering event.

Specified by:

event in interface EventContext

Returns:

The event.

validator

public ChannelAccessValidator validator()

Description copied from interface: EventContext

The access validator used in this context.

Specified by:

validator in interface ChannelEventContext

Specified by:

validator in interface EventContext

Returns:

The validator.