Interface StringMessageContext

All Superinterfaces:

MessageContext

All Known Subinterfaces:

BallMessageContext, ChatMessageContext, ClearMessageContext, DiscordMessageContext, MailMessageContext, PollMessageContext, QuestionAnswerMessageContext, SpyMessageContext, TelegramMessageContext, TellMessageContext, TranslatetoMessageContext, TryMessageContext, TwitchMessageContext

public interface StringMessageContext
extends MessageContext

A message context that also carries an extra string, such as the original player input.

Nested Class Summary

Nested classes/interfaces inherited from interface MessageContext

MessageContext.CacheKey

Method Summary

Modifier and Type	Method	Description
static net.flectone.pulse.model.event.message.context.StringMessageContextImpl.StringMessageContextImplBuilder	builder()	Starts building this context.
@NonNull String	string()	The extra value carried alongside the message.
StringMessageContext	withString(@NonNull String string)	Returns a copy carrying a different value.

Methods inherited from interface MessageContext

addFlag, addFlags, addTagResolver, addTagResolvers, base, createCacheKey, flags, isFlag, message, receiver, sender, tagResolver, toBuilder, uuid, withBase, withFlags, withMessage, withReceiver, withSender, withTagResolver, withUuid

Method Details

builder

static net.flectone.pulse.model.event.message.context.StringMessageContextImpl.StringMessageContextImplBuilder builder()

Starts building this context.

Returns:

a new builder

string

@NonNull String string()

The extra value carried alongside the message.

Returns:

the string

withString

StringMessageContext withString(@NonNull String string)

Returns a copy carrying a different value.

Parameters:

string - the new value

Returns:

the copy