Package ovh.mythmc.social.api.text

Class GlobalTextProcessor

java.lang.Object

ovh.mythmc.social.api.text.GlobalTextProcessor

public final class GlobalTextProcessor
extends Object

The global entry-point for parsing and sending messages through the social plugin.

Parsers are divided into three ordered groups:

1. EARLY_PARSERS run before the main parser list
2. The main parser list registered via registerContextualParser(ovh.mythmc.social.api.text.parser.SocialContextualParser...)
3. LATE_PARSERS run after the main parser list

Access the singleton via Social.getTextProcessor().

Field Summary

Fields

Modifier and Type	Field	Description
final SocialParserGroup	EARLY_PARSERS
static final GlobalTextProcessor	instance
final SocialParserGroup	LATE_PARSERS

Constructor Summary

Constructors

Constructor	Description
GlobalTextProcessor()

Method Summary

Modifier and Type	Method	Description
Optional<SocialContextualKeyword>	getContextualKeyword(@NotNull String identifier)	Deprecated, for removal: This API element is subject to removal in a future version. Use <T>getIdentifiedParser([email protected] Class<T>,[email protected] String) instead
SocialContextualParser	getContextualParserByClass(@NotNull Class<?> clazz)	Deprecated, for removal: This API element is subject to removal in a future version. Use <T>getIdentifiedParser([email protected] Class<T>,[email protected] String) instead
List<SocialContextualParser>	getContextualParsers()	Returns the ordered list of all contextual parsers: EARLY_PARSERS, then the main parser list, then LATE_PARSERS.
<T extends SocialContextualParser> Collection<T>	getContextualParsersByType(Class<T> type)	Returns all parsers of the given type, including those nested inside SocialParserGroup instances.
Collection<SocialContextualParser>	getContextualParsersWithGroupMembers()	Deprecated, for removal: This API element is subject to removal in a future version.
Optional<SocialContextualPlaceholder>	getContextualPlaceholder(@NotNull String identifier)	Deprecated, for removal: This API element is subject to removal in a future version.
Optional<SocialParserGroup>	getGroupByContextualParser(@NotNull Class<? extends SocialContextualParser> parserClass)	Returns the SocialParserGroup that contains the given parser class, if any.
<T extends SocialIdentifiedParser> Optional<T>	getIdentifiedParser(@NotNull Class<T> type, @NotNull String identifier)	Returns the parser of the given type whose SocialIdentifiedParser.identifier() matches the given string, if any.
boolean	isContextualKeyword(@NotNull String keyword)	Deprecated, for removal: This API element is subject to removal in a future version. Use <T>getIdentifiedParser([email protected] Class<T>,[email protected] String) instead
boolean	isContextualPlaceholder(@NotNull String identifier)	Deprecated, for removal: This API element is subject to removal in a future version. Use <T>getIdentifiedParser([email protected] Class<T>,[email protected] String) instead
Component	parse(@NotNull SocialParserContext context)	Parses context through the full parser chain and returns the resulting component.
Component	parse(SocialUser user, ChatChannel channel, String message)
Component	parse(SocialUser user, ChatChannel channel, String message, ChatChannel.ChannelType channelType)
Component	parse(SocialUser user, ChatChannel channel, Component message)
Component	parse(SocialUser user, ChatChannel channel, Component message, ChatChannel.ChannelType channelType)	Parses a message component for the given user/channel combination.
void	parseAndSend(SocialParserContext context)	Parses context and immediately sends the result to the context's user.
void	parseAndSend(SocialUser user, String message, ChatChannel.ChannelType type)
void	parseAndSend(SocialUser user, Component message, ChatChannel.ChannelType type)
void	parseAndSend(SocialUser user, ChatChannel channel, String message)
void	parseAndSend(SocialUser user, ChatChannel channel, String message, ChatChannel.ChannelType channelType)
void	parseAndSend(SocialUser user, ChatChannel channel, Component message)
void	parseAndSend(SocialUser user, ChatChannel channel, Component message, ChatChannel.ChannelType channelType)
Component	parsePlayerInput(@NotNull SocialParserContext context)	Parses context treating its message as raw player input, applying only SocialUserInputParser parsers.
void	registerContextualKeyword(@NotNull String identifier, @NotNull Function<SocialParserContext,Component> ctx)	Creates and registers a SocialContextualKeyword with the given identifier.
void	registerContextualParser(@NotNull SocialContextualParser... socialParsers)	Registers one or more contextual parsers into the main parser list.
void	registerContextualPlaceholder(@NotNull String identifier, @NotNull Function<SocialParserContext,Component> ctx)	Creates and registers a SocialContextualPlaceholder with the given identifier.
void	send(@NotNull Collection<SocialUser> members, @NotNull Component message, ChatChannel.ChannelType type, @Nullable ChatChannel channel)	Sends a pre-parsed message to the given collection of users.
void	send(@NotNull SocialUser recipient, @NotNull Component message, ChatChannel.ChannelType type, @Nullable ChatChannel channel)	Sends a pre-parsed message to a single recipient.
void	unregisterAllParsers()	Unregisters all parsers from all groups and the main parser list.
void	unregisterContextualKeyword(@NotNull String identifier)
void	unregisterContextualParser(@NotNull SocialContextualParser... socialParsers)	Removes the given parsers from the main parser list.
void	unregisterContextualPlaceholder(@NotNull String identifier)

