Package dev.sympho.modular_commands.utils.parse

Class RoleParser

java.lang.Object

dev.sympho.modular_commands.utils.parse.EntityParser<E>

dev.sympho.modular_commands.utils.parse.MentionableParser<Role>

dev.sympho.modular_commands.utils.parse.RoleParser

All Implemented Interfaces:

ParserFunction<String,Role>, BiFunction<CommandContext,String,Mono<Role>>

public class RoleParser
extends MentionableParser<Role>

A parser that extracts a role from a 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
RoleParser()	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected Mono<Role>	getEntity(CommandContext context, Snowflake id)	Retrieves the entity with the given ID.
Mono<Role>	parse(CommandContext context, String raw)	Parses the given raw argument from the user into the corresponding value.
String	parseMention(String mention)	Parses the entity ID from a text mention.

Methods inherited from class dev.sympho.modular_commands.utils.parse.MentionableParser

extractId, parseMention

Methods inherited from class dev.sympho.modular_commands.utils.parse.EntityParser

getUrlParser, 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

RoleParser

public RoleParser()

Creates a new instance.

Method Details

getEntity

protected Mono<Role> getEntity(CommandContext context,
 Snowflake id)

Description copied from class: EntityParser

Retrieves the entity with the given ID.

Specified by:

getEntity in class EntityParser<Role>

Parameters:

context - The execution context.

id - The entity ID.

Returns:

The entity. May be empty if not found.

parseMention

public String parseMention(String mention)
                    throws InvalidArgumentException

Description copied from class: MentionableParser

Parses the entity ID from a text mention.

Specified by:

parseMention in class MentionableParser<Role>

Parameters:

mention - The text mention.

Returns:

The ID in the mention.

Throws:

InvalidArgumentException - if the mention was invalid.

parse

public Mono<Role> parse(CommandContext context,
 String raw)
                 throws InvalidArgumentException

Description copied from interface: ParserFunction

Parses the given raw argument from the user into the corresponding value.

Specified by:

parse in interface ParserFunction<String,Role>

Overrides:

parse in class EntityParser<Role>

Parameters:

context - The execution context.

raw - The raw argument received from the user.

Returns:

A Mono that issues the parsed argument. If the raw value is invalid, it may fail with a InvalidArgumentException. May be empty, in which case the value defers to the default (functionally the same as if the argument was missing, but without causing an error if the parameter is required).

Throws:

InvalidArgumentException - if the given argument is not a valid value.