Package ovh.mythmc.social.api.text.group

Class SocialParserGroup

java.lang.Object

ovh.mythmc.social.api.text.group.SocialParserGroup

All Implemented Interfaces:

SocialContextualParser, SocialUserInputParser

@Experimental
public class SocialParserGroup
extends Object
implements SocialUserInputParser

Represents a group of parsers which should be processed in a single batch.

Constructor Summary

Constructors

Constructor	Description
SocialParserGroup()

Method Summary

Modifier and Type	Method	Description
void	add(@NotNull SocialContextualParser... parsers)	Adds one or various SocialContextualParsers to this group.
List<SocialContextualParser>	get()	Gets the unmodifiable List of SocialContextualParsers.
<T extends SocialContextualParser> List<T>	getByType(@NotNull Class<T> type)	Gets every parser matching a specific type in the group.
Component	parse(SocialParserContext context)	Parses the given SocialParserContext and returns a Component representation.
void	remove(@NotNull SocialContextualParser... parsers)	Removes one or various SocialContextualParsers from this group.
void	removeAll()	Removes all SocialContextualParsers in this group.
Component	requestToGroup(@NotNull SocialContextualParser requester, @NotNull SocialParserContext context)	Requests a specific SocialParserContext to this group and processes it.
boolean	supportsOfflinePlayers()	Checks if this parser supports offline players.

Methods inherited from class java.lang.Object

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

Constructor Details

SocialParserGroup

public SocialParserGroup()

Method Details

get

public List<SocialContextualParser> get()

Gets the unmodifiable List of SocialContextualParsers.

Returns:

a List with every SocialContextualParser in this group

add

public void add(@NotNull
 @NotNull SocialContextualParser... parsers)

Adds one or various SocialContextualParsers to this group.

Parameters:

parsers - the parser or parsers to add

remove

public void remove(@NotNull
 @NotNull SocialContextualParser... parsers)

Removes one or various SocialContextualParsers from this group.

Parameters:

parsers - the parser or parsers to remove

removeAll

public void removeAll()

Removes all SocialContextualParsers in this group.

supportsOfflinePlayers

public boolean supportsOfflinePlayers()

Description copied from interface: SocialContextualParser

Checks if this parser supports offline players. The default implementation returns false, but can be overridden by implementations that need to handle offline players.

Specified by:

supportsOfflinePlayers in interface SocialContextualParser

Returns:

true if the parser supports offline players, otherwise false.

requestToGroup

@Experimental
public Component requestToGroup(@NotNull
 @NotNull SocialContextualParser requester,
 @NotNull
 @NotNull SocialParserContext context)

Requests a specific SocialParserContext to this group and processes it.

This method is designed to be called from a SocialContextualParser inside the group without causing any recursion issues in runtime.

Parameters:

requester - the SocialContextualParser doing the request

context - the SocialParserContext to parse

Returns:

the resulting Component from the request

getByType

public <T extends SocialContextualParser> List<T> getByType(@NotNull
 @NotNull Class<T> type)

Gets every parser matching a specific type in the group.

For example, getByType(SocialContextualPlaceholder.class) would return every SocialContextualPlaceholder in this group.

Type Parameters:

T - the type of SocialContextualParser to get

Parameters:

type - the type of SocialContextualParser to get

Returns:

an unmodifiable List with every parser of this type

parse

public Component parse(SocialParserContext context)

Description copied from interface: SocialContextualParser

Parses the given SocialParserContext and returns a Component representation.

Specified by:

parse in interface SocialContextualParser

Parameters:

context - the context in which the message is being parsed. It contains information such as the sender, the original message, and other contextual information.

Returns:

a Component representing the parsed message.