Methods inherited from class java.lang.Object

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

Field Details

instance

public static final GlobalTextProcessor instance

EARLY_PARSERS

public final SocialParserGroup EARLY_PARSERS

LATE_PARSERS

public final SocialParserGroup LATE_PARSERS

Constructor Details

GlobalTextProcessor

public GlobalTextProcessor()

Method Details

getContextualParsers

public List<SocialContextualParser> getContextualParsers()

Returns the ordered list of all contextual parsers: EARLY_PARSERS, then the main parser list, then LATE_PARSERS.

The list is cached and only rebuilt when parsers are registered or unregistered.

Returns:

the full parser list

getContextualParsersByType

public <T extends SocialContextualParser>
Collection<T> getContextualParsersByType(Class<T> type)

Returns all parsers of the given type, including those nested inside SocialParserGroup instances.

Type Parameters:

T - the type parameter

Parameters:

type - the parser type to search for

Returns:

an unordered collection of matching parsers

getGroupByContextualParser

public Optional<SocialParserGroup> getGroupByContextualParser(@NotNull
 @NotNull Class<? extends SocialContextualParser> parserClass)

Returns the SocialParserGroup that contains the given parser class, if any.

Parameters:

parserClass - the parser class to look for

Returns:

an optional containing the group

getIdentifiedParser

public <T extends SocialIdentifiedParser>
Optional<T> getIdentifiedParser(@NotNull
 @NotNull Class<T> type,
 @NotNull
 @NotNull String identifier)

Returns the parser of the given type whose SocialIdentifiedParser.identifier() matches the given string, if any.

Type Parameters:

T - the type parameter

Parameters:

type - the parser type

identifier - the identifier to match

Returns:

an optional containing the matching parser

registerContextualParser

public void registerContextualParser(@NotNull
 @NotNull SocialContextualParser... socialParsers)

Registers one or more contextual parsers into the main parser list.

Parameters:

socialParsers - the parsers to register

registerContextualPlaceholder

public void registerContextualPlaceholder(@NotNull
 @NotNull String identifier,
 @NotNull
 @NotNull Function<SocialParserContext,Component> ctx)

Creates and registers a SocialContextualPlaceholder with the given identifier.

The placeholder replaces its matched token with the component returned by ctx.

Parameters:

identifier - the unique placeholder identifier

ctx - a function that produces the replacement component from the parse context

registerContextualKeyword

public void registerContextualKeyword(@NotNull
 @NotNull String identifier,
 @NotNull
 @NotNull Function<SocialParserContext,Component> ctx)

Creates and registers a SocialContextualKeyword with the given identifier.

The keyword processes its matched token and returns a replacement component produced by ctx.

Parameters:

identifier - the keyword string

ctx - a function that produces the replacement component from the parse context

unregisterAllParsers

@Internal
public void unregisterAllParsers()

Unregisters all parsers from all groups and the main parser list.

unregisterContextualParser

public void unregisterContextualParser(@NotNull
 @NotNull SocialContextualParser... socialParsers)

Removes the given parsers from the main parser list.

Parameters:

socialParsers - the parsers to remove

unregisterContextualPlaceholder

public void unregisterContextualPlaceholder(@NotNull
 @NotNull String identifier)

unregisterContextualKeyword

public void unregisterContextualKeyword(@NotNull
 @NotNull String identifier)

parsePlayerInput

public Component parsePlayerInput(@NotNull
 @NotNull SocialParserContext context)

Parses context treating its message as raw player input, applying only SocialUserInputParser parsers.

Parameters:

context - the parse context containing the user and raw message

Returns:

the parsed component

parse

public Component parse(@NotNull
 @NotNull SocialParserContext context)

Parses context through the full parser chain and returns the resulting component.

Parameters:

context - the parse context

Returns:

the parsed component

parse

public Component parse(SocialUser user,
 ChatChannel channel,
 Component message,
 ChatChannel.ChannelType channelType)

Parses a message component for the given user/channel combination.

Parameters:

user - the sending user

channel - the target channel

message - the message component

channelType - how the message will be delivered

Returns:

the parsed component

parse

