Package dev.sympho.modular_commands.utils.parse.entity

Class RoleRefMentionParser

java.lang.Object

dev.sympho.modular_commands.utils.parse.entity.EntityRefMentionParser<EntityRef.RoleRef>

dev.sympho.modular_commands.utils.parse.entity.RoleRefMentionParser

All Implemented Interfaces:

ParserFunction<String,EntityRef.RoleRef>, BiFunction<CommandContext,String,Mono<EntityRef.RoleRef>>

public class RoleRefMentionParser
extends EntityRefMentionParser<EntityRef.RoleRef>

A parser for user mentions to references.

Note that this parser does not support @everyone and @here in EntityRefMentionParser.parseId(String), as they do not have a unique ID. They are, however, supported by parseRef(CommandContext, String) and EntityRefMentionParser.parse(CommandContext, String).

Since:

1.0

Version:

1.0

Nested Class Summary

Nested classes/interfaces inherited from interface dev.sympho.modular_commands.api.command.parameter.parse.ParserFunction

ParserFunction.PostParser<R extends @NonNull Object,I extends @NonNull Object,T extends @NonNull Object,P1 extends @NonNull ParserFunction<R,I>,P2 extends @NonNull ParserFunction<I,T>>

Constructor Summary

Constructors

Constructor	Description
RoleRefMentionParser()	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected EntityRef.RoleRef	makeRef(CommandContext context, Snowflake id)	Creates the reference.
@Nullable EntityRef.RoleRef	parseRef(CommandContext context, String raw)	Parses the given string.
protected boolean	prefixMatches(String prefix)	Determines if the mention prefix matches the expected type.
protected String	typeName()	Gets the display name for this type.

Methods inherited from class dev.sympho.modular_commands.utils.parse.entity.EntityRefMentionParser

parse, parseId

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.BiFunction

andThen

Methods inherited from interface dev.sympho.modular_commands.api.command.parameter.parse.ParserFunction

apply, then

Constructor Details

RoleRefMentionParser

public RoleRefMentionParser()

Creates a new instance.

Method Details

prefixMatches

protected boolean prefixMatches(String prefix)

Description copied from class: EntityRefMentionParser

Determines if the mention prefix matches the expected type.

Specified by:

prefixMatches in class EntityRefMentionParser<EntityRef.RoleRef>

Parameters:

prefix - The detected prefix.

Returns:

true if the prefix matches the expected, false otherwise.

makeRef

protected EntityRef.RoleRef makeRef(CommandContext context,
 Snowflake id)

Description copied from class: EntityRefMentionParser

Creates the reference.

Specified by:

makeRef in class EntityRefMentionParser<EntityRef.RoleRef>

Parameters:

context - The execution context.

id - The parsed ID.

Returns:

The created reference.

typeName

protected String typeName()

Description copied from class: EntityRefMentionParser

Gets the display name for this type.

Specified by:

typeName in class EntityRefMentionParser<EntityRef.RoleRef>

Returns:

The name.

parseRef

public @Nullable EntityRef.RoleRef parseRef(CommandContext context,
 String raw)
                                     throws InvalidArgumentException

Description copied from class: EntityRefMentionParser

Parses the given string.

Overrides:

parseRef in class EntityRefMentionParser<EntityRef.RoleRef>

Parameters:

context - The execution context.

raw - The string to parse.

Returns:

The reference parsed from the mention, or null if the given string is not a mention.

Throws:

InvalidArgumentException - if the given string is a mention but of the wrong type.