public Component parse(SocialUser user,
 ChatChannel channel,
 String message,
 ChatChannel.ChannelType channelType)

parse

public Component parse(SocialUser user,
 ChatChannel channel,
 Component message)

parse

public Component parse(SocialUser user,
 ChatChannel channel,
 String message)

parseAndSend

public void parseAndSend(SocialParserContext context)

Parses context and immediately sends the result to the context's user.

Parameters:

context - the pre-built parse context

parseAndSend

public void parseAndSend(SocialUser user,
 ChatChannel channel,
 Component message,
 ChatChannel.ChannelType channelType)

parseAndSend

public void parseAndSend(SocialUser user,
 ChatChannel channel,
 String message,
 ChatChannel.ChannelType channelType)

parseAndSend

public void parseAndSend(SocialUser user,
 ChatChannel channel,
 Component message)

parseAndSend

public void parseAndSend(SocialUser user,
 ChatChannel channel,
 String message)

parseAndSend

public void parseAndSend(SocialUser user,
 Component message,
 ChatChannel.ChannelType type)

parseAndSend

public void parseAndSend(SocialUser user,
 String message,
 ChatChannel.ChannelType type)

send

@Internal
public void send(@NotNull
 @NotNull Collection<SocialUser> members,
 @NotNull
 @NotNull Component message,
 @NotNull
 ChatChannel.ChannelType type,
 @Nullable
 @Nullable ChatChannel channel)

Sends a pre-parsed message to the given collection of users.

Parameters:

members - the recipients

message - the pre-parsed component to send

type - how the message should be delivered

channel - the originating channel, or null for non-channel messages

send

@Internal
public void send(@NotNull
 @NotNull SocialUser recipient,
 @NotNull
 @NotNull Component message,
 @NotNull
 ChatChannel.ChannelType type,
 @Nullable
 @Nullable ChatChannel channel)

Sends a pre-parsed message to a single recipient.

Parameters:

recipient - the user to send to

message - the pre-parsed component

type - how the message should be delivered

channel - the originating channel, or null

getContextualParserByClass

@Deprecated(forRemoval=true)
public SocialContextualParser getContextualParserByClass(@NotNull
 @NotNull Class<?> clazz)

Deprecated, for removal: This API element is subject to removal in a future version.

Use <T>getIdentifiedParser([email protected] Class<T>,[email protected] String) instead

Gets a SocialContextualParsers matching a specific class.

Parameters:

clazz - the class to match

Returns:

a SocialContextualParser matching the given class, or null otherwise

getContextualParsersWithGroupMembers

@Deprecated(forRemoval=true)
public Collection<SocialContextualParser> getContextualParsersWithGroupMembers()

Deprecated, for removal: This API element is subject to removal in a future version.

getContextualPlaceholder

@Deprecated(forRemoval=true)
public Optional<SocialContextualPlaceholder> getContextualPlaceholder(@NotNull
 @NotNull String identifier)

Deprecated, for removal: This API element is subject to removal in a future version.

Gets a specific SocialContextualPlaceholder by its identifier.

Parameters:

identifier - the identifier of the SocialContextualPlaceholder

Returns:

a Optional wrapping the SocialContextualPlaceholder if available, or an empty Optional otherwise

getContextualKeyword

@Deprecated(forRemoval=true)
public Optional<SocialContextualKeyword> getContextualKeyword(@NotNull
 @NotNull String identifier)

Deprecated, for removal: This API element is subject to removal in a future version.

Use <T>getIdentifiedParser([email protected] Class<T>,[email protected] String) instead

Gets a specific SocialContextualKeyword by its identifier.

Parameters:

identifier - the identifier of the SocialContextualKeyword

Returns:

a Optional wrapping the SocialContextualKeyword if available, or an empty Optional otherwise

isContextualPlaceholder

@Deprecated(forRemoval=true)
public boolean isContextualPlaceholder(@NotNull
 @NotNull String identifier)

Deprecated, for removal: This API element is subject to removal in a future version.

Use <T>getIdentifiedParser([email protected] Class<T>,[email protected] String) instead

Determines whether the text processor has a SocialContextualPlaceholder matching the given identifier.

Parameters:

identifier - the identifier of the SocialContextualPlaceholder to check

Returns:

true if the SocialContextualPlaceholder exists, false otherwise

isContextualKeyword

@Deprecated(forRemoval=true)
public boolean isContextualKeyword(@NotNull
 @NotNull String keyword)

Deprecated, for removal: This API element is subject to removal in a future version.

Use <T>getIdentifiedParser([email protected] Class<T>,[email protected] String) instead

Determines whether the text processor has a SocialContextualKeyword matching the given identifier.

Parameters:

keyword - the identifier of the SocialContextualKeyword to check

Returns:

true if the SocialContextualKeyword exists, false otherwise